RandomNumbers Class Reference

Base class of random number generators. More...

#include <randomNumbers.h>

Inheritance diagram for RandomNumbers:

Classes
class	rand_gauss_even
class	rand_gauss_odd
class	rand_uniform

Public Member Functions
	RandomNumbers ()
virtual	~RandomNumbers ()
void	set_parameter_verboselevel (const Bridge::VerboseLevel vl)
virtual double	get ()=0
void	gauss (double &rand1, double &rand2)
virtual void	gauss_lex_global (Field &)
	gaussian random number defined on global lattice. More...
virtual void	gauss_eo_global (Field &)
	gaussian noise for even-odd perconditioned field (S.UEDA) More...
virtual void	uniform_lex_global (Field &)
	uniform random number defined on global lattice. More...
virtual void	read_file (const std::string &)=0
	save and load random number status. More...
virtual void	write_file (const std::string &)=0
virtual void	reset (unsigned long seed)=0
	reset state with new seed. More...

Static Public Attributes
static const std::string	class_name = "RandomNumbers"

Protected Attributes
Bridge::VerboseLevel	m_vl

Private Member Functions
	RandomNumbers (const RandomNumbers &)
RandomNumbers &	operator= (const RandomNumbers &)
template<typename InnerGenerator >
void	generate_global (Field &f)

Detailed Description

Base class of random number generators.

This class defines the interface of random number generator, and implements common methods. Practical methods to generate random numbers are defined in subclasses. This class also implements Gaussian random number and method to set a global field of Gaussian random numbers and cut it out to the local field for the own node (gauss_lex_global()) which is useful in HMC etc. [25 Dec 2011 H.Matsufuru]

Definition at line 36 of file randomNumbers.h.

Constructor & Destructor Documentation

RandomNumbers::RandomNumbers ( )

inline

Definition at line 46 of file randomNumbers.h.

virtual RandomNumbers::~RandomNumbers ( )

inlinevirtual

Definition at line 49 of file randomNumbers.h.

RandomNumbers::RandomNumbers ( const RandomNumbers &  )

private

Member Function Documentation

void RandomNumbers::gauss	(	double &	rand1,
		double &	rand2
	)

Definition at line 33 of file randomNumbers.cpp.

void RandomNumbers::gauss_eo_global ( Field &  f )

virtual

gaussian noise for even-odd perconditioned field (S.UEDA)

Definition at line 66 of file randomNumbers.cpp.

void RandomNumbers::gauss_lex_global ( Field &  f )

virtual

gaussian random number defined on global lattice.

Definition at line 48 of file randomNumbers.cpp.

template<typename InnerGenerator >

void RandomNumbers::generate_global ( Field &  f )

private

Definition at line 172 of file randomNumbers.cpp.

virtual double RandomNumbers::get ( )

pure virtual

Implemented in RandomNumbers_Mseries, and RandomNumbers_MT19937.

RandomNumbers& RandomNumbers::operator= ( const RandomNumbers &  )

private

virtual void RandomNumbers::read_file ( const std::string &  )

pure virtual

save and load random number status.

Implemented in RandomNumbers_Mseries, and RandomNumbers_MT19937.

virtual void RandomNumbers::reset ( unsigned long  seed )

pure virtual

reset state with new seed.

Implemented in RandomNumbers_Mseries, and RandomNumbers_MT19937.

void RandomNumbers::set_parameter_verboselevel ( const Bridge::VerboseLevel  vl )

inline

Definition at line 58 of file randomNumbers.h.

void RandomNumbers::uniform_lex_global ( Field &  f )

virtual

uniform random number defined on global lattice.

Definition at line 59 of file randomNumbers.cpp.

virtual void RandomNumbers::write_file ( const std::string &  )

pure virtual

Implemented in RandomNumbers_Mseries, and RandomNumbers_MT19937.

Member Data Documentation

const std::string RandomNumbers::class_name = "RandomNumbers"

static

Definition at line 39 of file randomNumbers.h.

Bridge::VerboseLevel RandomNumbers::m_vl

protected

Definition at line 42 of file randomNumbers.h.

---

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

• src/lib/Tools/randomNumbers.h
• src/lib/Tools/randomNumbers.cpp