# std::piecewise_linear_distribution

> C++ Atlas: `cppatlas.com/w/cpp/numeric/random/piecewise_linear_distribution` | Source: https://en.cppreference.com/w/cpp/numeric/random/piecewise_linear_distribution | Domain: Numerics | Standards: C++11, C++20

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 [bi, bi+1).

## Official Specification Summary (cppreference)

```cpp
// 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ⁱ, bⁱ⁺¹). The distribution is such that the probability density at each interval boundary is exactly the predefined value pⁱ.

The probability density for any

bⁱ≤x\<bⁱ⁺¹

is

pⁱ bⁱ⁺¹-x
bⁱ⁺¹-bⁱ + pⁱ⁺¹ x-bⁱ
bⁱ⁺¹-bⁱ

, 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+1)−b^(k))

.

The set of interval boundaries bⁱ and the set of weights at boundaries wⁱ 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` (C++11): `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**

- `intervals` (C++11), `densities`: 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==` (C++11), `operator!=` (C++11)(removed in C++20): compares two distribution objects (function)
- `operator<<` (C++11), `operator>>`: performs stream input and output on pseudo-random number distribution (function template)

### Example

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

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{}; n < 1e4; ++n)
        ++hist[d(gen)];

    for (auto [x, y] : hist)
        std::cout << std::setw(2) << std::setfill('0') << x
                  << ' ' << std::string(y / 100, '*') << '\n';
}
```

Possible output:

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

---
Attribution: content from https://en.cppreference.com/w/cpp/numeric/random/piecewise_linear_distribution (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.