STD::LOGNORMAL_DISTRIBUTION(3cxx)

💖 NAME 💖

std::lognormal_distribution< _RealType > — a lognormal_distribution random number distribution. This is the 3cxx manual page, bestie, and it is literally the C++ lognormal distribution template. Slay. 💅

✨ SYNOPSIS ✨

#include <random>

📦 Classes 📦

• struct param_type — the parameter-type struct, sitting here being iconic. 🫶

🌟 Public Types 🌟

• typedef _RealType result_type — the public typedef, exactly as listed.

💅 Public Member Functions 💅

• lognormal_distribution (_RealType __m, _RealType __s=_RealType(1)) — constructor with __m and __s, and __s defaults to _RealType(1).
• lognormal_distribution (const param_type &__p) — constructor from a param_type.
• template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng) — one of the __generate helpers; no extra description on the page, so here is the exact signature.
• template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — another __generate helper, this time with a param_type.
• template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — the pointer-range __generate helper, listed with no extra prose.
• _RealType m () const — the m() member function, exact signature, no extra note.
• 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) — same generating-function energy, but with an explicit param_type; no extra description given here.
• 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 stuff; the full note shows up later, bestie.
• _RealType s () const — the s() member function, exact signature, no extra note.

🫶 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

🌸 Member Typedef Documentation 🌸

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

The type of the range of the distribution.

🎀 Member Function Documentation 🎀

• template<typename _RealType = double> result_type std::lognormal_distribution< _RealType >::max () const [inline] — Returns the least upper bound value of the distribution. References std::numeric_limits< _Tp >::max().
• template<typename _RealType = double> result_type std::lognormal_distribution< _RealType >::min () const [inline] — Returns the greatest lower bound value of the distribution.
• template<typename _RealType = double> template<typename _UniformRandomNumberGenerator > result_type std::lognormal_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng) [inline] — Generating functions. References std::lognormal_distribution< _RealType >::operator()(). Referenced by std::lognormal_distribution< _RealType >::operator()().
• template<typename _RealType = double> param_type std::lognormal_distribution< _RealType >::param () const [inline] — Returns the parameter set of the distribution.
• template<typename _RealType = double> void std::lognormal_distribution< _RealType >::param (const param_type & __param) [inline] — Sets the parameter set of the distribution.
  • __param — The new parameter set of the distribution.
• template<typename _RealType = double> void std::lognormal_distribution< _RealType >::reset () [inline] — Resets the distribution state. References std::normal_distribution< _RealType >::reset().

🌈 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::lognormal_distribution< _RealType1 > & __x) [friend] — Inserts a lognormal_distribution random number distribution __x into the output stream __os.
  • __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.
• template<typename _RealType = double> bool operator== (const lognormal_distribution< _RealType > & __d1, const lognormal_distribution< _RealType > & __d2) [friend] — Return true if two lognormal 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::lognormal_distribution< _RealType1 > & __x) [friend] — Extracts a lognormal_distribution random number distribution __x from the input stream __is.
  • __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.

---

Okay that is the whole page, bestie 💖 The footer's source/version situation is libststd::lognormal_...on< _RealType >(3cxx), and there is literally no date printed on it, so I am not inventing one. Bye! 🌈✨