Stride Reference Manual  1.0
stride::util::Random Class Reference

The random number generator. More...

#include <Random.h>

Collaboration diagram for stride::util::Random:
Collaboration graph

Public Member Functions

 Random (const unsigned long seed=0)
 
double nextDouble ()
 
unsigned int operator() (unsigned int max=std::numeric_limits< unsigned int >::max())
 Get random unsigned int from [0, max[. More...
 
bool hasContact (double contact_rate)
 Check if two individuals have contact. More...
 
bool hasTransmission (double transmission_rate)
 Check if two individuals have transmission. More...
 
bool hasContactAndTransmission (double contact_rate, double transmission_rate)
 
void setState (std::string state)
 

Private Attributes

trng::mrg2 m_engine
 The random number engine. More...
 
trng::uniform01_dist< doublem_uniform_dist
 The random distribution. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const Random &random)
 

Detailed Description

The random number generator.

Definition at line 39 of file Random.h.

Constructor & Destructor Documentation

stride::util::Random::Random ( const unsigned long  seed = 0)
inline

Definition at line 41 of file Random.h.

References m_engine, and m_uniform_dist.

Member Function Documentation

double stride::util::Random::nextDouble ( )
inline
unsigned int stride::util::Random::operator() ( unsigned int  max = std::numeric_limits<unsigned int>::max())
inline

Get random unsigned int from [0, max[.

Definition at line 51 of file Random.h.

References m_engine.

bool stride::util::Random::hasContact ( double  contact_rate)
inline
bool stride::util::Random::hasTransmission ( double  transmission_rate)
inline
bool stride::util::Random::hasContactAndTransmission ( double  contact_rate,
double  transmission_rate 
)
inline
void stride::util::Random::setState ( std::string  state)
inline

Definition at line 70 of file Random.h.

References m_engine.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Random random 
)
friend

Definition at line 76 of file Random.h.

Member Data Documentation

trng::mrg2 stride::util::Random::m_engine
private

The random number engine.

Definition at line 82 of file Random.h.

Referenced by nextDouble(), operator()(), Random(), and setState().

trng::uniform01_dist<double> stride::util::Random::m_uniform_dist
private

The random distribution.

Definition at line 83 of file Random.h.

Referenced by nextDouble(), and Random().


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