theplu::yat::random::Discrete Class Reference

Discrete random number distributions. More...

#include <yat/random/random.h>

Inheritance diagram for theplu::yat::random::Discrete:

Public Types
typedef unsigned long int	result_type

Public Member Functions
	Discrete (void)
	Constructor.
virtual	~Discrete (void)
	The destructor.
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...
virtual result_type	operator() (void) const =0

Protected Attributes
RNG *	rng_
	GSL random gererator.

Detailed Description

Discrete random number distributions.

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

Member Typedef Documentation

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

type returned by operator()

Since

New in yat 0.10

Member Function Documentation

virtual result_type theplu::yat::random::Discrete::operator() ( void  ) const

pure virtual

Returns

A random number.

Implemented in theplu::yat::random::Poisson, theplu::yat::random::NegativeHyperGeometric, theplu::yat::random::HyperGeometric, theplu::yat::random::Geometric, theplu::yat::random::DiscreteUniform, theplu::yat::random::DiscreteGeneral, and theplu::yat::random::Binomial.

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.

unsigned long theplu::yat::random::Discrete::seed_from_devurandom

(

void

)

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