STD::PIECEWISE_LINEAR_DISTRIBUTION(3)

✨ NAME ✨

std::piecewise_linear_distribution< _RealType > — a piecewise_linear_distribution random number distribution. That's the whole vibe, bestie 🎀

This little icon lives in the Library Functions Manual, and it's genuinely one of the cutest corners of <random>. Let's get into it 💅

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull the header in:

#include <random>

💖 Classes 💖

• struct param_type

💖 Public Types 💖

• typedef _RealType result_type

💖 Public Member Functions 💖

the constructors, okay, there are four of them and they all hit different:

• template<typename _InputIteratorB, typename _InputIteratorW> piecewise_linear_distribution (_InputIteratorB __bfirst, _InputIteratorB __bend, _InputIteratorW __wbegin)
• piecewise_linear_distribution (const param_type &__p)
• template<typename _Func> piecewise_linear_distribution (initializer_list< _RealType > __bl, _Func __fw)
• template<typename _Func> piecewise_linear_distribution (size_t __nw, _RealType __xmin, _RealType __xmax, _Func __fw)

and then the __generate crew (double underscore, yes, they're internal-ish, no we're not gatekeeping):

• template<typename _ForwardIterator, typename _UniformRandomNumberGenerator> void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
• template<typename _ForwardIterator, typename _UniformRandomNumberGenerator> void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
• template<typename _UniformRandomNumberGenerator> void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p)

the actual member functions:

• std::vector< double > densities () const — returns a vector of the probability densities of the distribution ✨
• std::vector< _RealType > intervals () const — returns the intervals of the distribution ✨
• result_type max () const — returns the least upper bound value of the distribution
• result_type min () const — returns the greatest lower bound value of the distribution
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng) — generating functions
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
• param_type param () const — returns the parameter set of the distribution
• void param (const param_type &__param) — sets the parameter set of the distribution
• void reset ()

💖 Friends 💖

• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::piecewise_linear_distribution< _RealType1 > &__x) — inserts a piecewise_linear_distribution random number distribution __x into the output stream __os
• bool operator== (const piecewise_linear_distribution &__d1, const piecewise_linear_distribution &__d2) — return true if two piecewise linear distributions have the same parameters
• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::piecewise_linear_distribution< _RealType1 > &__x) — extracts a piecewise_linear_distribution random number distribution __x from the input stream __is

---

🔥 Detailed Description 🔥

template<typename _RealType = double>
    class std::piecewise_linear_distribution< _RealType >"A
    piecewise_linear_distribution random number distribution.

okay so the detailed description here got absolutely mangled by the doc generator, and I am not going to pretend I can un-mangle math that arrived like this 😭 but here it is, exactly as the page shows it:

This distribution produces random numbers $ x, b_0 x < b_n ho_n) = distributed over each subinterval $ [b_i, b_{i+1}ho_0,c...,ing to the probability mass function $ p(x | b_0, ..., b_n, $, for $ b_i x < b_{i+1} $.

(that's the literal text on the page — the LaTeX fairies did NOT come through, bestie 💀)

Since: C++11 🫶

---

👑 Member Typedef Documentation 👑

template<typename _RealType = double>
    typedef _RealType std::piecewise_linear_distribution< _RealType >::result_type

The type of the range of the distribution. it's giving "what comes out of this thing" ✨

---

💜 Member Function Documentation 💜

densities()

template<typename _RealType = double>
    std::vector< double > std::piecewise_linear_distribution< _RealType >::densities () const

[inline] — return a vector of the probability densities of the distribution.

intervals()

template<typename _RealType = double>
    std::vector< _RealType > std::piecewise_linear_distribution< _RealType >::intervals () const

[inline] — return the intervals of the distribution.

max()

template<typename _RealType = double>
    result_type std::piecewise_linear_distribution< _RealType >::max () const

[inline] — returns the least upper bound value of the distribution.

min()

template<typename _RealType = double>
    result_type std::piecewise_linear_distribution< _RealType >::min () const

[inline] — returns the greatest lower bound value of the distribution.

operator()

template<typename _RealType = double>
    template<typename _UniformRandomNumberGenerator>
    result_type std::piecewise_linear_distribution< _RealType >::operator()
    (_UniformRandomNumberGenerator & __urng)

[inline] — generating functions.

Referenced by operator()().

param() (the getter)

template<typename _RealType = double>
    param_type std::piecewise_linear_distribution< _RealType >::param () const

[inline] — returns the parameter set of the distribution.

param() (the setter)

template<typename _RealType = double>
    void std::piecewise_linear_distribution< _RealType >::param
    (const param_type & __param)

[inline] — sets the parameter set of the distribution.

Parameters

• __param — the new parameter set of the distribution.

reset()

template<typename _RealType = double>
    void std::piecewise_linear_distribution< _RealType >::reset ()

[inline] — resets the distribution state.

---

🦋 Friends And Related Symbol Documentation 🦋

operator<<

template<typename _RealType = double>
    template<typename _RealType1, typename _CharT, typename _Traits>
    std::basic_ostream< _CharT, _Traits > &
    operator<< (std::basic_ostream< _CharT, _Traits > & __os,
                const std::piecewise_linear_distribution< _RealType1 > & __x)

[friend] — inserts a piecewise_linear_distribution random number distribution __x into the output stream __os.

Parameters

• __os — an output stream.
• __x — a piecewise_linear_distribution random number distribution.

Returns

• the output stream with the state of __x inserted, or in an error state.

operator==

template<typename _RealType = double>
    bool operator== (const piecewise_linear_distribution< _RealType > & __d1,
                     const piecewise_linear_distribution< _RealType > & __d2)

[friend] — return true if two piecewise linear distributions have the same parameters.

operator>>

template<typename _RealType = double>
    template<typename _RealType1, typename _CharT, typename _Traits>
    std::basic_istream< _CharT, _Traits > &
    operator>> (std::basic_istream< _CharT, _Traits > & __is,
                std::piecewise_linear_distribution< _RealType1 > & __x)

[friend] — extracts a piecewise_linear_distribution random number distribution __x from the input stream __is.

Parameters

• __is — an input stream.
• __x — a piecewise_linear_distribution random number generator engine.

Returns

• the input stream with __x extracted, or in an error state.

---

🌈 Author 🌈

Generated automatically by Doxygen for libstdc++ from the source code. no human wrote this one, it's a robot doing its little robot thing 🤖✨

---

and that's the page, bestie!! 💖 this whole thing came out of libstdc++ and it's the std::piece..._RealType >(3) page — icon behavior, honestly. go forth and generate, ily 🫶🎀