Namespaces
Variants
Actions

std::geometric_distribution

From cppreference.com
< cpp‎ | numeric‎ | random
 
C++
 
Numerics library
 
Pseudo-random number generation
 
std::geometric_distribution
 
Defined in header <random>
template< class IntType = int >
class geometric_distribution;
 (since C++11)

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

P(i|p) = p · (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 1 success occurs.

std::geometric_distribution<>(p) is exactly equivalent to std::negative_binomial_distribution<>(1, p). It is also the discrete counterpart of std::exponential_distribution.

std::geometric_distribution satisfies RandomNumberDistribution.

Contents

[edit] 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.

[edit] Member types

Member type Definition
result_type (C++11) IntType
param_type (C++11) the type of the parameter set, see RandomNumberDistribution.

[edit] Member functions

(C++11)
 constructs new distribution
(public member function) [edit]
(C++11)
 resets the internal state of the distribution
(public member function) [edit]
Generation
(C++11)
 generates the next random number in the distribution
(public member function) [edit]
Characteristics
(C++11)
 returns the p distribution parameter (probability of a trial generating true)
(public member function) [edit]
(C++11)
 gets or sets the distribution parameter object
(public member function) [edit]
(C++11)
 returns the minimum potentially generated value
(public member function) [edit]
(C++11)
 returns the maximum potentially generated value
(public member function) [edit]

[edit] Non-member functions

(C++11)(C++11)(removed in C++20)
 compares two distribution objects
(function) [edit]
(C++11)
 performs stream input and output on pseudo-random number distribution
(function template) [edit]

[edit] Example

std::geometric_distribution<>(0.5) is the default and represents the number of coin tosses that are required to get heads.

Run this code
#include <iomanip>
#include <iostream>
#include <map>
#include <random>
#include <string>
 
int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
 
    std::geometric_distribution<> d;
        // same as 
        // std::negative_binomial_distribution<> d(1, 0.5):
 
    std::map<int, int> hist;
    for (int n = 0; n != 10000; ++n)
        ++hist[d(gen)];
 
    for (auto [x, y] : hist)
    {
        const char c = x < 10 ? x + '0' : x - 10 + 'a';
        std::cout << c << ' ' << std::string(y / 100, '*') << '\n';
    }
}

Possible output: 

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

[edit] External links

Weisstein, Eric W. "Geometric Distribution." From MathWorld — A Wolfram Web Resource.
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/random/geometric_distribution&oldid=160835"