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 = double> 
class gamma_distribution {
public:
  // types
  typedef RealType ; 
  typedef RealType ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef gamma_distribution ;

    // construct/copy/destruct
    (const RealType & = , const RealType & = );

    // public member functions
    RealType () ;
    RealType () ;

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

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

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

  // friend functions
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const gamma_distribution &);
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, gamma_distribution &);
  bool (const gamma_distribution &, const gamma_distribution &);
  bool (const gamma_distribution &, const 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. (const result_type & alpha = , 
                                const result_type & beta = );

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

    Requires: alpha > 0 && beta > 0

  2. (const param_type & param);

    Constructs a gamma_distribution from its parameters.

gamma_distribution public member functions

  1. RealType () ;

    Returns the "alpha" paramter of the distribution.

  2. RealType () ;

    Returns the "beta" parameter of the distribution.

  3. RealType () ;

    Returns the smallest value that the distribution can produce.

  4. RealType () ;
  5. param_type () ;

    Returns the parameters of the distribution.

  6. void (const param_type & param);

    Sets the parameters of the distribution.

  7. void ();

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

  8. template<typename Engine> result_type (Engine & eng);

    Returns a random variate distributed according to the gamma distribution.

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

gamma_distribution friend functions

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

    Writes a gamma_distribution to a std::ostream.

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

    Reads a gamma_distribution from a std::istream.

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

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

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

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


PrevUpHomeNext