theplu::yat::random::Exponential Class Reference

Generator of random numbers from an exponential distribution. More...

#include <yat/random/random.h>

Inheritance diagram for theplu::yat::random::Exponential:

theplu::yat::random::Continuous

List of all members.

Public Member Functions

 Exponential (const double m=1)
 Constructor.
double operator() (void) const
double operator() (const double m) const
void seed (unsigned long s) const
 Set the seed to s.
unsigned long seed_from_devurandom (void)
 Set the seed using the /dev/urandom device.

Protected Attributes

RNGrng_
 pointer to GSL random generator


Detailed Description

Generator of random numbers from an exponential distribution.

The distribution function is $ f(x) = \frac{1}{m}\exp(-x/a) $ for $ x $ with the expectation value $ m $ and variance $ m^2 $


Constructor & Destructor Documentation

theplu::yat::random::Exponential::Exponential ( const double  m = 1  )  [explicit]

Constructor.

Parameters:
m is the expectation value of the distribution.


Member Function Documentation

double theplu::yat::random::Exponential::operator() ( void   )  const [virtual]

Returns:
A random number from exponential distribution.

Implements theplu::yat::random::Continuous.

double theplu::yat::random::Exponential::operator() ( const double  m  )  const

Returns:
A random number from exponential distribution, with expectation value m
Note:
This operator ignores parameters given in constructor.

void theplu::yat::random::Continuous::seed ( unsigned long  s  )  const [inherited]

Set the seed to s.

Set the seed to s in the underlying rng. If s is zero, a default value from the rng's original implementation is used (cf. GSL documentation).

See also:
seed_from_devurandom, RNG::seed_from_devurandom, RNG::seed

unsigned long theplu::yat::random::Continuous::seed_from_devurandom ( void   )  [inline, inherited]

Set the seed using the /dev/urandom device.

Returns:
The seed acquired from /dev/urandom.
See also:
seed, RNG::seed_from_devurandom, RNG::seed


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

Generated on Tue Jan 18 02:21:18 2011 for yat by  doxygen 1.5.5