Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template fisher_f_distribution

boost::random::fisher_f_distribution

Synopsis

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

template<typename RealType = double> 
class fisher_f_distribution {
public:
  // types
  typedef RealType ;
  typedef RealType ; 

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef fisher_f_distribution ;

    // construct/copy/destruct
    (RealType = , RealType = );

    // public member functions
    RealType () ;
    RealType () ;

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

  // construct/copy/destruct
  (RealType = , RealType = );
  (const param_type &);

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

  // friend functions
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const fisher_f_distribution &);
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, 
               const fisher_f_distribution &);
  bool (const fisher_f_distribution &, 
                  const fisher_f_distribution &);
  bool (const fisher_f_distribution &, 
                  const fisher_f_distribution &);
};

Description

The Fisher F distribution is a real valued distribution with two parameters m and n.

It has .

fisher_f_distribution public construct/copy/destruct

  1. (RealType m = , RealType n = );

    Constructs a fisher_f_distribution from its "m" and "n" parameters.

    Requires: m > 0 and n > 0

  2. (const param_type & param);

    Constructs an fisher_f_distribution from its parameters.

fisher_f_distribution public member functions

  1. template<typename URNG> RealType (URNG & urng);

    Returns a random variate distributed according to the F distribution.

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

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

  3. RealType () ;

    Returns the "m" parameter of the distribution.

  4. RealType () ;

    Returns the "n" parameter of the distribution.

  5. RealType () ;

    Returns the smallest value that the distribution can produce.

  6. RealType () ;

    Returns the largest value that the distribution can produce.

  7. param_type () ;

    Returns the parameters of the distribution.

  8. void (const param_type & param);

    Sets the parameters of the distribution.

  9. void ();

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

fisher_f_distribution friend functions

  1. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & os, 
                 const fisher_f_distribution & fd);

    Writes an fisher_f_distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
      CharT, Traits > & 
      (CharT, Traits > & is, 
                 const fisher_f_distribution & fd);

    Reads an fisher_f_distribution from a std::istream.

  3. bool (const fisher_f_distribution & lhs, 
                    const fisher_f_distribution & rhs);

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

  4. bool (const fisher_f_distribution & lhs, 
                    const fisher_f_distribution & rhs);

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


PrevUpHomeNext