RandomNumberGenerator Class Reference

#include <RandomNumberGenerator.hpp>

Collaboration diagram for RandomNumberGenerator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

double StandardNormalRandomDeviate ()
double NormalRandomDeviate (double mean, double sd)
double ranf ()
unsigned randMod (unsigned base)
void Shuffle (unsigned num, std::vector< unsigned > &rValues)
void Reseed (int seed)

Static Public Member Functions

static RandomNumberGenerator * Instance ()
static void Destroy ()

Protected Member Functions

 RandomNumberGenerator ()

Private Member Functions

template<class Archive>
void save (Archive &archive, const unsigned int version) const
template<class Archive>
void load (Archive &archive, const unsigned int version)

Private Attributes

int mSeed
long unsigned mTimesCalled
double mWorkingMem1
double mWorkingMem2
double mWorkingMemW
double mRandNum2
bool mUseLastNum

Static Private Attributes

static RandomNumberGenerator * mpInstance = NULL

Friends

class boost::serialization::access

Detailed Description

A special singleton class allowing one to generate different types of random number in a globally consistent way.

Definition at line 40 of file RandomNumberGenerator.hpp.

Constructor & Destructor Documentation

RandomNumberGenerator::RandomNumberGenerator (  )  [protected]

Protected constructor. Use Instance() to access the random number generator.

Definition at line 39 of file RandomNumberGenerator.cpp.

References mSeed.

Referenced by Instance().

Member Function Documentation

template<class Archive>
void RandomNumberGenerator::save ( Archive &  archive,
const unsigned int  version 
) const [inline, private]

Save the RandomNumberGenerator and its member variables.

Serialization of a RandomNumberGenerator object must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters:
archive the archive
version the current version of this class

Definition at line 77 of file RandomNumberGenerator.hpp.

References mRandNum2, mSeed, mTimesCalled, and mUseLastNum.

template<class Archive>
void RandomNumberGenerator::load ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Load the RandomNumberGenerator and its member variables.

Serialization of a RandomNumberGenerator object must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters:
archive the archive
version the current version of this class

Definition at line 98 of file RandomNumberGenerator.hpp.

References mRandNum2, mSeed, mTimesCalled, and mUseLastNum.

double RandomNumberGenerator::StandardNormalRandomDeviate (  ) 

Uses a ranf() call and an approximation to the inverse PDF of the normal distribution to generate an accurate estimate of a normally distributed random number. Adapted from the algorithm outlined at http://home.online.no/~pjacklam/notes/invnorm/#Pseudo_code_for_rational_approximation

Returns:
a random number from the normal distribution with mean 0 and standard distribution 1.

This little method implements the Box-Mueller/Marsaglia polar method for getting normally distributed variables from uniform ones.

G. E. P. Box and Mervin E. Muller, A Note on the Generation of Random Normal Deviates, The Annals of Mathematical Statistics (1958), Vol. 29, No. 2 pp. 610–611

doi:10.1214/aoms/1177706645

as given on http://en.wikipedia.org/wiki/Marsaglia_polar_method on 29/11/10

Definition at line 112 of file RandomNumberGenerator.cpp.

References mRandNum2, mUseLastNum, mWorkingMem1, mWorkingMem2, mWorkingMemW, and ranf().

Referenced by NormalRandomDeviate().

double RandomNumberGenerator::NormalRandomDeviate ( double  mean,
double  sd 
)

Generate a random number from a normal distribution with given mean and standard deviation.

Parameters:
mean the mean of the normal distribution from which the random number is drawn
sd the standard deviation of the normal distribution from which the random number is drawn

Definition at line 81 of file RandomNumberGenerator.cpp.

References StandardNormalRandomDeviate().

Referenced by StochasticWntCellCycleModel::GenerateStochasticG2Duration(), StochasticOxygenBasedCellCycleModel::GenerateStochasticG2Duration(), and SimpleWntCellCycleModel::SetG1Duration().

double RandomNumberGenerator::ranf (  ) 

Generate a uniform random number in (0,1).

Definition at line 75 of file RandomNumberGenerator.cpp.

References mTimesCalled.

Referenced by VertexCryptSimulation2d::ApplyCellPopulationBoundaryConditions(), CryptSimulation2d::ApplyCellPopulationBoundaryConditions(), CryptSimulation2d::CalculateCellDivisionVector(), CryptSimulation1d::CalculateCellDivisionVector(), CellBasedSimulation< DIM >::CalculateCellDivisionVector(), CryptCellsGenerator< CELL_CYCLE_MODEL >::Generate(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasicRandom(), HoneycombMeshGenerator::GetCircularMesh(), CryptStatistics::GetCryptSection(), CryptProjectionStatistics::GetCryptSection(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetShortAxisOfElement(), StochasticDurationGenerationBasedCellCycleModel::SetG1Duration(), StandardNormalRandomDeviate(), RandomCellKiller< DIM >::TestAndLabelSingleCellForApoptosis(), and SimpleOxygenBasedCellCycleModel::UpdateHypoxicDuration().

unsigned RandomNumberGenerator::randMod ( unsigned  base  ) 

Generate a random number modulo base (ie an integer within the range 0,..,base-1),

Parameters:
base the order of the field of positive integers from which the random number is drawn

Definition at line 69 of file RandomNumberGenerator.cpp.

References mTimesCalled.

Referenced by Shuffle().

void RandomNumberGenerator::Shuffle ( unsigned  num,
std::vector< unsigned > &  rValues 
)

Produce a permutation of the integers 0,1,..,num-1, using the Knuth-algorithm (also called the Fisher-Yates algorithm), a linear time unbiased method. The shuffled values are returned in rValues, which doesn't need to be correctly-sized when passed in.

Parameters:
num the number of integers to shuffle
rValues the output permutation of shuffled values (any initial values ignored)

Definition at line 93 of file RandomNumberGenerator.cpp.

References Instance(), and randMod().

Referenced by DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ParMetisLibraryNodePartitioning(), and TetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::PermuteNodes().

RandomNumberGenerator * RandomNumberGenerator::Instance (  )  [static]

Return a pointer to the random number generator object. The object is created the first time this method is called.

Definition at line 51 of file RandomNumberGenerator.cpp.

References mpInstance, and RandomNumberGenerator().

Referenced by CryptSimulation2d::CalculateCellDivisionVector(), CryptSimulation1d::CalculateCellDivisionVector(), CellBasedSimulation< DIM >::CalculateCellDivisionVector(), CellBasedSimulation< DIM >::CellBasedSimulation(), CryptCellsGenerator< CELL_CYCLE_MODEL >::Generate(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasicRandom(), StochasticWntCellCycleModel::GenerateStochasticG2Duration(), StochasticOxygenBasedCellCycleModel::GenerateStochasticG2Duration(), HoneycombMeshGenerator::GetCircularMesh(), CryptStatistics::GetCryptSection(), CryptProjectionStatistics::GetCryptSection(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetShortAxisOfElement(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ParMetisLibraryNodePartitioning(), TetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::PermuteNodes(), StochasticWntCellCycleModel::serialize(), SimpleWntCellCycleModel::serialize(), CellBasedSimulation< 2 >::serialize(), RandomCellKiller< DIM >::serialize(), StochasticOxygenBasedCellCycleModel::serialize(), StochasticDurationGenerationBasedCellCycleModel::serialize(), SimpleWntCellCycleModel::SetG1Duration(), StochasticDurationGenerationBasedCellCycleModel::SetG1Duration(), AbstractCellBasedTestSuite::setUp(), Shuffle(), RandomCellKiller< DIM >::TestAndLabelSingleCellForApoptosis(), and SimpleOxygenBasedCellCycleModel::UpdateHypoxicDuration().

void RandomNumberGenerator::Destroy (  )  [static]

Destroy the current instance of the random number generator. The next call to Instance will create a new instance and re-seed. This method *must* be called before program exit, to avoid a memory leak.

Definition at line 60 of file RandomNumberGenerator.cpp.

References mpInstance.

Referenced by AbstractCellBasedTestSuite::tearDown().

void RandomNumberGenerator::Reseed ( int  seed  ) 

Reseed the random number generator.

Parameters:
seed the new seed

Definition at line 86 of file RandomNumberGenerator.cpp.

References mSeed, and mTimesCalled.

Referenced by DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ParMetisLibraryNodePartitioning(), and AbstractCellBasedTestSuite::setUp().

Member Data Documentation

int RandomNumberGenerator::mSeed [private]

The random number generator seed.

Definition at line 45 of file RandomNumberGenerator.hpp.

Referenced by load(), RandomNumberGenerator(), Reseed(), and save().

long unsigned RandomNumberGenerator::mTimesCalled [private]

The number of times the random number generator has been called.

Definition at line 48 of file RandomNumberGenerator.hpp.

Referenced by load(), randMod(), ranf(), Reseed(), and save().

RandomNumberGenerator * RandomNumberGenerator::mpInstance = NULL [static, private]

Pointer to the single instance.

Definition at line 51 of file RandomNumberGenerator.hpp.

Referenced by Destroy(), and Instance().

double RandomNumberGenerator::mWorkingMem1 [private]

Working memory for the normal random number calculations

Definition at line 54 of file RandomNumberGenerator.hpp.

Referenced by StandardNormalRandomDeviate().

double RandomNumberGenerator::mWorkingMem2 [private]

Working memory for the normal random number calculations

Definition at line 56 of file RandomNumberGenerator.hpp.

Referenced by StandardNormalRandomDeviate().

double RandomNumberGenerator::mWorkingMemW [private]

Working memory for the normal random number calculations

Definition at line 58 of file RandomNumberGenerator.hpp.

Referenced by StandardNormalRandomDeviate().

double RandomNumberGenerator::mRandNum2 [private]

Stored normal random number (we generate two at once)

Definition at line 60 of file RandomNumberGenerator.hpp.

Referenced by load(), save(), and StandardNormalRandomDeviate().

bool RandomNumberGenerator::mUseLastNum [private]

Whether to use the stored random number next

Definition at line 62 of file RandomNumberGenerator.hpp.

Referenced by load(), save(), and StandardNormalRandomDeviate().

The documentation for this class was generated from the following files:
Generated on Mon Apr 18 11:37:49 2011 for Chaste by  doxygen 1.5.5