std::piecewise_linear_distribution

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

Numerics library

Common mathematical functions

Special mathematical functions

Floating-point environment (C++11)

Complex numbers

Numeric arrays

Pseudo-random number generation

Compile-time rational arithmetic (C++11)

Numeric algorithms

gcd (C++17)

lcm (C++17)

Generic numeric operations

iota (C++11)

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)

ispow2 (C++20)

ceil2 (C++20)

floor2 (C++20)

log2p1 (C++20)

Pseudo-random number generation

Uniform random bit generators

UniformRandomBitGenerator (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_linear_distribution

Member functions

piecewise_linear_distribution::piecewise_linear_distribution

piecewise_linear_distribution::reset

Generation

piecewise_linear_distribution::operator()

Characteristics

piecewise_linear_distribution::intervalspiecewise_linear_distribution::densities

piecewise_linear_distribution::param

piecewise_linear_distribution::min

piecewise_linear_distribution::max

Non-member functions

operator==operator!=

operator<<operator>>

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

std::piecewise_linear_distribution produces random floating-point numbers, which are distributed according to a linear probability density function within each of the several subintervals [b
i, b
i+1). The distribution is such that the probability density at each interval boundary is exactly the predefined value p
i.

The probability density for any b
ix<b
i+1 is p
i

b i+1-x

b i+1-b i

+ p
i+1

x-b i

b i+1-b i

, where probability densities at interval boundaries p
k are calculated as w
k/S where S is the sum of all

1

2

(w
k+w
k+1)(b
k+1b
k).

The set of interval boundaries b
i and the set of weights at boundaries w
i are the parameters of this distribution.

std::piecewise_linear_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	the type of the parameter set, see RandomNumberDistribution.

Member functions

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

Non-member functions

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

Example

Run this code

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

int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    // increase the probability from 0 to 5
    // remain flat from 5 to 10
    // decrease from 10 to 15 at the same rate
    std::vector<double> i{0, 5, 10, 15};
    std::vector<double> w{0, 1,   1, 0};
    std::piecewise_linear_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::setw(2) << std::setfill('0') << p.first << ' '
            << std::string(p.second/100,'*') << '\n';
    }
}

Possible output:

00 *
01 ***
02 ****
03 ******
04 *********
05 *********
06 *********
07 **********
08 *********
09 **********
10 *********
11 *******
12 ****
13 ***
14 *