RandomEngine Class Reference
Interface definition for a random number generator. More...
#include <RandomEngine.h>
Public Types | |
| typedef double | result_type |
| Let the boost implementation now what our return type is. | |
Public Member Functions | |
| virtual | ~RandomEngine () |
| This NOOP makes the compile happy. | |
| virtual double | operator() ()=0 |
| Returns a random number in the interval [0,1). | |
| virtual void | seed (unsigned s)=0 |
| Seed the random generator. | |
| void | seed () |
| Seed the random generator based on the current time. | |
| double | min () |
| Returns 0.0. | |
| double | max () |
| Returns 1.0. | |
Detailed Description
Interface definition for a random number generator.Generates random numbers (double precision) distributed uniformly over the interval [0,1)
Definition at line 27 of file RandomEngine.h.
Member Typedef Documentation
| typedef double RandomEngine::result_type |
Let the boost implementation now what our return type is.
Definition at line 32 of file RandomEngine.h.
Constructor & Destructor Documentation
| virtual RandomEngine::~RandomEngine | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual double RandomEngine::operator() | ( | ) | [pure virtual] |
Returns a random number in the interval [0,1).
Implemented in RandomEngineBoostImplementation< boost_engine >, RandomEngineBoostImplementation< boost::lagged_fibonacci23209 >, RandomEngineBoostImplementation< boost::mt19937 >, RandomEngineBoostImplementation< boost::lagged_fibonacci2281 >, RandomEngineBoostImplementation< boost::lagged_fibonacci3217 >, RandomEngineBoostImplementation< boost::lagged_fibonacci19937 >, RandomEngineBoostImplementation< boost::lagged_fibonacci9689 >, RandomEngineBoostImplementation< boost::mt11213b >, RandomEngineBoostImplementation< boost::lagged_fibonacci607 >, RandomEngineBoostImplementation< boost::lagged_fibonacci44497 >, RandomEngineBoostImplementation< boost::lagged_fibonacci4423 >, and RandomEngineBoostImplementation< boost::lagged_fibonacci1279 >.
| virtual void RandomEngine::seed | ( | unsigned | s | ) | [pure virtual] |
Seed the random generator.
Implemented in RandomEngineBoostImplementation< boost_engine >, RandomEngineBoostImplementation< boost::lagged_fibonacci23209 >, RandomEngineBoostImplementation< boost::mt19937 >, RandomEngineBoostImplementation< boost::lagged_fibonacci2281 >, RandomEngineBoostImplementation< boost::lagged_fibonacci3217 >, RandomEngineBoostImplementation< boost::lagged_fibonacci19937 >, RandomEngineBoostImplementation< boost::lagged_fibonacci9689 >, RandomEngineBoostImplementation< boost::mt11213b >, RandomEngineBoostImplementation< boost::lagged_fibonacci607 >, RandomEngineBoostImplementation< boost::lagged_fibonacci44497 >, RandomEngineBoostImplementation< boost::lagged_fibonacci4423 >, and RandomEngineBoostImplementation< boost::lagged_fibonacci1279 >.
Referenced by SingleThreadNetwork::seed_noise_rng(), MultiThreadNetwork::seed_noise_rng(), DistributedNetwork::seed_noise_rng(), and SimNetwork::setupConstructRNGEngines().
| void RandomEngine::seed | ( | ) | [inline] |
| double RandomEngine::min | ( | ) | [inline] |
Returns 0.0.
Definition at line 50 of file RandomEngine.h.
Referenced by SimNetwork::getSeedFromGenerator().
| double RandomEngine::max | ( | ) | [inline] |
Returns 1.0.
Definition at line 53 of file RandomEngine.h.
Referenced by SimNetwork::getSeedFromGenerator().
The documentation for this class was generated from the following file:
- /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simutils/RandomEngine.h
