std::bernoulli_distribution Class Reference
[Bernoulli Distributions]

A Bernoulli random number distribution. More...

List of all members.

Classes

Public Types

Public Member Functions


Detailed Description

A Bernoulli random number distribution.

Generates a sequence of true and false values with likelihood $ p $ that true will come up and $ (1 - p) $ that false will appear.

Definition at line 2834 of file random.h.


Member Typedef Documentation

The type of the range of the distribution.

Definition at line 2838 of file random.h.


Constructor & Destructor Documentation

std::bernoulli_distribution::bernoulli_distribution ( double  __p = 0.5  )  [inline, explicit]

Constructs a Bernoulli distribution with likelihood p.

Parameters:
__p [IN] The likelihood of a true result being returned. Must be in the interval $ [0, 1] $.

Definition at line 2867 of file random.h.


Member Function Documentation

result_type std::bernoulli_distribution::max (  )  const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2917 of file random.h.

result_type std::bernoulli_distribution::min (  )  const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2910 of file random.h.

template<typename _UniformRandomNumberGenerator >
result_type std::bernoulli_distribution::operator() ( _UniformRandomNumberGenerator &  __urng  )  [inline]

Returns the next value in the Bernoullian sequence.

Definition at line 2925 of file random.h.

References operator()(), and param().

Referenced by operator()().

double std::bernoulli_distribution::p (  )  const [inline]

Returns the p parameter of the distribution.

Definition at line 2888 of file random.h.

void std::bernoulli_distribution::param ( const param_type __param  )  [inline]

Sets the parameter set of the distribution.

Parameters:
__param The new parameter set of the distribution.

Definition at line 2903 of file random.h.

param_type std::bernoulli_distribution::param (  )  const [inline]

Returns the parameter set of the distribution.

Definition at line 2895 of file random.h.

Referenced by operator()(), and std::operator>>().

void std::bernoulli_distribution::reset (  )  [inline]

Resets the distribution state.

Does nothing for a Bernoulli distribution.

Definition at line 2882 of file random.h.


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

Generated on 11 Jan 2010 for libstdc++ by  doxygen 1.6.1