Random< T > Class Template Reference

#include <Random.h>

Public Member Functions
	Random ()
	Random (unsigned int seed)
T	generateUniform (T lower=-1.0)
std::vector< T >	generateUniform (int num, T lower=-1.0)
T	generateNormal (T stdev, T mean=0.0)
std::vector< T >	generateNormal (int num, T stdev, T mean=0.0)

Detailed Description

template<typename T>
class Random< T >

Class for generating random numbers.

Note that no function returns. All values are stored inside a variable which is passed by reference to the function.

Constructor & Destructor Documentation

Random() [1/2]

template<typename T >

Random< T >::Random

Initialize RNG. This constructor generates a random seed for the random draws.

Random() [2/2]

template<typename T >

Random< T >::Random

(

unsigned int

seed

)

Initialize RNG. This constructor takes a pre-set seed for the random draws.

Parameters

seed	Positive integer determining the RNG seed.

Member Function Documentation

generateNormal() [1/2]

template<typename T >

std::vector< T > Random< T >::generateNormal	(	int	num,
		T	stdev,
		T	mean = 0.0
	)

Generate multiple random samples from normal distribution.

Parameters

num	Number of samples to return
stdev	Standard deviation of normal distribution.
mean	Mean of normal distribution. Defauts to zero.

Returns

out Vector containing num normal samples.

generateNormal() [2/2]

template<typename T >

T Random< T >::generateNormal	(	T	stdev,
		T	mean = 0.0
	)

Generate single sample from normal distribution.

Parameters

stdev	Standard deviation of normal distribution.
mean	Mean of normal distribution. Defauts to zero.

Returns

out Draw of type T.

generateUniform() [1/2]

template<typename T >

std::vector< T > Random< T >::generateUniform	(	int	num,
		T	lower = -1.0
	)

Generate multiple random samples.

Parameters

num	Number of samples to return
lower	Lower value of range. Defaults to -1.0.

Returns

out Vector containing num uniform samples between lower and 1.0.

generateUniform() [2/2]

template<typename T >

T Random< T >::generateUniform

(

T

lower = -1.0

)

Generate a random sample.

Parameters

lower

Lower value of range. Defaults to -1.0.

Returns

out Number between lower and 1.0..

---

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

• src/include/Random.h