Class template normal

Class template normal_distribution

boost::normal_distribution

Synopsis

// In header: <boost/random/normal_distribution.hpp>

template<typename RealType> 
class normal_distribution {
public:
  // types
  typedef  ; 
  typedef  ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef  ;

    // construct/copy/destruct
    ( = ,  = );

    // public member functions
     () ;
     () ;

    // friend functions
    template<typename CharT, typename Traits> 
       
      (, );
    template<typename CharT, typename Traits> 
       
      (, );
     (, );
     (, );
  };

  // construct/copy/destruct
  ( = ,  = );
  (param_type &);

  // public member functions
   () ;
   () ;
   () ;
   () ;
  param_type () ;
   (param_type &);
   ();
  template<typename Engine>  ();
  template<typename URNG>  (, param_type &);

  // friend functions
  template<typename CharT, typename Traits> 
     
    (, 
               );
  template<typename CharT, typename Traits> 
     
    (, 
               );
   (, );
   (, );
};

Description

Instantiations of class template normal_distribution model a random distribution . Such a distribution produces random numbers x distributed with probability density function , where mean and sigma are the parameters of the distribution.

The implementation uses the "ziggurat" algorithm, as described in

"The Ziggurat Method for Generating Random Variables", George Marsaglia and Wai Wan Tsang, Journal of Statistical Software, Volume 5, Number 8 (2000), 1-7.

`normal_distribution` public construct/copy/destruct

```
( mean = , 
                              sigma = );
```
Constructs a normal_distribution object. mean and sigma are the parameters for the distribution.

Requires: sigma >= 0
```
(param_type & param);
```
Constructs a normal_distribution object from its parameters.

`normal_distribution` public member functions

```
 () ;
```
Returns the mean of the distribution.
```
 () ;
```
Returns the standard deviation of the distribution.
```
 () ;
```
Returns the smallest value that the distribution can produce.
```
 () ;
```
Returns the largest value that the distribution can produce.
```
param_type () ;
```
Returns the parameters of the distribution.
```
 (param_type & param);
```
Sets the parameters of the distribution.
```
 ();
```
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
```
template<typename Engine>  ( eng);
```
Returns a normal variate.

template<typename URNG> 
   ( urng, param_type & param);

Returns a normal variate with parameters specified by param.

`normal_distribution` friend functions

template<typename CharT, typename Traits> 
   
  ( os, 
              nd);

Writes a normal_distribution to a std::ostream.

template<typename CharT, typename Traits> 
   
  ( is, 
              nd);

Reads a normal_distribution from a std::istream.

```
 ( lhs, 
                 rhs);
```
Returns true if the two instances of normal_distribution will return identical sequences of values given equal generators.
```
 ( lhs, 
                 rhs);
```
Returns true if the two instances of normal_distribution will return different sequences of values given equal generators.

Class template normal_distribution

Synopsis

Description

normal_distribution public construct/copy/destruct

normal_distribution public member functions

normal_distribution friend functions

`normal_distribution` public construct/copy/destruct

`normal_distribution` public member functions

`normal_distribution` friend functions