Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/numeric/random/bernoulli distribution"

From cppreference.com
< cpp‎ | numeric‎ | random
(+ initial, several members still missing)
 
m (.)
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{cpp/title|bernoulli_distribution}}
 
{{cpp/title|bernoulli_distribution}}
−
{{cpp/numeric/random/sidebar}}
+
{{cpp/numeric/random/bernoulli_distribution/navbar}}
−
{{ddcl | header=random | notes={{mark c++11 feature}} | 1=
+
{{ddcl|header=random|since=c++11|1=
 
class bernoulli_distribution;
 
class bernoulli_distribution;
 
}}
 
}}
  
−
{{todo}}
+
Produces random boolean values, according to the discrete probability function. The probability of {{co|true}} is
 +
 
 +
:{{math|1=P(b{{!}}p) =}}{{mparen|{||{{math|p}}, if {{math|b}} is {{co|true}}|{{math|1 − p}}, if {{math|b}} is {{co|false}}|style=text-align:right}}
 +
 
 +
{{tt|std::bernoulli_distribution}} satisfies {{named req|RandomNumberDistribution}}.
  
 
===Member types===
 
===Member types===
−
{{tdcl list begin}}
+
{{dsc begin}}
−
{{tdcl list hitem | Member type | Definition}}
+
{{dsc hitem|Member type|Definition}}
−
{{tdcl list item | {{tt|result_type}} | {{cpp|bool}}}}
+
{{dsc|{{tt|result_type}} {{mark c++11}}|{{co|bool}}}}
−
{{tdcl list item | {{tt|param_type}} | the type of the parameter set, unspecified}}
+
{{cpp/numeric/random/param_type}}
−
{{tdcl list end}}
+
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list constructor | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc constructor|bernoulli_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list reset | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc reset|bernoulli_distribution}}
  
−
{{dcl list h2 | Generation}}
+
{{dsc h2|Generation}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list operator() | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator()|bernoulli_distribution}}
  
−
{{dcl list h2 | Characteristics}}
+
{{dsc h2|Characteristics}}
−
{{dcl list todo}}
+
{{dsc inc|cpp/numeric/random/bernoulli_distribution/dsc p}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list param | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc param|bernoulli_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list min | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc min|bernoulli_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list max | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc max|bernoulli_distribution}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Non-member functions===
 
===Non-member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list operator_comp | bernoulli_distribution }}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator_cmp|bernoulli_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list operator_gtgtltlt | bernoulli_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator_ltltgtgt|bernoulli_distribution}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Example===
 
===Example===
−
{{example cpp
+
{{example
−
| code=
+
|code=
−
  | output=
+
#include <iomanip>
 +
#include <iostream>
 +
#include <map>
 +
#include <random>
 +
#include <string>
 +
 
 +
int main()
 +
{
 +
    std::random_device rd;
 +
    std::mt19937 gen(rd());
 +
    // give "true" 1/4 of the time
 +
    // give "false" 3/4 of the time
 +
    std::bernoulli_distribution d(0.25);
 +
   
 +
    std::map<bool, int> hist;
 +
    for (int n = 0; n < 10000; ++n)
 +
        ++hist[d(gen)];
 +
 
 +
    std::cout << std::boolalpha;
 +
    for (auto const& [key, value] : hist)
 +
        std::cout << std::setw(5) << key << ' '
 +
                  << std::string(value / 500, '*') << '\n';
 +
}
 +
|p=true
 +
|output=
 +
false ***************
 +
true ****
 
}}
 
}}
 +
 +
===External links===
 +
{{eli|[https://mathworld.wolfram.com/BernoulliDistribution.html Weisstein, Eric W. "Bernoulli Distribution."] From MathWorld &mdash; A Wolfram Web Resource.}}
 +
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 23:26, 16 October 2023

 
C++
 
Numerics library
Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
(C++17)
(C++17)
Interpolations
(C++20)
(C++20)
Saturation arithmetic
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)

Generic numeric operations
Bit operations
(C++20)    
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++23)
(C++20)
 
Pseudo-random number generation
 
std::bernoulli_distribution
 
Defined in header <random>
class bernoulli_distribution;
 (since C++11)

Produces random boolean values, according to the discrete probability function. The probability of true is

P(b|p) =⎧
⎨
⎩p, if b is true
1 − p, if b is false

std::bernoulli_distribution satisfies RandomNumberDistribution.

Contents

[edit] Member types

Member type Definition
result_type (C++11) bool
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 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

Run this code
#include <iomanip>
#include <iostream>
#include <map>
#include <random>
#include <string>
 
int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    // give "true" 1/4 of the time
    // give "false" 3/4 of the time
    std::bernoulli_distribution d(0.25);
 
    std::map<bool, int> hist;
    for (int n = 0; n < 10000; ++n)
        ++hist[d(gen)];
 
    std::cout << std::boolalpha;
    for (auto const& [key, value] : hist)
        std::cout << std::setw(5) << key << ' '
                  << std::string(value / 500, '*') << '\n';
}

Possible output: 

false ***************
 true ****

[edit] External links

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