theplu::yat::random::Poisson Class Reference

Poisson Distribution. More...

#include <yat/random/random.h>

Inheritance diagram for theplu::yat::random::Poisson:

Public Types
typedef unsigned long int	result_type

Public Member Functions
	Poisson (const double m=1)
	Constructor. More...
unsigned long	operator() (void) const
unsigned long	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_
	GSL random gererator.

Detailed Description

Poisson Distribution.

Having a Poisson process (i.e. no memory), number of occurences within a given time window is Poisson distributed. This distribution is the limit of a Binomial distribution when number of attempts is large, and the probability for one attempt to be succesful is small (in such a way that the expected number of succesful attempts is .

Probability function for
Expectation value:
Variance:

Member Typedef Documentation

result_type

typedef unsigned long int theplu::yat::random::Discrete::result_type

inherited

type returned by operator()

Since

New in yat 0.10

Constructor & Destructor Documentation

Poisson()

theplu::yat::random::Poisson::Poisson ( const double  m = 1 )

explicit

Constructor.

Parameters

m	is expectation value

Member Function Documentation

operator()() [1/2]

unsigned long theplu::yat::random::Poisson::operator() ( void  ) const

virtual

Returns

A Poisson distributed number.

Implements theplu::yat::random::Discrete.

operator()() [2/2]

unsigned long theplu::yat::random::Poisson::operator()

(

const double

m

)

const

Returns

A Poisson distributed number with expectation value m

Note

this operator ignores parameters set in Constructor

seed()

void theplu::yat::random::Discrete::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.

seed_from_devurandom()

unsigned long theplu::yat::random::Discrete::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