std::negative_binomial_distribution (3) - Linux Man Pages

std::negative_binomial_distribution: std::negative_binomial_distribution

NAME

std::negative_binomial_distribution - std::negative_binomial_distribution

Synopsis


Defined in header <random>
template< class IntType = int > (since C++11)
class negative_binomial_distribution;


Produces random non-negative integer values i, distributed according to discrete probability function:


      \(P(i|k, p) = \binom{k + i - 1}{i} \cdot p^k \cdot (1 - p)^i\)P(i|k,p) =⎛
      ⎜
      ⎝k + i − 1
      i⎞
      ⎟
      ⎠ · pk
      · (1 − p)i


The value represents the number of failures in a series of independent yes/no trials (each succeeds with probability p), before exactly k successes occur.
std::negative_binomial_distribution satisfies RandomNumberDistribution

Template parameters


IntType - The result type generated by the generator. The effect is undefined if this is not one of short, int, long, long long, unsigned short, unsigned int, unsigned long, or unsigned long long.

Member types


Member type Definition
result_type IntType
param_type the type of the parameter set, see RandomNumberDistribution.

Member functions


              constructs new distribution
constructor (public member function)
              resets the internal state of the distribution
reset (public member function)

Generation


              generates the next random number in the distribution
operator() (public member function)

Characteristics


              returns the distribution parameters
p (public member function)
k
              gets or sets the distribution parameter object
param (public member function)
              returns the minimum potentially generated value
min (public member function)
              returns the maximum potentially generated value
max (public member function)

Non-member functions


           compares two distribution objects
operator== (function)
operator!=
           performs stream input and output on pseudo-random number distribution
operator<< (function template)
operator>>

Example


// Run this code


  #include <iostream>
  #include <iomanip>
  #include <string>
  #include <map>
  #include <random>


  int main()
  {
      std::random_device rd;
      std::mt19937 gen(rd());
      // Pat goes door-to-door selling cookies
      // At each house, there's a 75% chance that she sells one box
      // how many times will she be turned away before selling 5 boxes?
      std::negative_binomial_distribution<> d(5, 0.75);


      std::map<int, int> hist;
      for(int n=0; n<10000; ++n) {
          ++hist[d(gen)];
      }
      for(auto p : hist) {
          std::cout << p.first << ' ' << std::string(p.second/100, '*') << '\n';
      }
  }

Output:


  0 ***********************
  1 *****************************
  2 **********************
  3 *************
  4 ******
  5 ***
  6 *
  7
  8
  9
  10
  11

External links


Weisstein,_Eric_W._"Negative_Binomial_Distribution." From MathWorld--A Wolfram Web Resource.