Random number generator. More...

Inherited by G3D::PrecomputedRandom.

Public Member Functions
	Random (uint32 seed=0xF018A4D2, bool threadsafe=true)

virtual	~Random ()

virtual uint32	bits ()
	Each bit is random. More...

virtual void	cosHemi (float &x, float &y, float &z)
	Returns 3D unit vectors distributed according to a cosine distribution about the positive z-axis. More...

virtual void	cosPowHemi (const float k, float &x, float &y, float &z)
	Returns 3D unit vectors distributed according to a cosine power distribution ( $\cos^k \theta$ ) about the z-axis. More...

virtual void	cosSphere (float &x, float &y, float &z)
	Returns 3D unit vectors distributed according to a cosine distribution about the z-axis. More...

virtual float	gaussian (float mean, float variance)
	Normally distributed reals. More...

virtual void	hemi (float &x, float &y, float &z)
	Returns 3D unit vectors uniformly distributed on the hemisphere about the z-axis. More...

virtual int	integer (int min, int max)
	Uniform random integer on the range [min, max]. More...

virtual void	reset (uint32 seed=0xF018A4D2, bool threadsafe=true)

virtual void	sphere (float &x, float &y, float &z)
	Returns 3D unit vectors uniformly distributed on the sphere. More...

virtual float	uniform (float low, float high)
	Uniform random float on the range [min, max]. More...

virtual float	uniform ()
	Uniform random float on the range [0, 1]. More...

Static Public Member Functions
static Random &	common ()
	A shared instance for when the performance and features but not consistency of the class are desired. More...

static Random &	threadCommon ()
	Returns a non-threadsafe Random instance initialized with a thread-ID based seed for the current thread. More...

Protected Types
enum	{ N = 624, M = 397, R = 31, U = 11, S = 7, T = 15, L = 18, A = 0x9908B0DF, B = 0x9D2C5680, C = 0xEFC60000 }
	Constants (important for the algorithm; do not modify) More...

Protected Member Functions
	Random (void *)
	For subclasses. More...

virtual void	generate ()
	Generate the next N ints, and store them for readback later. More...

Protected Attributes
int	index
	Index into state. More...

Spinlock	lock
	Prevents multiple overlapping calls to generate(). More...

bool	m_threadsafe

uint32 *	state
	State vector (these are the next N values that will be returned) More...

Friends
class	Array< Random, 10 >

Detailed Description

Random number generator.

Threadsafe.

Useful for generating consistent random numbers across platforms and when multiple threads are involved.

Uses the Fast Mersenne Twister (FMT-19937) algorithm.

On average, uniform() runs about 2x-3x faster than rand().

Referenced Code: http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/index.html

On OS X, Random is about 10x faster than drand48() (which is threadsafe) and 4x faster than rand() (which is not threadsafe).

See also: Noise

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Constants (important for the algorithm; do not modify)

Enumerator
N
M
R
U
S
T
L
A
B
C

Constructor & Destructor Documentation

◆ Random() [1/2]

G3D::Random::Random ( void * )

protected

For subclasses.

The void* parameter is just to distinguish this from the public constructor.

◆ Random() [2/2]

G3D::Random::Random	(	uint32	seed = `0xF018A4D2`,
		bool	threadsafe = `true`
	)

Parameters

threadsafe Set to false if you know that this random will only be used on a single thread. This eliminates the lock and improves performance on some platforms.

◆ ~Random()

virtual G3D::Random::~Random ( )

virtual

Member Function Documentation

◆ bits()

virtual uint32 G3D::Random::bits ( )

virtual

Each bit is random.

Subclasses can choose to override just this method and the other methods will all work automatically.

Reimplemented in G3D::PrecomputedRandom.

◆ common()

static Random& G3D::Random::common ( )

static

A shared instance for when the performance and features but not consistency of the class are desired.

It is slightly (10%) faster to use a distinct instance than to use the common one.

Threadsafe.

