std_negative_binomial_distribution.3cxx

Langue: en

Version: 356681 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

std::negative_binomial_distribution -

A negative_binomial_distribution random number distribution.

SYNOPSIS


Classes


struct param_type

Public Types


typedef _IntType result_type

Public Member Functions


negative_binomial_distribution (_IntType __k=1, double __p=0.5)

negative_binomial_distribution (const param_type &__p)

_IntType k () const

result_type max () const

result_type min () const

template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)

template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)

double p () const

void param (const param_type &__param)

param_type param () const

void reset ()

Friends


template<typename _IntType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &, const std::negative_binomial_distribution< _IntType1 > &)

template<typename _IntType1 > bool operator== (const std::negative_binomial_distribution< _IntType1 > &__d1, const std::negative_binomial_distribution< _IntType1 > &__d2)

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

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) = } p^i (1 - p)^{t - i}$ where $t$ and $p$ are the parameters of the distribution.

Definition at line 3792 of file random.h.

Member Typedef Documentation

template<typename _IntType = int> typedef _IntType std::negative_binomial_distribution< _IntType >::result_typeThe type of the range of the distribution.

Definition at line 3799 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 3848 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 3884 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 3877 of file random.h.

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

Generating functions.

Definition at line 1041 of file random.tcc.

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

Return the $p$ parameter of the distribution.

Definition at line 3855 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 3862 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 3870 of file random.h.

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

Resets the distribution state.

Definition at line 3841 of file random.h.

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

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 > 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 3906 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 > &, 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.

Author

Generated automatically by Doxygen for libstdc++ from the source code.