cppdraft_translate/cppdraft/rand/dist/bern/negbin.md

[rand.dist.bern.negbin]

29 Numerics library [numerics]

29.5 Random number generation [rand]

29.5.9 Random number distribution class templates [rand.dist]

29.5.9.3 Bernoulli distributions [rand.dist.bern]

29.5.9.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 in Formula 29.7.

P(i|k,p)=(k+i−1i)â‹pkâ‹(1−p)i(29.7)

[Note 1:

This implies that P(i | k,p) is undefined when p == 1.

— end note]

🔗

namespace std {templateclass negative_binomial_distribution {public:// typesusing result_type = IntType; using param_type = unspecified; // constructor and reset functions negative_binomial_distribution() : negative_binomial_distribution(1) {}explicit negative_binomial_distribution(IntType k, double p = 0.5); explicit negative_binomial_distribution(const param_type& parm); void reset(); // equality operatorsfriend bool operator==(const negative_binomial_distribution& x, const negative_binomial_distribution& y); // generating functionstemplate result_type operator()(URBG& g); template result_type operator()(URBG& 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; // inserters and extractorstemplate<class charT, class traits>friend basic_ostream<charT, traits>&operator<<(basic_ostream<charT, traits>& os, const negative_binomial_distribution& x); template<class charT, class traits>friend basic_istream<charT, traits>&operator>>(basic_istream<charT, traits>& is, negative_binomial_distribution& x); };}

🔗

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

2

#

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

3

#

Remarks: 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.