Referenced by G3D::Array< G3D::AABox >::randomElement(), and G3D::Array< G3D::AABox >::randomize().

◆ cosHemi()

virtual void G3D::Random::cosHemi	(	float &	x,
		float &	y,
		float &	z
	)

virtual

Returns 3D unit vectors distributed according to a cosine distribution about the positive z-axis.

Reimplemented in G3D::PrecomputedRandom.

◆ cosPowHemi()

virtual void G3D::Random::cosPowHemi	(	const float	k,
		float &	x,
		float &	y,
		float &	z
	)

virtual

Returns 3D unit vectors distributed according to a cosine power distribution ( $\cos^k \theta$ ) about the z-axis.

Reimplemented in G3D::PrecomputedRandom.

◆ cosSphere()

virtual void G3D::Random::cosSphere	(	float &	x,
		float &	y,
		float &	z
	)

virtual

Returns 3D unit vectors distributed according to a cosine distribution about the z-axis.

◆ gaussian()

virtual float G3D::Random::gaussian	(	float	mean,
		float	variance
	)

virtual

Normally distributed reals.

◆ generate()

virtual void G3D::Random::generate ( )

protectedvirtual

Generate the next N ints, and store them for readback later.

Called from bits()

◆ hemi()

virtual void G3D::Random::hemi	(	float &	x,
		float &	y,
		float &	z
	)

virtual

Returns 3D unit vectors uniformly distributed on the hemisphere about the z-axis.

◆ integer()

virtual int G3D::Random::integer	(	int	min,
		int	max
	)

virtual

Uniform random integer on the range [min, max].

Referenced by G3D::Array< G3D::AABox >::randomElement(), and G3D::Array< G3D::AABox >::randomize().

◆ reset()

virtual void G3D::Random::reset	(	uint32	seed = `0xF018A4D2`,
		bool	threadsafe = `true`
	)

virtual

Reimplemented in G3D::PrecomputedRandom.

◆ sphere()

virtual void G3D::Random::sphere	(	float &	x,
		float &	y,
		float &	z
	)

virtual

Returns 3D unit vectors uniformly distributed on the sphere.

Reimplemented in G3D::PrecomputedRandom.

◆ threadCommon()

static Random& G3D::Random::threadCommon ( )

static

Returns a non-threadsafe Random instance initialized with a thread-ID based seed for the current thread.

This will always return the same instance for the same thread. Calling this repeatedly with too many threads will consume resources.

Useful for efficiently and safely producing random numbers with Thread::runConcurrently.

◆ uniform() [1/2]

virtual float G3D::Random::uniform	(	float	low,
		float	high
	)

inlinevirtual

Uniform random float on the range [min, max].

Reimplemented in G3D::PrecomputedRandom.

◆ uniform() [2/2]

virtual float G3D::Random::uniform ( )

inlinevirtual

Uniform random float on the range [0, 1].

Reimplemented in G3D::PrecomputedRandom.

Friends And Related Function Documentation

◆ Array< Random, 10 >

friend class Array< Random, 10 >

friend

Member Data Documentation

◆ index

int G3D::Random::index

protected

Index into state.

◆ lock

Spinlock G3D::Random::lock

protected

Prevents multiple overlapping calls to generate().

◆ m_threadsafe

bool G3D::Random::m_threadsafe

protected

◆ state

uint32* G3D::Random::state

protected

State vector (these are the next N values that will be returned)

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Random() [1/2]

◆ Random() [2/2]

◆ ~Random()

Member Function Documentation

◆ bits()

◆ common()

◆ cosHemi()

◆ cosPowHemi()

◆ cosSphere()

◆ gaussian()

◆ generate()

◆ hemi()

◆ integer()

◆ reset()

◆ sphere()

◆ threadCommon()

◆ uniform() [1/2]

◆ uniform() [2/2]

Friends And Related Function Documentation

◆ Array< Random, 10 >

Member Data Documentation

◆ index

◆ lock

◆ m_threadsafe

◆ state