Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

Class param_type

boost::random::gamma_distribution::param_type

Synopsis

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



class param_type {
public:
  // types
  typedef gamma_distribution distribution_type;

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

  // public member functions
  RealType alpha() const;
  RealType beta() const;

  // friend functions
  template<typename CharT, typename Traits> 
    friend std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, const param_type &);
  template<typename CharT, typename Traits> 
    friend std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, param_type &);
  friend bool operator==(const param_type &, const param_type &);
  friend bool operator!=(const param_type &, const param_type &);
};

Description

param_type public construct/copy/destruct

  1. param_type(const RealType & alpha = 1.0, const RealType & beta = 1.0);

    Constructs a param_type object from the "alpha" and "beta" parameters.

    Requires: alpha > 0 && beta > 0

param_type public member functions

  1. RealType alpha() const;

    Returns the "alpha" parameter of the distribution.

  2. RealType beta() const;

    Returns the "beta" parameter of the distribution.

param_type friend functions

  1. template<typename CharT, typename Traits> 
      friend std::basic_ostream< CharT, Traits > & 
      operator<<(std::basic_ostream< CharT, Traits > & os, 
                 const param_type & param);

    Writes the parameters to a std::ostream.

  2. template<typename CharT, typename Traits> 
      friend std::basic_istream< CharT, Traits > & 
      operator>>(std::basic_istream< CharT, Traits > & is, param_type & param);

    Reads the parameters from a std::istream.

  3. friend bool operator==(const param_type & lhs, const param_type & rhs);

    Returns true if the two sets of parameters are the same.

  4. friend bool operator!=(const param_type & lhs, const param_type & rhs);

    Returns true if the two sets fo parameters are different.


PrevUpHomeNext