libstdc++
std::exponential_distribution< _RealType > Class Template Reference

List of all members.

Classes

Public Types

Public Member Functions


Detailed Description

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

An exponential continuous distribution for random numbers.

The formula for the exponential probability density function is $p(x|\lambda) = \lambda e^{-\lambda x}$.

Distribution Statistics
Mean$\frac{1}{\lambda}$
Median$\frac{\ln 2}{\lambda}$
Mode$zero$
Range$[0, \infty]$
Standard Deviation$\frac{1}{\lambda}$

Definition at line 4152 of file random.h.


Member Typedef Documentation

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

The type of the range of the distribution.

Definition at line 4159 of file random.h.


Constructor & Destructor Documentation

template<typename _RealType = double>
std::exponential_distribution< _RealType >::exponential_distribution ( const result_type __lambda = result_type(1)) [inline, explicit]

Constructs an exponential distribution with inverse scale parameter $\lambda$.

Definition at line 4190 of file random.h.


Member Function Documentation

template<typename _RealType = double>
_RealType std::exponential_distribution< _RealType >::lambda ( ) const [inline]

Returns the inverse scale parameter of the distribution.

Definition at line 4211 of file random.h.

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

Returns the least upper bound value of the distribution.

Definition at line 4240 of file random.h.

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

Returns the greatest lower bound value of the distribution.

Definition at line 4233 of file random.h.

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

Returns the parameter set of the distribution.

Definition at line 4218 of file random.h.

Referenced by std::exponential_distribution< _RealType >::operator()(), std::operator==(), and std::operator>>().

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

Sets the parameter set of the distribution.

Parameters:
__paramThe new parameter set of the distribution.

Definition at line 4226 of file random.h.

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

Resets the distribution state.

Has no effect on exponential distributions.

Definition at line 4205 of file random.h.


The documentation for this class was generated from the following file: