BasicRandomNumberGenerator Class Reference

#include <BasicRandomNumberGenerator.h>

Collaboration diagram for BasicRandomNumberGenerator:

[legend]

List of all members.

Public Member Functions
	BasicRandomNumberGenerator ()
void	setSeed (const unsigned int seed)
unsigned int	getSeed ()
bool	getBool ()
long	getInteger (const long min=0, const long max=RAND_MAX)
double	getRatio ()
int	Randomize (void)
Static Public Member Functions
static BasicRandomNumberGenerator *	getInstance ()
Protected Member Functions
virtual	~BasicRandomNumberGenerator ()
Private Attributes
unsigned int	seed
int	bitBuf
unsigned int	bits
int	idum
Static Private Attributes
static BasicRandomNumberGenerator *	singleton = NULL

---

Detailed Description

A C++ interface to system random number generators.

Definition at line 37 of file BasicRandomNumberGenerator.h.

---

Constructor & Destructor Documentation

BasicRandomNumberGenerator::BasicRandomNumberGenerator

(

)

[inline]

Definition at line 46 of file BasicRandomNumberGenerator.h.

References idum, and setSeed().

Referenced by getInstance().

virtual BasicRandomNumberGenerator::~BasicRandomNumberGenerator

(

)

[inline, protected, virtual]

Definition at line 98 of file BasicRandomNumberGenerator.h.

---

Member Function Documentation

BasicRandomNumberGenerator * BasicRandomNumberGenerator::getInstance

(

)

[static]

Get a pointer to an instance of BasicRandomNumberGenerator. Creates an instance of the default implementation.

Returns:

A pointer to an instance of BasicRandomNumberGenerator.

Definition at line 33 of file BasicRandomNumberGenerator.cpp.

References BasicRandomNumberGenerator(), and singleton.

Referenced by CompuCell3D::UniformFieldInitializer::initCellType(), CompuCell3D::BlobFieldInitializer::initCellType(), CompuCell3D::UniformFieldInitializer::initializeCellTypes(), CompuCell3D::DictyFieldInitializer::initializeCellTypes(), CompuCell3D::BlobFieldInitializer::initializeCellTypesCellSort(), CompuCell3D::ReactionDiffusionSolverFE_SavHog::initializeConcentration(), CompuCell3D::Simulator::initializePottsCC3D(), CompuCell3D::Potts3D::metropolisBoundaryWalker(), CompuCell3D::Potts3D::metropolisFast(), CompuCell3D::Potts3D::metropolisList(), and CompuCell3D::Potts3D::update().

void BasicRandomNumberGenerator::setSeed

(

const unsigned int

seed

)

Set the random seed. Using the same seed will generate the same sequence of random numbers.

Definition at line 38 of file BasicRandomNumberGenerator.cpp.

References getRatio(), idum, and Randomize().

Referenced by BasicRandomNumberGenerator(), CompuCell3D::Simulator::initializePottsCC3D(), Randomize(), and CompuCell3D::Potts3D::update().

unsigned int BasicRandomNumberGenerator::getSeed

(

)

[inline]

Returns:

The seed used to initialize this sequence of random numbers.

Definition at line 69 of file BasicRandomNumberGenerator.h.

References seed.

Referenced by CompuCell3D::Potts3D::update().

bool BasicRandomNumberGenerator::getBool

(

)

Returns one bit from the random buffer.

Returns:

A random boolean value.

Definition at line 56 of file BasicRandomNumberGenerator.cpp.

References bitBuf, bits, and getInteger().

long BasicRandomNumberGenerator::getInteger	(	const long	min = 0,
		const long	max = RAND_MAX
	)

Parameters:

	min	Minimum value inclusive.
	max	Maximum value inclusive.

Returns:

A random integer in the range [min, max].

Definition at line 70 of file BasicRandomNumberGenerator.cpp.

References getRatio().

Referenced by getBool(), CompuCell3D::UniformFieldInitializer::initCellType(), CompuCell3D::BlobFieldInitializer::initCellType(), CompuCell3D::UniformFieldInitializer::initializeCellTypes(), CompuCell3D::Potts3D::metropolisBoundaryWalker(), CompuCell3D::Potts3D::metropolisFast(), and CompuCell3D::Potts3D::metropolisList().

double BasicRandomNumberGenerator::getRatio

(

)

Returns:

A random double in the range [0, 1).

Definition at line 75 of file BasicRandomNumberGenerator.cpp.

References FAC, idum, MBIG, MSEED, and MZ.

Referenced by getInteger(), CompuCell3D::DictyFieldInitializer::initializeCellTypes(), CompuCell3D::BlobFieldInitializer::initializeCellTypesCellSort(), CompuCell3D::ReactionDiffusionSolverFE_SavHog::initializeConcentration(), CompuCell3D::Potts3D::metropolisBoundaryWalker(), CompuCell3D::Potts3D::metropolisFast(), CompuCell3D::Potts3D::metropolisList(), and setSeed().

int BasicRandomNumberGenerator::Randomize

(

void

)

Returns:

seed used to initialize randome number generator based on local time

Definition at line 121 of file BasicRandomNumberGenerator.cpp.

References seed, and setSeed().

Referenced by setSeed().

---

Member Data Documentation

BasicRandomNumberGenerator * BasicRandomNumberGenerator::singleton = NULL [static, private]

Definition at line 38 of file BasicRandomNumberGenerator.h.

Referenced by getInstance().

unsigned int BasicRandomNumberGenerator::seed [private]

Definition at line 40 of file BasicRandomNumberGenerator.h.

Referenced by getSeed(), and Randomize().

int BasicRandomNumberGenerator::bitBuf [private]

Definition at line 41 of file BasicRandomNumberGenerator.h.

Referenced by getBool().

unsigned int BasicRandomNumberGenerator::bits [private]

Definition at line 42 of file BasicRandomNumberGenerator.h.

Referenced by getBool().

int BasicRandomNumberGenerator::idum [private]

Definition at line 43 of file BasicRandomNumberGenerator.h.

Referenced by BasicRandomNumberGenerator(), getRatio(), and setSeed().

---

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

• CompuCell/DOXYGEN/core/BasicUtils/BasicRandomNumberGenerator.h
• CompuCell/DOXYGEN/core/BasicUtils/BasicRandomNumberGenerator.cpp