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:

Public Types
typedef double	result_type

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

Protected Attributes
RNG *	rng_
	pointer to GSL random generator

Detailed Description

Generator of random numbers from an exponential distribution.

The distribution function is for with the expectation value and variance

Member Typedef Documentation

typedef double theplu::yat::random::Continuous::result_type

inherited

type returned by operator()

Since

New in yat 0.10

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).

Deprecated:

Provided for backward compatibility with the 0.7 API. Use RNG::instance()->seed(s) instead.

unsigned long theplu::yat::random::Continuous::seed_from_devurandom ( void  )

inherited

Set the seed using the /dev/urandom device.

Returns

The seed acquired from /dev/urandom.

Deprecated:

Provided for backward compatibility with the 0.7 API. Use RNG::instance()->seed_from_devurandom() instead.

---

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

• yat/random/random.h