std::piecewise_constant_distribution

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions

Mathematical special functions (C++17)

Mathematical constants (C++20)

Floating-point environment (C++11)

Complex numbers

Numeric arrays

Pseudo-random number generation

Factor operations

gcd (C++17)

lcm (C++17)

Interpolations

midpoint (C++20)

lerp (C++20)

Generic numeric operations

iota (C++11)

ranges::iota (C++23)

accumulate

inner_product

adjacent_difference

partial_sum

reduce (C++17)

transform_reduce (C++17)

inclusive_scan (C++17)

exclusive_scan (C++17)

transform_inclusive_scan (C++17)

transform_exclusive_scan (C++17)

Bit operations

bit_cast (C++20)

byteswap (C++23)

has_single_bit (C++20)

bit_ceil (C++20)

bit_floor (C++20)

bit_width (C++20)

rotl (C++20)

rotr (C++20)

countl_zero (C++20)

countl_one (C++20)

countr_zero (C++20)

countr_one (C++20)

popcount (C++20)

endian (C++20)

 

Pseudo-random number generation

Uniform random bit generators

uniform_random_bit_generator (C++20)

Engines and engine adaptors

linear_congruential_engine (C++11)

mersenne_twister_engine (C++11)

subtract_with_carry_engine (C++11)

discard_block_engine (C++11)

independent_bits_engine (C++11)

shuffle_order_engine (C++11)

Non-deterministic generator

random_device (C++11)

Distributions

Uniform distributions

uniform_int_distribution (C++11)

uniform_real_distribution (C++11)

generate_canonical (C++11)

Bernoulli distributions

bernoulli_distribution (C++11)

binomial_distribution (C++11)

negative_binomial_distribution (C++11)

geometric_distribution (C++11)

Poisson distributions

poisson_distribution (C++11)

exponential_distribution (C++11)

gamma_distribution (C++11)

weibull_distribution (C++11)

extreme_value_distribution (C++11)

Normal distributions

normal_distribution (C++11)

lognormal_distribution (C++11)

chi_squared_distribution (C++11)

cauchy_distribution (C++11)

fisher_f_distribution (C++11)

student_t_distribution (C++11)

Sampling distributions

discrete_distribution (C++11)

piecewise_constant_distribution (C++11)

piecewise_linear_distribution (C++11)

Seed Sequences

seed_seq (C++11)

C library

rand

srand

RAND_MAX

 

std::piecewise_constant_distribution

Member functions

piecewise_constant_distribution::piecewise_constant_distribution (C++11)

piecewise_constant_distribution::reset (C++11)

Generation

piecewise_constant_distribution::operator() (C++11)

Characteristics

piecewise_constant_distribution::intervalspiecewise_constant_distribution::densities (C++11)(C++11)

piecewise_constant_distribution::param (C++11)

piecewise_constant_distribution::min (C++11)

piecewise_constant_distribution::max (C++11)

Non-member functions

operator==operator!= (C++11)(C++11)(until C++20)

operator<<operator>> (C++11)(C++11)

 

Defined in header <random>
template< class RealType = double > class piecewise_constant_distribution;		(since C++11)

std::piecewise_constant_distribution produces random floating-point numbers, which are uniformly distributed within each of the several subintervals [b
i, b
i+1), each with its own weight w
i. The set of interval boundaries and the set of weights are the parameters of this distribution.

The probability density for any b
i≤x<b
i+1 is

w i

S (b i+1 - b i)

. where S is the sum of all weights.

std::piecewise_constant_distribution satisfies all requirements of RandomNumberDistribution

Template parameters

RealType

-

The result type generated by the generator. The effect is undefined if this is not one of float, double, or long double.

Member types

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

Member functions

(constructor) (C++11)	constructs new distribution (public member function)
reset (C++11)	resets the internal state of the distribution (public member function)
Generation
operator() (C++11)	generates the next random number in the distribution (public member function)
Characteristics
intervalsdensities	returns the distribution parameters (public member function)
param (C++11)	gets or sets the distribution parameter object (public member function)
min (C++11)	returns the minimum potentially generated value (public member function)
max (C++11)	returns the maximum potentially generated value (public member function)

Non-member functions

operator==operator!= (C++11)(C++11)(removed in C++20)	compares two distribution objects (function)
operator<<operator>> (C++11)	performs stream input and output on pseudo-random number distribution (function template)

Example

Run this code

#include <iostream>
#include <string>
#include <map>
#include <random>
 
int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    // 50% of the time, generate a random number between 0 and 1
    // 50% of the time, generate a random number between 10 and 15
    std::vector<double> i{0,  1, 10, 15};
    std::vector<double> w{  1,  0,  1  };
    std::piecewise_constant_distribution<> d(i.begin(), i.end(), w.begin());
 
    std::map<int, int> hist;
    for(int n=0; n<10000; ++n) {
        ++hist[d(gen)];
    }
    for(auto p : hist) {
        std::cout << std::hex << std::uppercase << p.first << ' '
                  << std::string(p.second/100, '*') << '\n';
    }
}

Possible output:

0 **************************************************
A **********
B *********
C *********
D **********
E *********

References

• C++20 standard (ISO/IEC 14882:2020):

• 29.6.9.6.2 Class template piecewise_constant_distribution [rand.dist.samp.pconst] (p: 1207-1208)

• C++17 standard (ISO/IEC 14882:2017):

• 29.6.8.6.2 Class template piecewise_constant_distribution [rand.dist.samp.pconst] (p: 1098-1100)

• C++14 standard (ISO/IEC 14882:2014):

• 26.5.8.6.2 Class template piecewise_constant_distribution [rand.dist.samp.pconst] (p: 962-964)

• C++11 standard (ISO/IEC 14882:2011):

• 26.5.8.6.2 Class template piecewise_constant_distribution [rand.dist.samp.pconst] (p: 955-957)