Manpages - std_negative_binomial_distribution.3
Table of Contents
- NAME
- SYNOPSIS
- Detailed Description
- Member Typedef Documentation
- Constructor & Destructor Documentation
- Member Function Documentation
- template<typename _IntType = int> template<typename _ForwardIterator
- template<typename _IntType = int> template<typename _ForwardIterator
- template<typename _IntType = int> template<typename
- template<typename _IntType = int> template<typename
- template<typename _IntType = int> _IntType
- template<typename _IntType = int> result_type
- template<typename _IntType = int> result_type
- template<typename _IntType > template<typename
- template<typename _IntType > template<typename
- template<typename _IntType = int> double
- template<typename _IntType = int> param_type
- template<typename _IntType = int> void
- template<typename _IntType = int> void
- Friends And Related Function Documentation
- Author
NAME
std::negative_binomial_distribution< _IntType > - A negative_binomial_distribution random number distribution.
SYNOPSIS
#include <random.h>
Classes
struct param_type
Public Types
typedef _IntType result_type
Public Member Functions
negative_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_type max () const
Returns the least upper bound value of the distribution.
result_type min () const
Returns the greatest lower bound value of the distribution.
template<typename _UniformRandomNumberGenerator > result_type
operator() (_UniformRandomNumberGenerator &__urng)
Generating functions.
template<typename _UniformRandomNumberGenerator > result_type
operator() (_UniformRandomNumberGenerator &__urng, const param_type
&__p)
double p () const
Return the \(p\) parameter of the distribution.
param_type param () const
Returns the parameter set of the distribution.
void param (const param_type &__param)
Sets the parameter set of the distribution.
void reset ()
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
.
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) = inom{n}{i} p^i (1 - p)^{t - i}\) where \(t\) and \(p\) are the parameters of the distribution.
Definition at line 4190 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 4197 of file random.h.
Constructor & Destructor Documentation
template<typename _IntType = int>
std::negative_binomial_distribution*< _IntType >::*negative_binomial_distribution ()= [inline]= Definition at line 4234 of file random.h.
template<typename _IntType = int>
std::negative_binomial_distribution*< _IntType
>::*negative_binomial_distribution (_IntType __k, double __p =
0.5
)= [inline]=, = [explicit]=
Definition at line 4237 of file random.h.
template<typename _IntType = int>
std::negative_binomial_distribution*< _IntType >::*negative_binomial_distribution (const param_type & __p)= [inline]=, = [explicit]= Definition at line 4242 of file random.h.
Member Function Documentation
template<typename _IntType = int> template<typename _ForwardIterator
, typename _UniformRandomNumberGenerator > void std::negative_binomial_distribution*< _IntType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng)= [inline]= Definition at line *4311 of file random.h.
template<typename _IntType = int> template<typename _ForwardIterator
, typename _UniformRandomNumberGenerator > void std::negative_binomial_distribution*< _IntType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng, const *param_type & __p)= [inline]= Definition at line 4318 of file random.h.
template<typename _IntType = int> template<typename
_UniformRandomNumberGenerator > void std::negative_binomial_distribution*< _IntType >::__generate (*result_type * __f, result_type * __t, _UniformRandomNumberGenerator & __urng)= [inline]= Definition at line 4325 of file random.h.
template<typename _IntType = int> template<typename
_UniformRandomNumberGenerator > void std::negative_binomial_distribution*< _IntType >::__generate (*result_type * __f, result_type * __t, _UniformRandomNumberGenerator & __urng, const param_type & __p)= [inline]= Definition at line 4331 of file random.h.
template<typename _IntType = int> _IntType
*std::negative_binomial_distribution*< _IntType >::k () const= [inline]= Return the \(k\) parameter of the distribution.
Definition at line 4257 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 4293 of file random.h.
References std::numeric_limits< _Tp >::max().
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 4286 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 1145 of file bits/random.tcc.
template<typename _IntType > template<typename
_UniformRandomNumberGenerator > negative_binomial_distribution*< _IntType >::*result_type std::negative_binomial_distribution*< _IntType >::operator() (_UniformRandomNumberGenerator & __urng, const *param_type & __p) Definition at line 1158 of file bits/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 4264 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 4271 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 4279 of file random.h.
template<typename _IntType = int> void
*std::negative_binomial_distribution*< _IntType >::reset ()= [inline]= Resets the distribution state.
Definition at line 4250 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::negative_binomial_distribution*< _IntType1 > &
__x)= [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> bool operator== (const
*negative_binomial_distribution*< _IntType > & __d1, const *negative_binomial_distribution*< _IntType > & __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 4342 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::negative_binomial_distribution*< _IntType1 > & __x)= [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.