#include "gpu.h"
#include "permute.h"
#include "reverse.h"
#include "rotate.h"
#include <cassert>
#include <cstdint>

This graph shows which files directly or indirectly include this file:

Functions
std::uint16_t	oqmc::szReversedBasis (std::uint16_t index, int dimension)
	Compute SZ sequence value in the reversed basis.

std::uint16_t	oqmc::szToReversed (std::uint16_t index, int dimension)
	Compute SZ sequence value from a natural order index.

constexpr std::uint32_t	oqmc::scrambleAndReverse (std::uint32_t value, std::uint32_t seed)
	Permute an input integer and reverse the bits.

template<int Depth>
void	oqmc::shuffledScrambledSobol (std::uint32_t index, std::uint32_t seed, std::uint32_t sample[Depth])
	Compute a randomised SZ sequence value.

Detailed Description

An efficient implementation of Owen scrambled SZ sequences. This can be used to construct higher level sampler types. The method uses Brent Burley's hash based 'Practical Hash-based Owen Scrambling' construction with added optimisations.

Function Documentation

◆ szReversedBasis()

std::uint16_t oqmc::szReversedBasis	(	std::uint16_t	index,
		int	dimension
	)

inline

Given a 16 bit index, where the order of bits in the index have been reversed, compute an SZ sequence value to 16 bits of precision for a given dimension, with the order of its bits also reversed. Prefer this variant on the GPU, where left shifts are more efficient than right shifts. Dimensions must be within the range [0, 4).

Parameters

[in]	index	Bit reversed index of element.
[in]	dimension	Dimension of sequence.

Returns: Bit reversed SZ sequence value.

Here is the caller graph for this function:

◆ szToReversed()

std::uint16_t oqmc::szToReversed	(	std::uint16_t	index,
		int	dimension
	)

inline

As oqmc::szReversedBasis, but taking the index in its natural bit order, so a draw can reverse the shared index once instead of once per dimension (Chris Kulla, PR #97).

Parameters

[in]	index	Index of element.
[in]	dimension	Dimension of sequence.

Returns: Bit reversed SZ sequence value.

Here is the caller graph for this function:

◆ scrambleAndReverse()

constexpr std::uint32_t oqmc::scrambleAndReverse	(	std::uint32_t	value,
		std::uint32_t	seed
	)

constexpr

Given an input integer value, perform a Laine and Karras style permutation and reverse the resulting bits. The permutation can be randomised with a given seed value. This will be equivalent to an Owen scramble when the input bits of the integer are already reversed.

Parameters

[in]	value	Input integer value.
[in]	seed	Seed to change the permutation.

Returns: Permuted, reversed value.

Here is the caller graph for this function:

◆ shuffledScrambledSobol()

template<int Depth>

void oqmc::shuffledScrambledSobol	(	std::uint32_t	index,
		std::uint32_t	seed,
		std::uint32_t	sample[Depth]
	)

inline

Given an index and a seed, compute an Owen scrambled SZ sequence value. The index will be shuffled in a manner that is progressive friendly. The value can be multi-dimensional. For a given sequence, the seed value must be constant. An index greater than 2^16 will repeat values.

Template Parameters

Depth Dimensional space of output, up to 4 dimensions.

Parameters

[in]	index	Input index of sequence value.
[in]	seed	Seed to randomise the sequence.
[out]	sample	Randomised sequence value.

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ szReversedBasis()

◆ szToReversed()

◆ scrambleAndReverse()

◆ shuffledScrambledSobol()