Class template gamma

Class template gamma_distribution

boost::random::gamma_distribution

Synopsis

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

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

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef  ;

    // public member functions
    ( = ,  = );
     () ;
     () ;

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

  // public member functions
  ( = ,  = );
  (param_type &);
   () ;
   () ;
   () ;
   () ;
  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

The gamma distribution is a continuous distribution with two parameters alpha and beta. It produces values > 0.

It has .

`gamma_distribution` public member functions

```
( alpha = , 
                             beta = );
```
Creates a new gamma_distribution with parameters "alpha" and "beta".

Requires: alpha > 0 && beta > 0
```
(param_type & param);
```
Constructs a gamma_distribution from its parameters.
```
 () ;
```
Returns the "alpha" paramter of the distribution.
```
 () ;
```
Returns the "beta" parameter of the distribution.
```
 () ;
```
Returns the smallest 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 random variate distributed according to the gamma distribution.

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

`gamma_distribution` friend functions

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

Writes a gamma_distribution to a std::ostream.

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

Reads a gamma_distribution from a std::istream.

```
 ( lhs, 
                 rhs);
```
Returns true if the two distributions will produce identical sequences of random variates given equal generators.
```
 ( lhs, 
                 rhs);
```
Returns true if the two distributions can produce different sequences of random variates, given equal generators.

Class template gamma_distribution

Synopsis

Description

gamma_distribution public member functions

gamma_distribution friend functions

`gamma_distribution` public member functions

`gamma_distribution` friend functions