esys::lsm::UniformRng< TmplRng > Class Template Reference

#include <Rng.h>

Public Types
typedef TmplRng	Rng
typedef boost::uniform_real	UniformReal
typedef boost::variate_generator< Rng &, UniformReal >	Generator

Public Member Functions
	UniformRng (double minRn, double maxRn)
double	operator() ()
void	seed ()
template<typename Tmpl >
void	seed (Tmpl &s)
template<typename TmplIt >
void	seed (TmplIt begin, TmplIt end)

Private Attributes
Rng	m_rng
UniformReal	m_uniform
Generator	m_generator

Detailed Description

template<typename TmplRng = boost::mt19937>
class esys::lsm::UniformRng< TmplRng >

Uniform distribution random number generator.

Member Typedef Documentation

Generator

template<typename TmplRng = boost::mt19937>

typedef boost::variate_generator<Rng &, UniformReal> esys::lsm::UniformRng< TmplRng >::Generator

Rng

template<typename TmplRng = boost::mt19937>

typedef TmplRng esys::lsm::UniformRng< TmplRng >::Rng

UniformReal

template<typename TmplRng = boost::mt19937>

typedef boost::uniform_real esys::lsm::UniformRng< TmplRng >::UniformReal

Constructor & Destructor Documentation

UniformRng()

template<typename TmplRng >

esys::lsm::UniformRng< TmplRng >::UniformRng	(	double	minRn,
		double	maxRn
	)

Construct RNG, note that (minRn < maxRn), ie strictly less than.

Parameters

minRn	minimum value in uniform dist range.
maxRn	maximum value in uniform dist range.

Member Function Documentation

operator()()

template<typename TmplRng >

double esys::lsm::UniformRng< TmplRng >::operator()

Generates a random number in this generators range.

seed() [1/3]

template<typename TmplRng >

void esys::lsm::UniformRng< TmplRng >::seed

Seeds the RNG with default seed.

Referenced by esys::lsm::seedDefaultRng().

Here is the caller graph for this function:

seed() [2/3]

template<typename TmplRng >

template<typename Tmpl >

void esys::lsm::UniformRng< TmplRng >::seed

(

Tmpl &

s

)

Seeds the RNG with specifed seed.

Parameters

s	Unsigned int.

seed() [3/3]

template<typename TmplRng >

template<typename TmplIt >

void esys::lsm::UniformRng< TmplRng >::seed	(	TmplIt	begin,
		TmplIt	end
	)

Seeds the RNG with specifed sequence of values.

Parameters

begin	*begin is the first seed-value in sequence.
end	Signifies termination of sequence.

Member Data Documentation

m_generator

template<typename TmplRng = boost::mt19937>

Generator esys::lsm::UniformRng< TmplRng >::m_generator

private

m_rng

template<typename TmplRng = boost::mt19937>

Rng esys::lsm::UniformRng< TmplRng >::m_rng

private

m_uniform

template<typename TmplRng = boost::mt19937>

UniformReal esys::lsm::UniformRng< TmplRng >::m_uniform

private

---

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

• Foundation/Rng.h
• Foundation/Rng.hpp