libstdc++
Classes | Public Types | Public Member Functions | Friends
std::binomial_distribution< _IntType > Class Template Reference
Bernoulli Distributions

List of all members.

Classes

Public Types

Public Member Functions

Friends

Detailed Description

template<typename _IntType = int>
class std::binomial_distribution< _IntType >

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.

Definition at line 3407 of file random.h.

Member Typedef Documentation

template<typename _IntType = int>
typedef _IntType std::binomial_distribution< _IntType >::result_type

The type of the range of the distribution.

Definition at line 3414 of file random.h.

Member Function Documentation

template<typename _IntType = int>
result_type std::binomial_distribution< _IntType >::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 3517 of file random.h.

template<typename _IntType = int>
result_type std::binomial_distribution< _IntType >::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 3510 of file random.h.

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

Generating functions.

Definition at line 3525 of file random.h.

References std::binomial_distribution< _IntType >::operator()(), and std::binomial_distribution< _IntType >::param().

Referenced by std::binomial_distribution< _IntType >::operator()().

template<typename _IntType >
template<typename _UniformRandomNumberGenerator >
binomial_distribution< _IntType >::result_type std::binomial_distribution< _IntType >::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 1436 of file random.tcc.

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

template<typename _IntType = int>
double std::binomial_distribution< _IntType >::p ( ) const [inline]

Returns the distribution p parameter.

Definition at line 3488 of file random.h.

template<typename _IntType = int>
param_type std::binomial_distribution< _IntType >::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 3495 of file random.h.

Referenced by std::binomial_distribution< _IntType >::operator()().

template<typename _IntType = int>
void std::binomial_distribution< _IntType >::param ( const param_type &  __param) [inline]

Sets the parameter set of the distribution.

Parameters:
__paramThe new parameter set of the distribution.

Definition at line 3503 of file random.h.

template<typename _IntType = int>
void std::binomial_distribution< _IntType >::reset ( ) [inline]

Resets the distribution state.

Definition at line 3474 of file random.h.

References std::normal_distribution< _RealType >::reset().

template<typename _IntType = int>
_IntType std::binomial_distribution< _IntType >::t ( ) const [inline]

Returns the distribution t parameter.

Definition at line 3481 of file random.h.

Friends And Related Function Documentation

template<typename _IntType = int>
template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  __os,
const std::binomial_distribution< _IntType1 > &  __x 
) [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 _IntType = int>
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 3540 of file random.h.

template<typename _IntType = int>
template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  __is,
std::binomial_distribution< _IntType1 > &  __x 
) [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: