libstdc++
std::negative_binomial_distribution Class Reference

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

A negative_binomial_distribution random number distribution.

The formula for the negative binomial probability mass function is $p(i) = \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 3776 of file random.h.


Member Function Documentation

_IntType std::negative_binomial_distribution::k ( ) const [inline]

Return the $k$ parameter of the distribution.

Definition at line 3827 of file random.h.

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

Returns the least upper bound value of the distribution.

Definition at line 3863 of file random.h.

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

Returns the greatest lower bound value of the distribution.

Definition at line 3856 of file random.h.

template<typename _UniformRandomNumberGenerator >
negative_binomial_distribution< _IntType >::result_type std::negative_binomial_distribution::operator() ( _UniformRandomNumberGenerator &  __urng)

Generating functions.

Definition at line 1083 of file random.tcc.

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

Return the $p$ parameter of the distribution.

Definition at line 3834 of file random.h.

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

Returns the parameter set of the distribution.

Definition at line 3841 of file random.h.

void std::negative_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 3849 of file random.h.

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

Resets the distribution state.

Definition at line 3820 of file random.h.

References std::gamma_distribution::reset().


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::negative_binomial_distribution< _IntType1 > &   
) [friend]

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

Parameters:
__osAn output stream.
__xA negative_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::negative_binomial_distribution< _IntType1 > &  __d1,
const std::negative_binomial_distribution< _IntType1 > &  __d2 
) [friend]

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

Definition at line 3885 of file random.h.

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

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

Parameters:
__isAn input stream.
__xA negative_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: