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

List of all members.

Classes

struct  param_type

Public Types

typedef _RealType result_type

Public Member Functions

 exponential_distribution (const result_type &__lambda=result_type(1))
 exponential_distribution (const param_type &__p)
_RealType lambda () const
result_type max () const
result_type min () const
template<typename _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator &__urng)
template<typename _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
param_type param () const
void param (const param_type &__param)
void reset ()

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}$.

<table border=1 cellpadding=10 cellspacing=0>
<caption align=top>Distribution Statistics</caption>
<tr><td>Mean</td><td> \form#22</td></tr>
<tr><td>Median</td><td> \form#23</td></tr>
<tr><td>Mode</td><td> \form#24</td></tr>
<tr><td>Range</td><td> \form#25</td></tr>
<tr><td>Standard Deviation</td><td> \form#22</td></tr>
</table>

Definition at line 4144 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 4151 of file random.h.


Constructor & Destructor Documentation

template<typename _RealType = double>
std::exponential_distribution< _RealType >::exponential_distribution ( const result_type __lambda = result_type(1))
inlineexplicit

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

Definition at line 4182 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 4203 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 4232 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 4225 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 4210 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 4218 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 4197 of file random.h.


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