Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

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 gamma_distribution ;

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

    // public member functions
     () ;
     () ;

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

  // 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> 
     
    (, 
               gamma_distribution &);
  template<typename CharT, typename Traits> 
     
    (, gamma_distribution &);
   (gamma_distribution &, gamma_distribution &);
   (gamma_distribution &, gamma_distribution &);
};

Description

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

It has .

gamma_distribution public construct/copy/destruct

  1. ( alpha = , 
                                 beta = );

    Creates a new gamma_distribution with parameters "alpha" and "beta".

    Requires: alpha > 0 && beta > 0

  2. (param_type & param);

    Constructs a gamma_distribution from its parameters.

gamma_distribution public member functions

  1.  () ;

    Returns the "alpha" paramter of the distribution.

  2.  () ;

    Returns the "beta" parameter of the distribution.

  3.  () ;

    Returns the smallest value that the distribution can produce.

  4.  () ;
  5. param_type () ;

    Returns the parameters of the distribution.

  6.  (param_type & param);

    Sets the parameters of the distribution.

  7.  ();

    Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

  8. template<typename Engine>  ( eng);

    Returns a random variate distributed according to the gamma distribution.

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

gamma_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 gamma_distribution & gd);

    Writes a gamma_distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 gamma_distribution & gd);

    Reads a gamma_distribution from a std::istream.

  3.  (gamma_distribution & lhs, 
                    gamma_distribution & rhs);

    Returns true if the two distributions will produce identical sequences of random variates given equal generators.

  4.  (gamma_distribution & lhs, 
                    gamma_distribution & rhs);

    Returns true if the two distributions can produce different sequences of random variates, given equal generators.


PrevUpHomeNext