STD::NORMAL_DISTRIBUTION(3)

💖 std::normal_distribution< _RealType > 💖

okay bestie, sit down, hydrate, because today we're talking about a normal continuous distribution for random numbers from the C++ standard library — and it's literally one of the most iconic little guys in <random>. this is part of the Library Functions Manual, and no cap, it's giving statistics class but make it slay. 🦋

---

✨ NAME ✨

std::normal_distribution< _RealType > — a normal continuous distribution for random numbers. that's it, that's the vibe. 🌸

---

✨ SYNOPSIS ✨

#include <random>

🎀 Classes

• struct param_type

🎀 Public Types

• typedef _RealType result_type

🎀 Public Member Functions

• normal_distribution (const param_type &__p)
• normal_distribution (result_type __mean, result_type __stddev=result_type(1))
• 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)
• result_type max () const — returns the least upper bound value of the distribution. 💅
• _RealType mean () const — returns the mean 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 () — resets the distribution state. 🔄
• _RealType stddev () const — returns the standard deviation of the distribution.

🎀 Friends

• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::normal_distribution< _RealType1 > &__x) — inserts a normal_distribution random number distribution __x into the output stream __os. 🫶
• template<typename _RealType1> bool operator== (const std::normal_distribution< _RealType1 > &__d1, const std::normal_distribution< _RealType1 > &__d2) — return true if two normal distributions have the same parameters and the sequences that would be generated are equal. equality, but make it thorough.
• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::normal_distribution< _RealType1 > &__x) — extracts a normal_distribution random number distribution __x from the input stream __is. 🙈

---

✨ Detailed Description ✨

template<typename _RealType = double>
    class std::normal_distribution< _RealType >

"A normal continuous distribution for random numbers.

The formula for the normal probability density function is

p(x|,ma) = ac{1}{ma t{2 i}}
           e^{- ac{{x - }^ {2}}{2 ma ^ {2}} } ]

Since

• C++11

---

✨ Member Typedef Documentation ✨

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

the type of the range of the distribution. iykyk. 💜

---

✨ Constructor & Destructor Documentation ✨

template<typename _RealType = double> std::normal_distribution< _RealType
    >::normal_distribution (result_type __mean, result_type __stddev =
    result_type(1)) [inline],  [explicit]

constructs a normal distribution with parameters $mean$ and standard deviation. periodt. 👑

---

✨ Member Function Documentation ✨

template<typename _RealType = double> result_type std::normal_distribution<
    _RealType >::max () const [inline]

returns the least upper bound value of the distribution.

---

template<typename _RealType = double> _RealType std::normal_distribution<
    _RealType >::mean () const [inline]

returns the mean of the distribution.

---

template<typename _RealType = double> result_type std::normal_distribution<
    _RealType >::min () const [inline]

returns the greatest lower bound value of the distribution.

---

template<typename _RealType = double> template<typename
    _UniformRandomNumberGenerator> result_type std::normal_distribution<
    _RealType >::operator() (_UniformRandomNumberGenerator & __urng)
    [inline]

generating functions.

referenced by operator()().

---

template<typename _RealType> template<typename
    _UniformRandomNumberGenerator> normal_distribution< _RealType
    >::result_type std::normal_distribution< _RealType >::operator()
    (_UniformRandomNumberGenerator & __urng, const param_type & __param)

polar method due to Marsaglia. 🧚

Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag, New York, 1986, Ch. V, Sect. 4.4.

references std::log(), and std::sqrt().

---

template<typename _RealType = double> param_type std::normal_distribution<
    _RealType >::param () const [inline]

returns the parameter set of the distribution.

---

template<typename _RealType = double> void std::normal_distribution<
    _RealType >::param (const param_type & __param) [inline]

sets the parameter set of the distribution.

Parameters

• __param — the new parameter set of the distribution.

---

template<typename _RealType = double> void std::normal_distribution<
    _RealType >::reset () [inline]

resets the distribution state.

---

template<typename _RealType = double> _RealType std::normal_distribution<
    _RealType >::stddev () const [inline]

returns the standard deviation of the distribution.

---

✨ Friends And Related Symbol Documentation ✨

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::normal_distribution< _RealType1 > & __x) [friend]

inserts a normal_distribution random number distribution __x into the output stream __os.

Parameters

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

Returns

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

---

template<typename _RealType = double> template<typename _RealType1> bool
    operator== (const std::normal_distribution< _RealType1 > & __d1, const
    std::normal_distribution< _RealType1 > & __d2) [friend]

return true if two normal distributions have the same parameters and the sequences that would be generated are equal.

---

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

extracts a normal_distribution random number distribution __x from the input stream __is.

Parameters

• __is — an input stream.
• __x — a normal_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. 💀 the robots wrote it, not me — I just gave it a glow-up.

---

🫶 okay that's the whole page bestie, go forth and generate your gaussian noise with main character energy. no cap, you ate. 💅

libstdc++ · std::normal_distribution< _RealType >(3) — Library Functions Manual. mwah, stan the standard library. 💖✨🎀