Class template fisher_f

Class template fisher_f_distribution

boost::random::fisher_f_distribution

Synopsis

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

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

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef  ;

    // public member functions
    ( = ,  = );
     () ;
     () ;

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

  // public member functions
  ( = ,  = );
  (param_type &);
  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 Fisher F distribution is a real valued distribution with two parameters m and n.

It has .

`fisher_f_distribution` public member functions

```
( m = ,  n = );
```
Constructs a fisher_f_distribution from its "m" and "n" parameters.

Requires: m > 0 and n > 0
```
(param_type & param);
```
Constructs an fisher_f_distribution from its parameters.
```
template<typename URNG>  ( urng);
```
Returns a random variate distributed according to the F distribution.
```
template<typename URNG> 
   ( urng, param_type & param) ;
```
Returns a random variate distributed according to the F distribution with parameters specified by param.
```
 () ;
```
Returns the "m" parameter of the distribution.
```
 () ;
```
Returns the "n" parameter of the distribution.
```
 () ;
```
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.

`fisher_f_distribution` friend functions

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

Writes an fisher_f_distribution to a std::ostream.

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

Reads an fisher_f_distribution from a std::istream.

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

Class template fisher_f_distribution

Synopsis

Description

fisher_f_distribution public member functions

fisher_f_distribution friend functions

`fisher_f_distribution` public member functions

`fisher_f_distribution` friend functions