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

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

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> 
    std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, const param_type &);
  template<typename CharT, typename Traits> 
    std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, param_type &);
  bool operator==(const param_type &, const param_type &);
  bool operator!=(const param_type &, const param_type &);
};

Description

`param_type` public construct/copy/destruct

```
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

```
RealType alpha() const;
```
Returns the "alpha" parameter of the distribution.
```
RealType beta() const;
```
Returns the "beta" parameter of the distribution.

`param_type` friend functions

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

Writes the parameters to a std::ostream.

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

Reads the parameters from a std::istream.

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

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

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

Returns true if the two sets fo parameters are different.