yat  0.8.3pre
Public Member Functions | Protected Attributes
theplu::yat::random::Discrete Class Reference

Discrete random number distributions. More...

#include <yat/random/random.h>

Inheritance diagram for theplu::yat::random::Discrete:
theplu::yat::random::DiscreteGeneral theplu::yat::random::DiscreteUniform theplu::yat::random::Poisson

List of all members.

Public Member Functions

 Discrete (void)
 Constructor.
virtual ~Discrete (void)
 The destructor.
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.
virtual unsigned long operator() (void) const =0

Protected Attributes

RNGrng_
 GSL random gererator.

Detailed Description

Discrete random number distributions.

Abstract base class for discrete random number distributions. Given K discrete events with different probabilities $ P[k] $, produce a random value k consistent with its probability.


Member Function Documentation

virtual unsigned long theplu::yat::random::Discrete::operator() ( void  ) const
pure virtual
void theplu::yat::random::Discrete::seed ( unsigned long  s) const

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.

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:

Generated on Thu Dec 20 2012 03:12:59 for yat by  doxygen 1.8.0-20120409