Class template student_t

Class template student_t_distribution

boost::random::student_t_distribution

Synopsis

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

template<typename RealType> 
class student_t_distribution {
public:
  // types
  typedef  ;
  typedef  ; 

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef  ;

    // construct/copy/destruct
    ( = );

    // public member functions
     () ;

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

  // construct/copy/destruct
  ( = );
  (param_type &);

  // public member functions
  template<typename URNG>  ();
  template<typename URNG> 
     (, param_type &) ;
   () ;
   () ;
   () ;
  param_type () ;
   (param_type &);
   ();

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

Description

The Student t distribution is a real valued distribution with one parameter n, the number of degrees of freedom.

It has .

`student_t_distribution` public construct/copy/destruct

```
( n = );
```
Constructs an student_t_distribution with "n" degrees of freedom.

Requires: n > 0
```
(param_type & param);
```
Constructs an student_t_distribution from its parameters.

`student_t_distribution` public member functions

```
template<typename URNG>  ( urng);
```
Returns a random variate distributed according to the Student t distribution.
```
template<typename URNG> 
   ( urng, param_type & param) ;
```
Returns a random variate distributed accordint to the Student t distribution with parameters specified by param.
```
 () ;
```
Returns the number of degrees of freedom.
```
 () ;
```
Returns the smallest value that the distribution can produce.
```
 () ;
```
Returns the largest value that the distribution can produce.
```
param_type () ;
```
Returns the parameters of the distribution.
```
 (param_type & param);
```
Sets the parameters of the distribution.
```
 ();
```
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

`student_t_distribution` friend functions

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

Writes a student_t_distribution to a std::ostream.

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

Reads a student_t_distribution from a std::istream.

```
 ( lhs, 
                 rhs);
```
Returns true if the two instances of student_t_distribution will return identical sequences of values given equal generators.
```
 ( lhs, 
                 rhs);
```
Returns true if the two instances of student_t_distribution will return different sequences of values given equal generators.

Class template student_t_distribution

Synopsis

Description

student_t_distribution public construct/copy/destruct

student_t_distribution public member functions

student_t_distribution friend functions

`student_t_distribution` public construct/copy/destruct

`student_t_distribution` public member functions

`student_t_distribution` friend functions