26 Numerics library [numerics]

26.5 Random number generation [rand]

26.5.8 Random number distribution class templates [rand.dist]

26.5.8.3 Bernoulli distributions [rand.dist.bern]

26.5.8.3.4 Class template negative_binomial_distribution [rand.dist.bern.negbin]

1

A negative_binomial_distribution random number distribution produces random integers i ≥ 0 distributed according to the discrete probability function \[% P(i\,|\,k,p) = \binom{k+i-1}{i} \cdot p^k \cdot (1-p)^i \; \mbox{.} \]

template<class IntType = int>
 class negative_binomial_distribution{
public:
 // types
 typedef IntType  result_type;
 typedef unspecified param_type;

 // constructor and reset functions
 explicit negative_binomial_distribution(IntType k = 1, double p = 0.5);
 explicit negative_binomial_distribution(const param_type& parm);
 void reset();

 // generating functions
 template<class URNG>
   result_type operator()(URNG& g);
 template<class URNG>
   result_type operator()(URNG& g, const param_type& parm);

 // property functions
 IntType k() const;
 double p() const;
 param_type param() const;
 void param(const param_type& parm);
 result_type min() const;
 result_type max() const;
};

explicit negative_binomial_distribution(IntType k = 1, double p = 0.5);

2

Requires: 0 < p ≤ 1 and 0 < k .

3

Effects: Constructs a negative_binomial_distribution object; k and p correspond to the respective parameters of the distribution.

IntType k() const;

4

Returns: The value of the k parameter with which the object was constructed.

double p() const;

5

Returns: The value of the p parameter with which the object was constructed.