Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template chi_squared_distribution

boost::random::chi_squared_distribution

Synopsis

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

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

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef chi_squared_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> 
     
    (, 
               chi_squared_distribution &);
  template<typename CharT, typename Traits> 
     
    (, 
               chi_squared_distribution &);
   (chi_squared_distribution &, 
                  chi_squared_distribution &);
   (chi_squared_distribution &, 
                  chi_squared_distribution &);
};

Description

The chi squared distribution is a real valued distribution with one parameter, n. The distribution produces values > 0.

The distribution function is .

chi_squared_distribution public construct/copy/destruct

  1. ( n = );

    Construct a chi_squared_distribution object. n is the parameter of the distribution.

    Requires: t >=0 && 0 <= p <= 1

  2. (param_type & param);

    Construct an chi_squared_distribution object from the parameters.

chi_squared_distribution public member functions

  1. template<typename URNG>  ( urng);

    Returns a random variate distributed according to the chi squared distribution.

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

    Returns a random variate distributed according to the chi squared distribution with parameters specified by param.

  3.  () ;

    Returns the n parameter of the distribution.

  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 parameters of the distribution.

  8.  ();

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

chi_squared_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 chi_squared_distribution & c2d);

    Writes the parameters of the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 chi_squared_distribution & c2d);

    Reads the parameters of the distribution from a std::istream.

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

    Returns true if the two distributions will produce the same sequence of values, given equal generators.

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

    Returns true if the two distributions could produce different sequences of values, given equal generators.


PrevUpHomeNext