Class param_type

Boost C++ Libraries

Class param_type

boost::random::student_t_distribution::param_type

Synopsis

// In header: <boost/random/student_t_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

```
( n = );
```
Constructs a param_type with "n" degrees of freedom.

Requires: n > 0
```
 () ;
```
Returns the number of degrees of freedom 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 the different.