STD::LOGNORMAL_DISTRIBUTION(3)

💖 NAME 💖

std::lognormal_distribution< _RealType > — okay so it's a lognormal_distribution random number distribution. That's the whole name, bestie, and it's giving exactly what it says on the tin. ✨

Coming at you live from the Library Functions Manual, no cap. 💅

---

✨ SYNOPSIS ✨

#include <random>

🎀 Classes 🎀

• struct param_type — yes, the param bag, we love her.

🦋 Public Types 🦋

• typedef _RealType result_type

👑 Public Member Functions 👑

• lognormal_distribution (_RealType __m, _RealType __s=_RealType(1)) — build one of these with __m and __s, and if you ghost the __s it just defaults to _RealType(1).
• lognormal_distribution (const param_type &__p) — same energy, but you're handing over a whole param_type instead.
• 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)
• _RealType m () const
• 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 ()
• _RealType s () const

🫶 Friends 🫶

• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::lognormal_distribution< _RealType1 > &__x) — Inserts a lognormal_distribution random number distribution __x into the output stream __os.
• bool operator== (const lognormal_distribution &__d1, const lognormal_distribution &__d2) — Return true if two lognormal distributions have the same parameters and the sequences that would be generated are equal.
• template<typename _RealType1, typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::lognormal_distribution< _RealType1 > &__x) — Extracts a lognormal_distribution random number distribution __x from the input stream __is.

---

🌈 Detailed Description 🌈

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

"A lognormal_distribution random number distribution.

The formula for the normal probability mass function is:

p(x|m,s) = ac{1}{sxt{2i}}
               \xp{-ac{(x} - m)^2}{2s^2}} ]

Since C++11 — she's been iconic for a minute, fr fr. 🎀

---

💜 Member Typedef Documentation 💜

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

The type of the range of the distribution. That's the vibe check on what comes out. ✨

---

💖 Member Function Documentation 💖

🌸 max () const [inline]

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

Returns the least upper bound value of the distribution.

🌸 min () const [inline]

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

Returns the greatest lower bound value of the distribution.

🌸 operator() (_UniformRandomNumberGenerator & __urng) [inline]

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

Generating functions.

Referenced by operator()().

🌸 param () const [inline]

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

Returns the parameter set of the distribution.

🌸 param (const param_type & __param) [inline]

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

Sets the parameter set of the distribution.

Parameters

• __param — The new parameter set of the distribution.

🌸 reset () [inline]

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

Resets the distribution state. Fresh start, main character energy. 🦋

---

🫶 Friends And Related Symbol Documentation 🫶

⭐ operator<< [friend]

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::lognormal_distribution< _RealType1 > & __x)

Inserts a lognormal_distribution random number distribution __x into the output stream __os.

Parameters

• __os — An output stream.
• __x — A lognormal_distribution random number distribution.

Returns

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

⭐ operator== [friend]

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

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

⭐ operator>> [friend]

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

Extracts a lognormal_distribution random number distribution __x from the input stream __is.

Parameters

• __is — An input stream.
• __x — A lognormal_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. Not me writing a single line by hand, and honestly? Slay. 💅

---

That's the whole page, bestie — straight out of the libstdc++ docs, filed under std::logno...RealType >(3). Go forth and generate, no cap. 🦋✨💖