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< HPFLTNB >	Distribution

Public Member Functions
int	Initialize (int a_nbThreads, int a_nbExtra)
	Instantiate pseudo random number generators, one per thread by default, and additional extra ones if requested. More...

int	Initialize (int64_t a_seed, int a_nbThreads, int a_nbExtra)
	Instantiate pseudo random number generators, one per thread by default, and additional extra ones if requested, starting from the user-provided seed. More...

HPFLTNB	GenerateRdmNber ()
	Generate a random number for the thread which index is recovered from the OpenMP function. More...

HPFLTNB	GenerateExtraRdmNber (int a_nb=0)
	Generate a random number using the specified additional not thread safe random generator, for use in sequential parts of an otherwise multithreaded code. More...

Engine &	GetExtraGenerator (int a_nb=0)
	Get the not thread safe additional random generator, for use various 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

vector< Engine >	mp_extraEngines

Distribution	mp_Distribution

int64_t	m_seed

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 41 of file sRandomNumberGenerator.hh.

Member Typedef Documentation

◆ Distribution

typedef uniform_real_distribution<HPFLTNB> sRandomNumberGenerator::Distribution

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

Definition at line 63 of file sRandomNumberGenerator.hh.

◆ Engine

typedef mt19937 sRandomNumberGenerator::Engine

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

Definition at line 62 of file sRandomNumberGenerator.hh.

Constructor & Destructor Documentation

◆ sRandomNumberGenerator() [1/2]

sRandomNumberGenerator::sRandomNumberGenerator ( )

private

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

Definition at line 119 of file sRandomNumberGenerator.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~sRandomNumberGenerator()

sRandomNumberGenerator::~sRandomNumberGenerator ( )

private

Destructor of sRandomNumberGenerator. Do nothing by default.

Definition at line 61 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

◆ sRandomNumberGenerator() [2/2]

sRandomNumberGenerator::sRandomNumberGenerator ( sRandomNumberGenerator const & )

private

Member Function Documentation

◆ GenerateExtraRdmNber()

HPFLTNB sRandomNumberGenerator::GenerateExtraRdmNber ( int a_nb = 0 )

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

Parameters

a_nb	index of the extra non threaded rng

Returns: HPFLTNB random number

Definition at line 252 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

◆ GenerateRdmNber()

HPFLTNB sRandomNumberGenerator::GenerateRdmNber ( )

Generate a random number for the thread which index is recovered from the OpenMP function.

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

Definition at line 232 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

◆ GetExtraGenerator()

sRandomNumberGenerator::Engine & sRandomNumberGenerator::GetExtraGenerator ( int a_nb = 0 )

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

Parameters

a_nb	index of the extra non threaded rng

Returns: HPFLTNB random number

Definition at line 267 of file sRandomNumberGenerator.cc.

◆ GetInstance()

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 52 of file sRandomNumberGenerator.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize() [1/2]

int sRandomNumberGenerator::Initialize	(	int	a_nbThreads,
		int	a_nbExtra
	)

Instantiate pseudo random number generators, one per thread by default, and additional extra ones if requested.

Parameters

a_nbThreads	: number of generators intended for usage in threads (one per thread)
a_nbExtra	: number of additional generators intended for other usage (not thread safe)

The generators for each thread and each MPI instance should be independent. The initial seed is generated by the true random generator and used to seed a temporary PRNG, which generates seeds for all final PRNGs. If MPI is used, an additional level of temporary generators is inserted, to ensure randomness.

Returns: 0 if success, positive value otherwise

Definition at line 72 of file sRandomNumberGenerator.cc.

Here is the caller graph for this function:

◆ Initialize() [2/2]

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

Instantiate pseudo random number generators, one per thread by default, and additional extra ones if requested, starting from the user-provided seed.

Parameters

a_seed	: initial seed
a_nbThreads	: number of generators intended for usage in threads (one per thread)
a_nbExtra	: number of additional generators intended for other usage (not thread safe)

The generators for each thread and each MPI instance should be independent. The user-provided seed is fed to a temporary PRNG, which generates seeds for all final PRNGs. If MPI is used, an additional level of temporary generators is inserted, to ensure randomness.

Returns: 0 if success, positive value otherwise

Definition at line 151 of file sRandomNumberGenerator.cc.

◆ operator=()

void sRandomNumberGenerator::operator= ( sRandomNumberGenerator const & )

private

Here is the caller graph for this function:

◆ SetVerbose()

void sRandomNumberGenerator::SetVerbose ( int a_verboseLevel )

inline

Set verbosity level.

Parameters

a_verboseLevel

Definition at line 119 of file sRandomNumberGenerator.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ m_seed

int64_t sRandomNumberGenerator::m_seed

private

Initial seed, that will start the initialization process for all the final pseudo random generators

Definition at line 148 of file sRandomNumberGenerator.hh.

◆ m_verbose

int sRandomNumberGenerator::m_verbose

private

Verbosity Level

Definition at line 144 of file sRandomNumberGenerator.hh.

◆ mp_Distribution

Distribution sRandomNumberGenerator::mp_Distribution

private

Uniform distribution

Definition at line 147 of file sRandomNumberGenerator.hh.

◆ mp_Engines

vector<Engine> sRandomNumberGenerator::mp_Engines

private

Multithreaded of mt199937 Engines (1 by thread)

Definition at line 145 of file sRandomNumberGenerator.hh.

◆ mp_extraEngines

vector<Engine> sRandomNumberGenerator::mp_extraEngines

private

Additional non threaded mt199937 Engines if requested

Definition at line 146 of file sRandomNumberGenerator.hh.

◆ mp_Instance

sRandomNumberGenerator * sRandomNumberGenerator::mp_Instance = NULL

staticprivate

Unique instance of the singleton class

Definition at line 143 of file sRandomNumberGenerator.hh.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Distribution

◆ Engine

Constructor & Destructor Documentation

◆ sRandomNumberGenerator() [1/2]

◆ ~sRandomNumberGenerator()

◆ sRandomNumberGenerator() [2/2]

Member Function Documentation

◆ GenerateExtraRdmNber()

◆ GenerateRdmNber()

◆ GetExtraGenerator()

◆ GetInstance()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ operator=()

◆ SetVerbose()

Member Data Documentation

◆ m_seed

◆ m_verbose

◆ mp_Distribution

◆ mp_Engines

◆ mp_extraEngines

◆ mp_Instance