Class param_type

Boost C++ Libraries

Class param_type

boost::random::generalized_inverse_gaussian_distribution::param_type

Synopsis

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



class param_type {
public:
  // types
  typedef  ;

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

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

Description

`param_type` public member functions

```
( p = ,  a = ,  b = );
```
Constructs a param_type object from the "p", "a", and "b" parameters.

Requires: a > 0 && b >= 0 if p > 0, a > 0 && b > 0 if p == 0, a >= 0 && b > 0 if p < 0
```
 () ;
```
Returns the "p" parameter of the distribution.
```
 () ;
```
Returns the "a" parameter of the distribution.
```
 () ;
```
Returns the "b" parameter of the distribution.

`param_type` friend functions

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

Writes a param_type to a std::ostream.

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

Reads a param_type from a std::istream.

```
 ( lhs,  rhs);
```
Returns true if the two sets of parameters are the same.
```
 ( lhs,  rhs);
```
Returns true if the two sets of parameters are different.