STD::FISHER_F_DISTRIBUTION(3cxx)

💖 NAME 💖

Okay bestie, this is the std::fisher_f_...on< _RealType >(3cxx) manual page, and it’s all about std::fisher_f_distribution< _RealType > — a fisher_f_distribution random number distribution. Literally C++ random-number royalty, no cap. 👑✨

✨ SYNOPSIS ✨

#include <random>

🧸 Classes

• struct param_type

🎀 Public Types

• typedef _RealType result_type

💅 Public Member Functions

• the __m / __n constructor —

fisher_f_distribution (_RealType __m, _RealType __n=_RealType(1))

• the param_type constructor —

fisher_f_distribution (const param_type &__p)

• __generate overload 1 —

template<typename _ForwardIterator , typename
    _UniformRandomNumberGenerator > void __generate (_ForwardIterator
    __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)

• __generate overload 2 —

template<typename _ForwardIterator , typename
    _UniformRandomNumberGenerator > void __generate (_ForwardIterator
    __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng,
    const param_type &__p)

• __generate overload 3 —

template<typename _UniformRandomNumberGenerator > void __generate
    (result_type *__f, result_type *__t, _UniformRandomNumberGenerator
    &__urng)

• __generate overload 4 —

template<typename _UniformRandomNumberGenerator > void __generate
    (result_type *__f, result_type *__t, _UniformRandomNumberGenerator
    &__urng, const param_type &__p)

• m () const —

_RealType m () const

• max () const — returns the least upper bound value of the distribution. 📈

result_type max () const

• min () const — returns the greatest lower bound value of the distribution. 📉

result_type min () const

• n () const —

_RealType n () const

• operator() overload 1 — generating function, bestie. 🎲

template<typename _UniformRandomNumberGenerator > result_type operator()
    (_UniformRandomNumberGenerator &__urng)

• operator() overload 2 —

template<typename _UniformRandomNumberGenerator > result_type operator()
    (_UniformRandomNumberGenerator &__urng, const param_type &__p)

• param () const — returns the parameter set of the distribution.

param_type param () const

• param (const param_type &__param) — sets the parameter set of the distribution.

void param (const param_type &__param)

• reset () — resets the distribution state.

void reset ()

🫶 Friends

• operator<< — inserts a fisher_f_distribution random number distribution __x into the output stream __os.

template<typename _RealType1 , typename _CharT , typename _Traits >
    std::basic_ostream< _CharT, _Traits > & operator<<
    (std::basic_ostream< _CharT, _Traits > &__os, const
    std::fisher_f_distribution< _RealType1 > &__x)

• operator== — returns true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal.

bool operator== (const fisher_f_distribution &__d1, const
    fisher_f_distribution &__d2)

• operator>> — extracts a fisher_f_distribution random number distribution __x from the input stream __is.

template<typename _RealType1 , typename _CharT , typename _Traits >
    std::basic_istream< _CharT, _Traits > & operator>>
    (std::basic_istream< _CharT, _Traits > &__is,
    std::fisher_f_distribution< _RealType1 > &__x)

🌸 Detailed Description 🌸

The class template is:

template<typename _RealType = double>

And class std::fisher_f_distribution< _RealType > is a fisher_f_distribution random number distribution. It’s giving statistical icon behavior. 🐟✨

The formula for the normal probability mass function is:

p(x|m,n) = ac{Gamma((m+n)/2)}{Gamma(m/2)Gamma(n/2)}
           (ac{m}{n})^{m/2} x^{(m/2)-1}
           (1 + ac{mx}{n})^{-(m+n)/2} ]

And yes: Since C++11. 💖

🎀 Member Typedef Documentation 🎀

template<typename _RealType  = double> typedef _RealType
    std::fisher_f_distribution< _RealType >::result_type

This is the type of the range of the distribution. That’s the whole typedef moment, and it ate. 💅

💅 Member Function Documentation 💅

• max () const —

template<typename _RealType  = double> result_type
    std::fisher_f_distribution< _RealType >::max () const [inline]

Returns the least upper bound value of the distribution. References std::numeric_limits< _Tp >::max().

• min () const —

template<typename _RealType  = double> result_type
    std::fisher_f_distribution< _RealType >::min () const [inline]

Returns the greatest lower bound value of the distribution.

• operator() —

template<typename _RealType  = double> template<typename
    _UniformRandomNumberGenerator > result_type std::fisher_f_distribution<
    _RealType >::operator() (_UniformRandomNumberGenerator & __urng)
    [inline]

Generating functions. That’s literally what the source says, bestie. 🎲

• param () const —

template<typename _RealType  = double> param_type
    std::fisher_f_distribution< _RealType >::param () const [inline]

Returns the parameter set of the distribution. Referenced by std::normal_distribution< double >::operator()().

• param (const param_type & __param) —

template<typename _RealType  = double> void std::fisher_f_distribution<
    _RealType >::param (const param_type & __param) [inline]

Sets the parameter set of the distribution.

• Parameters: __param — the new parameter set of the distribution.

• reset () —

template<typename _RealType  = double> void std::fisher_f_distribution<
    _RealType >::reset () [inline]

Resets the distribution state. References std::gamma_distribution< _RealType >::reset().

🦋 Friends And Related Symbol Documentation 🦋

• operator<< —

template<typename _RealType  = double> template<typename _RealType1 ,
    typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits
    > & operator<< (std::basic_ostream< _CharT, _Traits > & __os, const
    std::fisher_f_distribution< _RealType1 > & __x) [friend]

Inserts a fisher_f_distribution random number distribution __x into the output stream __os.

• Parameters:
  • __os — an output stream.
  • __x — a fisher_f_distribution random number distribution.
• Returns: the output stream with the state of __x inserted or in an error state.

• operator== —

template<typename _RealType  = double> bool operator== (const
    fisher_f_distribution< _RealType > & __d1, const fisher_f_distribution<
    _RealType > & __d2) [friend]

Return true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal.

• operator>> —

template<typename _RealType  = double> template<typename _RealType1 ,
    typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits
    > & operator>> (std::basic_istream< _CharT, _Traits > & __is,
    std::fisher_f_distribution< _RealType1 > & __x) [friend]

Extracts a fisher_f_distribution random number distribution __x from the input stream __is.

• Parameters:
  • __is — an input stream.
  • __x — a fisher_f_distribution random number generator engine.
• Returns: the input stream with __x extracted or in an error state.

🌈 Author 🌈

Generated automatically by Doxygen for libstdc++ from the source code. So yes, the robots wrote it, but I’m here to make it cute. 🤖💖

---

Sign-off from libstd · std::fisher_f_...on< _RealType >(3cxx) — stay sparkly, bestie. 💖✨