sRandomNumberGenerator Class Reference

Singleton class that generate a thread-safe random generator number for openMP
As singleton, it can be called from any class requiring RNGs. More...

#include <sRandomNumberGenerator.hh>

Collaboration diagram for sRandomNumberGenerator:

Public Types
typedef mt19937	Engine
typedef uniform_real_distribution < double >	Distribution

Public Member Functions
int	Initialize (int a_nbThreads)
	Instanciate a number of RNG according to the number of threads used in openMP. More...
int	Initialize (int64_t a_seed, int a_nbThreads)
double	GenerateRdmNber ()
	Generate a random number for the thread whose index is recovered from the ompenMP function. More...
double	GenerateNonThreadedRdmNber ()
	Generate a random number using the not thread safe random generator, for use in sequential parts of an otherwise multithreaded code. More...
Engine *	GetNonThreadedGenerator ()
	Get the not thread safe random generator, for use in sequential parts of an otherwise multithreaded code. More...
void	SetVerbose (int a_verboseLevel)
	Set verbosity level. More...

Static Public Member Functions
static sRandomNumberGenerator *	GetInstance ()
	Instanciate the singleton object and Initialize member variables if not already done, return a pointer to this object otherwise. More...

Private Member Functions
	sRandomNumberGenerator ()
	Constructor of sRandomNumberGenerator. Do nothing by default as it is a singleton clasee. More...
	~sRandomNumberGenerator ()
	Destructor of sRandomNumberGenerator. Do nothing by default. More...
	sRandomNumberGenerator (sRandomNumberGenerator const &)
void	operator= (sRandomNumberGenerator const &)

Private Attributes
int	m_verbose
vector< Engine >	mp_Engines
Engine *	mp_NonThreadedEngine
Distribution	mp_Distribution

Static Private Attributes
static sRandomNumberGenerator *	mp_Instance = NULL

Detailed Description

Singleton class that generate a thread-safe random generator number for openMP
As singleton, it can be called from any class requiring RNGs.

Definition at line 23 of file sRandomNumberGenerator.hh.

Member Typedef Documentation

typedef uniform_real_distribution<double> sRandomNumberGenerator::Distribution

Distribution which produces random floating-point values i, uniformly distributed on the interval [a, b)

Definition at line 45 of file sRandomNumberGenerator.hh.

typedef mt19937 sRandomNumberGenerator::Engine

Engine using C++11 Mersenne Twister pseudo-random generator of 32-bit numbers

Definition at line 44 of file sRandomNumberGenerator.hh.

Constructor & Destructor Documentation

sRandomNumberGenerator::sRandomNumberGenerator ( )

private

Constructor of sRandomNumberGenerator. Do nothing by default as it is a singleton clasee.

Definition at line 93 of file sRandomNumberGenerator.hh.

Here is the caller graph for this function:

sRandomNumberGenerator::~sRandomNumberGenerator ( )

private

Destructor of sRandomNumberGenerator. Do nothing by default.

Definition at line 49 of file sRandomNumberGenerator.cc.

sRandomNumberGenerator::sRandomNumberGenerator ( sRandomNumberGenerator const &  )

private

Member Function Documentation

double sRandomNumberGenerator::GenerateNonThreadedRdmNber

(

)

Generate a random number using the not thread safe random generator, for use in sequential parts of an otherwise multithreaded code.

Returns

double random number

Definition at line 159 of file sRandomNumberGenerator.cc.

double sRandomNumberGenerator::GenerateRdmNber

(

)

Generate a random number for the thread whose index is recovered from the ompenMP function.

Returns

a random generated number in [0. ; 1.)

Definition at line 134 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

static sRandomNumberGenerator * sRandomNumberGenerator::GetInstance ( )

inlinestatic

Instanciate the singleton object and Initialize member variables if not already done, return a pointer to this object otherwise.

Returns

instance of the sRandomNumberGenerator singleton

Definition at line 34 of file sRandomNumberGenerator.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

sRandomNumberGenerator::Engine * sRandomNumberGenerator::GetNonThreadedGenerator

(

)

Get the not thread safe random generator, for use in sequential parts of an otherwise multithreaded code.

Returns

double random number

Definition at line 180 of file sRandomNumberGenerator.cc.

int sRandomNumberGenerator::Initialize

(

int

a_nbThreads

)

Instanciate a number of RNG according to the number of threads used in openMP.

Parameters

a_nbThreads

It uses a std::random_device as initial seed for each thread

Returns

0 if success, positive value otherwise

Definition at line 67 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

int sRandomNumberGenerator::Initialize	(	int64_t	a_seed,
		int	a_nbThreads
	)

Definition at line 98 of file sRandomNumberGenerator.cc.

void sRandomNumberGenerator::operator= ( sRandomNumberGenerator const &  )

private

void sRandomNumberGenerator::SetVerbose ( int  a_verboseLevel )

inline

Set verbosity level.

Parameters

a_verboseLevel

Definition at line 93 of file sRandomNumberGenerator.hh.

Here is the caller graph for this function:

Member Data Documentation

int sRandomNumberGenerator::m_verbose

private

Verbosity Level

Definition at line 118 of file sRandomNumberGenerator.hh.

Distribution sRandomNumberGenerator::mp_Distribution

private

Uniform distribution

Definition at line 122 of file sRandomNumberGenerator.hh.

vector<Engine> sRandomNumberGenerator::mp_Engines

private

Multithreaded of mt199937 Engines (1 by thread)

Definition at line 119 of file sRandomNumberGenerator.hh.

sRandomNumberGenerator * sRandomNumberGenerator::mp_Instance = NULL

staticprivate

Unique instance of the singleton class

Definition at line 117 of file sRandomNumberGenerator.hh.

Engine* sRandomNumberGenerator::mp_NonThreadedEngine

private

Single random generator, not thread safe, for use in sequential parts of multithreaded code, independently of multithreaded generators

Definition at line 120 of file sRandomNumberGenerator.hh.

---

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

• sRandomNumberGenerator.hh
• sRandomNumberGenerator.cc