.TH "std::normal_distribution< _RealType >" 3cxx "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::normal_distribution< _RealType > \- A normal continuous distribution for random numbers\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <random\&.h>\fP
.SS "Classes"

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

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

.in +1c
.ti -1c
.RI "\fBnormal_distribution\fP (\fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBnormal_distribution\fP (\fBresult_type\fP \fB__mean\fP, \fBresult_type\fP \fB__stddev\fP=\fBresult_type\fP(1))"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBresult_type\fP \fBmax\fP () \fBconst\fP"
.br
.RI "Returns the least upper bound value of the distribution\&. "
.ti -1c
.RI "_RealType \fBmean\fP () \fBconst\fP"
.br
.RI "Returns the mean of the distribution\&. "
.ti -1c
.RI "\fBresult_type\fP \fBmin\fP () \fBconst\fP"
.br
.RI "Returns the greatest lower bound value of the distribution\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)"
.br
.RI "Generating functions\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)"
.br
.ti -1c
.RI "\fBparam_type\fP \fBparam\fP () \fBconst\fP"
.br
.RI "Returns the parameter set of the distribution\&. "
.ti -1c
.RI "\fBvoid\fP \fBparam\fP (\fBconst\fP \fBparam_type\fP &\fB__param\fP)"
.br
.RI "Sets the parameter set of the distribution\&. "
.ti -1c
.RI "\fBvoid\fP \fBreset\fP ()"
.br
.RI "Resets the distribution state\&. "
.ti -1c
.RI "_RealType \fBstddev\fP () \fBconst\fP"
.br
.RI "Returns the standard deviation of the distribution\&. "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &\fB__os\fP, \fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > &__x)"
.br
.RI "Inserts a normal_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_RealType1\fP > bool \fBoperator==\fP (\fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > &\fB__d1\fP, \fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > &\fB__d2\fP)"
.br
.RI "Return true if two normal distributions have the same parameters and the sequences that would be generated are equal\&. "
.ti -1c
.RI "template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &\fB__is\fP, \fBstd::normal_distribution\fP< \fB_RealType1\fP > &__x)"
.br
.RI "Extracts a normal_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<\fBtypename\fP _RealType = double>
.br
class std::normal_distribution< _RealType >"A normal continuous distribution for random numbers\&. 

The formula for the normal probability density function is  \[
    p(x|\mu,\sigma) = \frac{1}{\sigma \sqrt{2 \pi}}
           e^{- \frac{{x - \mu}^ {2}}{2 \sigma ^ {2}} } 
\] 
.SH "Member Typedef Documentation"
.PP 
.SS "template<\fBtypename\fP _RealType  = double> \fBtypedef\fP _RealType \fBstd::normal_distribution\fP< _RealType >::result_type"
The type of the range of the distribution\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<\fBtypename\fP _RealType  = double> \fBstd::normal_distribution\fP< _RealType >::normal_distribution (\fBresult_type\fP __mean, \fBresult_type\fP __stddev = \fC\fBresult_type\fP(1)\fP)\fC [inline]\fP, \fC [explicit]\fP"
Constructs a normal distribution with parameters $mean$ and standard deviation\&. 
.SH "Member Function Documentation"
.PP 
.SS "template<\fBtypename\fP _RealType  = double> \fBresult_type\fP \fBstd::normal_distribution\fP< _RealType >::max () const\fC [inline]\fP"

.PP
Returns the least upper bound value of the distribution\&. 
.PP
References \fBstd::numeric_limits< _Tp >::max()\fP\&.
.SS "template<\fBtypename\fP _RealType  = double> _RealType \fBstd::normal_distribution\fP< _RealType >::mean () const\fC [inline]\fP"

.PP
Returns the mean of the distribution\&. 
.SS "template<\fBtypename\fP _RealType  = double> \fBresult_type\fP \fBstd::normal_distribution\fP< _RealType >::min () const\fC [inline]\fP"

.PP
Returns the greatest lower bound value of the distribution\&. 
.PP
References \fBstd::numeric_limits< _Tp >::lowest()\fP\&.
.SS "template<\fBtypename\fP _RealType  = double> template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBstd::normal_distribution\fP< _RealType >::operator() (\fB_UniformRandomNumberGenerator\fP & __urng)\fC [inline]\fP"

.PP
Generating functions\&. 
.PP
References \fBstd::normal_distribution< _RealType >::operator()()\fP\&.
.PP
Referenced by \fBstd::normal_distribution< _RealType >::operator()()\fP\&.
.SS "template<\fBtypename\fP _RealType > template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBnormal_distribution\fP< _RealType >\fB::result_type\fP \fBstd::normal_distribution\fP< _RealType >::operator() (\fB_UniformRandomNumberGenerator\fP & __urng, \fBconst\fP \fBparam_type\fP & __param)"
Polar method due to Marsaglia\&.
.PP
Devroye, L\&. Non-Uniform Random Variates Generation\&. Springer-Verlag, New York, 1986, Ch\&. V, Sect\&. 4\&.4\&. 
.PP
References \fBstd::log()\fP, and \fBstd::sqrt()\fP\&.
.SS "template<\fBtypename\fP _RealType  = double> \fBparam_type\fP \fBstd::normal_distribution\fP< _RealType >::param () const\fC [inline]\fP"

.PP
Returns the parameter set of the distribution\&. 
.SS "template<\fBtypename\fP _RealType  = double> \fBvoid\fP \fBstd::normal_distribution\fP< _RealType >::param (\fBconst\fP \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

.SS "template<\fBtypename\fP _RealType  = double> \fBvoid\fP \fBstd::normal_distribution\fP< _RealType >::reset ()\fC [inline]\fP"

.PP
Resets the distribution state\&. 
.PP
Referenced by \fBstd::lognormal_distribution< _RealType >::reset()\fP, \fBstd::gamma_distribution< _RealType >::reset()\fP, \fBstd::student_t_distribution< _RealType >::reset()\fP, \fBstd::binomial_distribution< _IntType >::reset()\fP, and \fBstd::poisson_distribution< _IntType >::reset()\fP\&.
.SS "template<\fBtypename\fP _RealType  = double> _RealType \fBstd::normal_distribution\fP< _RealType >::stddev () const\fC [inline]\fP"

.PP
Returns the standard deviation of the distribution\&. 
.SH "Friends And Related Symbol Documentation"
.PP 
.SS "template<\fBtypename\fP _RealType  = double> template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator\fP<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, \fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > & __x)\fC [friend]\fP"

.PP
Inserts a normal_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fI__os\fP An output stream\&. 
.br
\fI__x\fP A normal_distribution random number distribution\&.
.RE
.PP
\fBReturns\fP
.RS 4
The output stream with the state of \fC__x\fP inserted or in an error state\&. 
.RE
.PP

.SS "template<\fBtypename\fP _RealType  = double> template<\fBtypename\fP \fB_RealType1\fP > bool \fBoperator\fP== (\fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > & __d1, \fBconst\fP \fBstd::normal_distribution\fP< \fB_RealType1\fP > & __d2)\fC [friend]\fP"

.PP
Return true if two normal distributions have the same parameters and the sequences that would be generated are equal\&. 
.SS "template<\fBtypename\fP _RealType  = double> template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator\fP>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::normal_distribution\fP< \fB_RealType1\fP > & __x)\fC [friend]\fP"

.PP
Extracts a normal_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fI__is\fP An input stream\&. 
.br
\fI__x\fP A normal_distribution random number generator engine\&.
.RE
.PP
\fBReturns\fP
.RS 4
The input stream with \fC__x\fP extracted or in an error state\&. 
.RE
.PP


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