std::negative_binomial_distribution< _IntType > - A negative_binomial_distribution random number
Contents
Detailed Description
template<typename_IntType=int>
class std::negative_binomial_distribution< _IntType >"A negative_binomial_dnstribution random number
distribution. o
m
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. n
}
{
Since
C++11
Member Function Documentation
template<typename_IntType=int>_IntTypestd::negative_binomial_distribution<_IntType>::k()const[inline]
Return the $k$ parameter of the distribution.
template<typename_IntType=int>result_typestd::negative_binomial_distribution<_IntType>::max()const[inline]
Returns the least upper bound value of the distribution.
References std::numeric_limits<_Tp>::max().
template<typename_IntType=int>result_typestd::negative_binomial_distribution<_IntType>::min()const[inline]
Returns the greatest lower bound value of the distribution.
template<typename_IntType>template<typename_UniformRandomNumberGenerator>negative_binomial_distribution<_IntType>::result_typestd::negative_binomial_distribution<_IntType>::operator()(_UniformRandomNumberGenerator&__urng)
Generating functions.
template<typename_IntType=int>doublestd::negative_binomial_distribution<_IntType>::p()const[inline]
Return the $p$ parameter of the distribution.
template<typename_IntType=int>param_typestd::negative_binomial_distribution<_IntType>::param()const[inline]
Returns the parameter set of the distribution.
template<typename_IntType=int>voidstd::negative_binomial_distribution<_IntType>::param(constparam_type&__param)[inline]
Sets the parameter set of the distribution.
Parameters__param The new parameter set of the distribution.
template<typename_IntType=int>voidstd::negative_binomial_distribution<_IntType>::reset()[inline]
Resets the distribution state.
References std::gamma_distribution<_RealType>::reset().
Member Typedef Documentation
template<typename_IntType=int>typedef_IntTypestd::negative_binomial_distribution<_IntType>::result_type
The type of the range of the distribution.
Name
std::negative_binomial_distribution< _IntType > - A negative_binomial_distribution random number
distribution.
Synopsis
#include <random>
Classes
struct param_typePublicTypestypedef _IntType result_typePublicMemberFunctionsnegative_binomial_distribution (_IntType __k, double __p=0.5)
negative_binomial_distribution (const param_type &__p)
template<typename_ForwardIterator , typename_UniformRandomNumberGenerator > void__generate
(_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
template<typename_ForwardIterator , typename_UniformRandomNumberGenerator > void__generate
(_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type
&__p)
template<typename_UniformRandomNumberGenerator > void__generate (result_type *__f, result_type *__t,
_UniformRandomNumberGenerator &__urng)
template<typename_UniformRandomNumberGenerator > void__generate (result_type *__f, result_type *__t,
_UniformRandomNumberGenerator &__urng, const param_type &__p)
_IntType k () const
Return the $k$ parameter of the distribution.
result_typemax () const
Returns the least upper bound value of the distribution.
result_typemin () const
Returns the greatest lower bound value of the distribution.
template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
&__urng)
Generating functions.
template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
&__urng, const param_type &__p)
double p () const
Return the $p$ parameter of the distribution.
param_typeparam () const
Returns the parameter set of the distribution.
voidparam (const param_type &__param)
Sets the parameter set of the distribution.
voidreset ()
Resets the distribution state.
Friends
template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits >
& operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::negative_binomial_distribution<
_IntType1 > &__x)
Inserts a negative_binomial_distribution random number distribution __x into the output stream __os.
bool operator== (const negative_binomial_distribution &__d1, const negative_binomial_distribution &__d2)
Return true if two negative binomial distributions have the same parameters and the sequences that
would be generated are equal.
template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits >
& operator>> (std::basic_istream< _CharT, _Traits > &__is, std::negative_binomial_distribution<
_IntType1 > &__x)
Extracts a negative_binomial_distribution random number distribution __x from the input stream __is.
