std::negative_binomial_distribution< _IntType > Class Template Reference
[Bernoulli Distributions]

A negative_binomial_distribution random number distribution. More...

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

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

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.

Definition at line 3306 of file random.h.


Member Typedef Documentation

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

The type of the range of the distribution.

Definition at line 3313 of file random.h.


Member Function Documentation

template<typename _IntType = int>
_IntType std::negative_binomial_distribution< _IntType >::k (  )  const [inline]

Return the $ k $ parameter of the distribution.

Definition at line 3358 of file random.h.

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

Returns the least upper bound value of the distribution.

Definition at line 3394 of file random.h.

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

Returns the greatest lower bound value of the distribution.

Definition at line 3387 of file random.h.

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

Return the $ p $ parameter of the distribution.

Definition at line 3365 of file random.h.

template<typename _IntType = int>
void std::negative_binomial_distribution< _IntType >::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 3380 of file random.h.

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

Returns the parameter set of the distribution.

Definition at line 3372 of file random.h.

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

Resets the distribution state.

Definition at line 3351 of file random.h.

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


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

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

Parameters:
__os An output stream.
__x A negative_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 , 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:
__is An input stream.
__x A 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:

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