.TH "std::exponential_distribution< _RealType >" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::exponential_distribution< _RealType > \- An exponential continuous distribution for random numbers\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBparam_type\fP"
.br
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef _RealType \fBresult_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBexponential_distribution\fP ()"
.br
.RI "Constructs an exponential distribution with inverse scale parameter 1\&.0\&. "
.ti -1c
.RI "\fBexponential_distribution\fP (_RealType __lambda)"
.br
.RI "Constructs an exponential distribution with inverse scale parameter $\lambda$\&. "
.ti -1c
.RI "\fBexponential_distribution\fP (const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)"
.br
.ti -1c
.RI "template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > void \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "_RealType \fBlambda\fP () const"
.br
.RI "Returns the inverse scale parameter of the distribution\&. "
.ti -1c
.RI "\fBresult_type\fP \fBmax\fP () const"
.br
.RI "Returns the least upper bound value of the distribution\&. "
.ti -1c
.RI "\fBresult_type\fP \fBmin\fP () const"
.br
.RI "Returns the greatest lower bound value of the distribution\&. "
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng)"
.br
.RI "Generating functions\&. "
.ti -1c
.RI "template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBparam_type\fP \fBparam\fP () const"
.br
.RI "Returns the parameter set of the distribution\&. "
.ti -1c
.RI "void \fBparam\fP (const \fBparam_type\fP &__param)"
.br
.RI "Sets the parameter set of the distribution\&. "
.ti -1c
.RI "void \fBreset\fP ()"
.br
.RI "Resets the distribution state\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "bool \fBoperator==\fP (const \fBexponential_distribution\fP &__d1, const \fBexponential_distribution\fP &__d2)"
.br
.RI "Return true if two exponential distributions have the same parameters\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename _RealType = double>
.br
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}$\&.
.PP
Distribution StatisticsMean$\frac{1}{\lambda}$ Median$\frac{\ln 2}{\lambda}$ Mode$zero$ Range$[0, \infty]$ Standard Deviation$\frac{1}{\lambda}$ 
.PP
Definition at line 4647 of file random\&.h\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _RealType  = double> typedef _RealType \fBstd::exponential_distribution\fP< _RealType >::\fBresult_type\fP"
The type of the range of the distribution\&. 
.PP
Definition at line 4654 of file random\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _RealType  = double> \fBstd::exponential_distribution\fP< _RealType >::\fBexponential_distribution\fP ()\fC [inline]\fP"

.PP
Constructs an exponential distribution with inverse scale parameter 1\&.0\&. 
.PP
Definition at line 4691 of file random\&.h\&.
.SS "template<typename _RealType  = double> \fBstd::exponential_distribution\fP< _RealType >::\fBexponential_distribution\fP (_RealType __lambda)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Constructs an exponential distribution with inverse scale parameter $\lambda$\&. 
.PP
Definition at line 4698 of file random\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _RealType  = double> _RealType \fBstd::exponential_distribution\fP< _RealType >::lambda () const\fC [inline]\fP"

.PP
Returns the inverse scale parameter of the distribution\&. 
.PP
Definition at line 4719 of file random\&.h\&.
.SS "template<typename _RealType  = double> \fBresult_type\fP \fBstd::exponential_distribution\fP< _RealType >::max () const\fC [inline]\fP"

.PP
Returns the least upper bound value of the distribution\&. 
.PP
Definition at line 4748 of file random\&.h\&.
.PP
References std::numeric_limits< _Tp >::max()\&.
.SS "template<typename _RealType  = double> \fBresult_type\fP \fBstd::exponential_distribution\fP< _RealType >::min () const\fC [inline]\fP"

.PP
Returns the greatest lower bound value of the distribution\&. 
.PP
Definition at line 4741 of file random\&.h\&.
.SS "template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > \fBresult_type\fP \fBstd::exponential_distribution\fP< _RealType >::operator() (_UniformRandomNumberGenerator & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
Definition at line 4756 of file random\&.h\&.
.SS "template<typename _RealType  = double> \fBparam_type\fP \fBstd::exponential_distribution\fP< _RealType >::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.PP
Definition at line 4726 of file random\&.h\&.
.PP
Referenced by std::operator>>()\&.
.SS "template<typename _RealType  = double> void \fBstd::exponential_distribution\fP< _RealType >::param (const \fBparam_type\fP & __param)\fC [inline]\fP"

.PP
Sets the parameter set of the distribution\&. 
.PP
\fBParameters\fP
.RS 4
\fI__param\fP The new parameter set of the distribution\&. 
.RE
.PP

.PP
Definition at line 4734 of file random\&.h\&.
.SS "template<typename _RealType  = double> void \fBstd::exponential_distribution\fP< _RealType >::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. Has no effect on exponential distributions\&. 
.PP
Definition at line 4713 of file random\&.h\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "template<typename _RealType  = double> bool operator== (const \fBexponential_distribution\fP< _RealType > & __d1, const \fBexponential_distribution\fP< _RealType > & __d2)\fC [friend]\fP"

.PP
Return true if two exponential distributions have the same parameters\&. 
.PP
Definition at line 4796 of file random\&.h\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.