Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

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 student_t_distribution ;

    // construct/copy/destruct
    ( = );

    // public member functions
     () ;

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

  // 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> 
     
    (, 
               student_t_distribution &);
  template<typename CharT, typename Traits> 
     
    (, 
               student_t_distribution &);
   (student_t_distribution &, 
                  student_t_distribution &);
   (student_t_distribution &, 
                  student_t_distribution &);
};

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

  1. ( n = );

    Constructs an student_t_distribution with "n" degrees of freedom.

    Requires: n > 0

  2. (param_type & param);

    Constructs an student_t_distribution from its parameters.

student_t_distribution public member functions

  1. template<typename URNG>  ( urng);

    Returns a random variate distributed according to the Student t distribution.

  2. template<typename URNG> 
       ( urng, param_type & param) ;

    Returns a random variate distributed accordint to the Student t distribution with parameters specified by param.

  3.  () ;

    Returns the number of degrees of freedom.

  4.  () ;

    Returns the smallest value that the distribution can produce.

  5.  () ;

    Returns the largest value that the distribution can produce.

  6. param_type () ;

    Returns the parameters of the distribution.

  7.  (param_type & param);

    Sets the parameters of the distribution.

  8.  ();

    Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

student_t_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 student_t_distribution & td);

    Writes a student_t_distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 student_t_distribution & td);

    Reads a student_t_distribution from a std::istream.

  3.  (student_t_distribution & lhs, 
                    student_t_distribution & rhs);

    Returns true if the two instances of student_t_distribution will return identical sequences of values given equal generators.

  4.  (student_t_distribution & lhs, 
                    student_t_distribution & rhs);

    Returns true if the two instances of student_t_distribution will return different sequences of values given equal generators.


PrevUpHomeNext