HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_BRJ< DIM > Class Template Reference

#include <UT_BRJ.h>

Classes

class  noiseVector
 

Public Types

using uvec = noiseVector< uint >
 
using fvec = noiseVector< float >
 

Public Member Functions

 UT_BRJ ()=default
 
 UT_BRJ (uint seed, uint count=0)
 Initialize using a seed and an optional count. More...
 
void setSeed (uint seed, uint count=0)
 Set the seed (and possibly the sequence number) More...
 
SYS_FORCE_INLINE void reset (uint count=0)
 Reset the sequence of numbers (possibly with an offset) More...
 
SYS_FORCE_INLINE fvec fx ()
 Get the float value and advance the state. More...
 
SYS_FORCE_INLINE fvec operator() ()
 Convenience operator to get the float value and advance the state. More...
 

Static Public Member Functions

static uvec ux (uint seed, uint index)
 Stateless computation of the random number. More...
 

Detailed Description

template<size_t DIM>
class UT_BRJ< DIM >

UT_BRJ - Binary Random Jittered Sampling

Generate a sequence of well distributed random numbers

The generator only supports 1-3 dimensional random numbers.

Definition at line 25 of file UT_BRJ.h.

Member Typedef Documentation

template<size_t DIM>
using UT_BRJ< DIM >::fvec = noiseVector<float>

Definition at line 49 of file UT_BRJ.h.

template<size_t DIM>
using UT_BRJ< DIM >::uvec = noiseVector<uint>

Definition at line 48 of file UT_BRJ.h.

Constructor & Destructor Documentation

template<size_t DIM>
UT_BRJ< DIM >::UT_BRJ ( )
default

Default constructor doesn't initialize any data - you need to call setSeed() before using.

template<size_t DIM>
UT_BRJ< DIM >::UT_BRJ ( uint  seed,
uint  count = 0 
)
inline

Initialize using a seed and an optional count.

Definition at line 56 of file UT_BRJ.h.

Member Function Documentation

template<size_t DIM>
SYS_FORCE_INLINE fvec UT_BRJ< DIM >::fx ( )
inline

Get the float value and advance the state.

Definition at line 68 of file UT_BRJ.h.

template<size_t DIM>
SYS_FORCE_INLINE fvec UT_BRJ< DIM >::operator() ( void  )
inline

Convenience operator to get the float value and advance the state.

Definition at line 70 of file UT_BRJ.h.

template<size_t DIM>
SYS_FORCE_INLINE void UT_BRJ< DIM >::reset ( uint  count = 0)
inline

Reset the sequence of numbers (possibly with an offset)

Definition at line 65 of file UT_BRJ.h.

template<size_t DIM>
void UT_BRJ< DIM >::setSeed ( uint  seed,
uint  count = 0 
)

Set the seed (and possibly the sequence number)

template<size_t DIM>
static uvec UT_BRJ< DIM >::ux ( uint  seed,
uint  index 
)
static

Stateless computation of the random number.


The documentation for this class was generated from the following file: