Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | numeric‎ | random
m (Text replace - "{{cpp|" to "{{c|")
m (fmt, headers sorted)
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{cpp/title|discrete_distribution}}
 
{{cpp/title|discrete_distribution}}
−
{{cpp/numeric/random/discrete_distribution/sidebar}}
+
{{cpp/numeric/random/discrete_distribution/navbar}}
−
{{ddcl | header=random | notes={{mark since c++11}} | 1=
+
{{ddcl|header=random|since=c++11|1=
 
template< class IntType = int >
 
template< class IntType = int >
 
class discrete_distribution;
 
class discrete_distribution;
 
}}
 
}}
  
−
{{tt|std::discrete_distribution}} produces random integers on the interval {{tt|[0, n)}}, where the probability of each individual integer {{tt|i}} is defined as {{math|w{{su|b=i}}/S}}, that is the ''weight'' of the {{tt|i}}th integer divided by the sum of all {{tt|n}} weights.  
+
{{tt|std::discrete_distribution}} produces random integers on the interval {{range|0|n}}, where the probability of each individual integer {{tt|i}} is defined as {{math|w{{su|b=i}}/S}}, that is the ''weight'' of the {{tt|i}}th integer divided by the sum of all {{tt|n}} weights.
 +
 
 +
{{tt|std::discrete_distribution}} satisfies all requirements of {{named req|RandomNumberDistribution}}.
 +
 
 +
===Template parameters===
 +
{{par begin}}
 +
{{cpp/numeric/random/param_list|IntType}}
 +
{{par end}}
  
 
===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}} | {{c|IntType}}}}
+
{{dsc|{{tt|result_type}} {{mark c++11}}|{{co|IntType}}}}
−
{{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 | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc constructor|discrete_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list reset | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc reset|discrete_distribution}}
  
−
{{dcl list h2 | Generation}}
+
{{dsc h2|Generation}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list operator() | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator()|discrete_distribution}}
  
−
{{dcl list h2 | Characteristics}}
+
{{dsc h2|Characteristics}}
−
{{dcl list template | cpp/numeric/random/discrete_distribution/dcl list probabilities}}
+
{{dsc inc|cpp/numeric/random/discrete_distribution/dsc probabilities}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list param | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc param|discrete_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list min | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc min|discrete_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list max | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc max|discrete_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_cmp | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator_cmp|discrete_distribution}}
−
{{dcl list template | cpp/numeric/random/distribution/dcl list operator_ltltgtgt | discrete_distribution}}
+
{{dsc inc|cpp/numeric/random/distribution/dsc operator_ltltgtgt|discrete_distribution}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Example===
 
===Example===
 
{{example
 
{{example
−
| code=
+
|code=
 +
#include <iomanip>
 
#include <iostream>
 
#include <iostream>
 
#include <map>
 
#include <map>
Line 48: Line 56:
 
     std::mt19937 gen(rd());
 
     std::mt19937 gen(rd());
 
     std::discrete_distribution<> d({40, 10, 10, 40});
 
     std::discrete_distribution<> d({40, 10, 10, 40});
−
     std::map<int, int> m;
+
     std::map<int, int> map;
−
     for(int n=0; n<10000; ++n) {
+
 
−
         ++m[d(gen)];
+
     for (int n = 0; n < 1e4; ++n)
−
    }
+
         ++map[d(gen)];
−
     for(auto p : m) {
+
 
−
         std::cout << p.first << " generated " << p.second << " times\n";
+
     for (const auto& [num, count] : map)
−
    }
+
         std::cout << num << " generated " << std::setw(4) << count << " times\n";
 
}
 
}
−
| output=
+
|p=true
−
0 generated 4028 times
+
|output=
−
1 generated 978 times
+
0 generated 4037 times
−
2 generated 1012 times
+
1 generated 962 times
−
3 generated 3982 times
+
2 generated 1030 times
 +
3 generated 3971 times
 
}}
 
}}
 +
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 07:16, 29 April 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::discrete_distribution
 
Defined in header <random>
template< class IntType = int >
class discrete_distribution;
 (since C++11)

std::discrete_distribution produces random integers on the interval [​0​, n), where the probability of each individual integer i is defined as wi/S, that is the weight of the ith integer divided by the sum of all n weights.

std::discrete_distribution satisfies all requirements of 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
obtains the list of probabilities
(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>
 
int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    std::discrete_distribution<> d({40, 10, 10, 40});
    std::map<int, int> map;
 
    for (int n = 0; n < 1e4; ++n)
        ++map[d(gen)];
 
    for (const auto& [num, count] : map)
        std::cout << num << " generated " << std::setw(4) << count << " times\n";
}

Possible output: 

0 generated 4037 times
1 generated  962 times
2 generated 1030 times
3 generated 3971 times
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/random/discrete_distribution&oldid=151165"