std::lognormal_distribution - Man Page

A lognormal_distribution random number distribution.

Synopsis

#include <random>

Classes

struct param_type

Public Types

typedef _RealType result_type

Public Member Functions

lognormal_distribution (_RealType __m, _RealType __s=_RealType(1))
lognormal_distribution (const param_type &__p)
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}{sxsqrt{2pi}}
              \xp{-ac{(ln{x} - m)^2}{2s^2}}  ]

Definition at line 2196 of file random.

Member Typedef Documentation

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

The type of the range of the distribution.

Definition at line 2203 of file random.

Constructor & Destructor Documentation

template<typename _RealType  = double> std::lognormal_distribution< _RealType >::lognormal_distribution () [inline]

Definition at line 2238 of file random.

template<typename _RealType  = double> std::lognormal_distribution< _RealType >::lognormal_distribution (_RealType __m, _RealType __s = _RealType(1)) [inline], [explicit]

Definition at line 2241 of file random.

template<typename _RealType  = double> std::lognormal_distribution< _RealType >::lognormal_distribution (const param_type & __p) [inline], [explicit]

Definition at line 2246 of file random.

Member Function Documentation

template<typename _RealType  = double> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void std::lognormal_distribution< _RealType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng) [inline]

Definition at line 2314 of file random.

template<typename _RealType  = double> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void std::lognormal_distribution< _RealType >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]

Definition at line 2321 of file random.

template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > void std::lognormal_distribution< _RealType >::__generate (result_type * __f, result_type * __t, _UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]

Definition at line 2328 of file random.

template<typename _RealType  = double> _RealType std::lognormal_distribution< _RealType >::m () const [inline]

Definition at line 2261 of file random.

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

Returns the least upper bound value of the distribution.

Definition at line 2294 of file random.

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.

Definition at line 2287 of file random.

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

Generating functions.

Definition at line 2302 of file random.

References std::lognormal_distribution< _RealType >::operator()().

Referenced by std::lognormal_distribution< _RealType >::operator()().

template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > result_type std::lognormal_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]

Definition at line 2307 of file random.

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

Returns the parameter set of the distribution.

Definition at line 2272 of file random.

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

Sets the parameter set of the distribution.

Parameters

__param The new parameter set of the distribution.

Definition at line 2280 of file random.

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

Resets the distribution state.

Definition at line 2254 of file random.

References std::normal_distribution< _RealType >::reset().

template<typename _RealType  = double> _RealType std::lognormal_distribution< _RealType >::s () const [inline]

Definition at line 2265 of file random.

Author

Generated automatically by Doxygen for libstdc++ from the source code.

Info

Mon Nov 21 2022 libstdc++