libstdc++
std::binomial_distribution Class Reference

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

A discrete binomial random number distribution.

The formula for the binomial probability density function is $p(i|t,p) = \binom{n}{i} p^i (1 - p)^{t - i}$ where $t$ and $p$ are the parameters of the distribution.


Member Typedef Documentation

The type of the range of the distribution.

Definition at line 3401 of file random.h.


Member Function Documentation

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

Returns the least upper bound value of the distribution.

Definition at line 3504 of file random.h.

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

Returns the greatest lower bound value of the distribution.

Definition at line 3497 of file random.h.

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

Generating functions.

Definition at line 3512 of file random.h.

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

Referenced by operator()().

template<typename _UniformRandomNumberGenerator >
binomial_distribution< _IntType >::result_type std::binomial_distribution::operator() ( _UniformRandomNumberGenerator &  __urng,
const param_type __param 
)

A rejection algorithm when t * p >= 8 and a simple waiting time method - the second in the referenced book - otherwise. NB: The former is available only if _GLIBCXX_USE_C99_MATH_TR1 is defined.

Reference: Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag, New York, 1986, Ch. X, Sect. 4 (+ Errata!).

Definition at line 1432 of file random.tcc.

References std::poisson_distribution::max(), std::abs(), and std::log().

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

Returns the distribution p parameter.

Definition at line 3475 of file random.h.

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

Returns the parameter set of the distribution.

Definition at line 3482 of file random.h.

Referenced by operator()().

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

Sets the parameter set of the distribution.

Parameters:
__paramThe new parameter set of the distribution.

Definition at line 3490 of file random.h.

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

Resets the distribution state.

Definition at line 3461 of file random.h.

References std::normal_distribution::reset().

_IntType std::binomial_distribution::t ( ) const [inline]

Returns the distribution t parameter.

Definition at line 3468 of file random.h.


Friends And Related Function Documentation

template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  ,
const std::binomial_distribution< _IntType1 > &   
) [friend]

Inserts a binomial_distribution random number distribution __x into the output stream __os.

Parameters:
__osAn output stream.
__xA binomial_distribution random number distribution.
Returns:
The output stream with the state of __x inserted or in an error state.
template<typename _IntType1 >
bool operator== ( const std::binomial_distribution< _IntType1 > &  __d1,
const std::binomial_distribution< _IntType1 > &  __d2 
) [friend]

Return true if two binomial distributions have the same parameters and the sequences that would be generated are equal.

Definition at line 3527 of file random.h.

template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  ,
std::binomial_distribution< _IntType1 > &   
) [friend]

Extracts a binomial_distribution random number distribution __x from the input stream __is.

Parameters:
__isAn input stream.
__xA binomial_distribution random number generator engine.
Returns:
The input stream with __x extracted or in an error state.

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