STD::FISHER_F_DISTRIBUTION(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 11 versions
, in arch rolling, fedora 44

💖 NAME 💖

std::fisher_f_distribution< _RealType > — a fisher_f_distribution random number distribution. yes bestie, that's literally the whole name, angle brackets and all 💅

Quick vibe check first: this page lives in the Library Functions Manual, section 3, so if you're looking for it on your system that's the neighborhood 🏘️

✨ SYNOPSIS ✨

#include <random>

🌸 Classes 🌸

  • struct param_type

🦋 Public Types 🦋

  • typedef _RealType result_type

🎀 Public Member Functions 🎀

  • fisher_f_distribution (_RealType __m, _RealType __n=_RealType(1))
  • fisher_f_distribution (const param_type &__p)
  • template<typename _ForwardIterator, typename _UniformRandomNumberGenerator> void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
  • template<typename _ForwardIterator, typename _UniformRandomNumberGenerator> void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
  • template<typename _UniformRandomNumberGenerator> void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng)
  • template<typename _UniformRandomNumberGenerator> void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
  • _RealType m () const
  • result_type max () const — returns the least upper bound value of the distribution 👑
  • result_type min () const — returns the greatest lower bound value of the distribution 🥺
  • _RealType n () const
  • template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng) — generating functions, the main character energy moment fr fr
  • template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
  • param_type param () const — returns the parameter set of the distribution 🎁
  • void param (const param_type &__param) — sets the parameter set of the distribution
  • void reset () — resets the distribution state 🔄

💜 Friends 💜

  • 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) — inserts a fisher_f_distribution random number distribution __x into the output stream __os 🖨️
  • bool operator== (const fisher_f_distribution &__d1, const fisher_f_distribution &__d2) — return true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal ✅
  • 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) — extracts a fisher_f_distribution random number distribution __x from the input stream __is 📥

🌈 Detailed Description 🌈

template<typename _RealType = double>
class std::fisher_f_distribution< _RealType >

A fisher_f_distribution random number distribution.

The formula for the normal probability mass function is, and I'm putting this in a code block so nobody messes with the characters, because we do NOT touch the math:

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} ]

Since: C++11 🕰️

🍓 Member Typedef Documentation 🍓

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

The type of the range of the distribution. That's it, that's the whole personality 🫶

💅 Member Function Documentation 💅

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

Returns the least upper bound value of the distribution. the ceiling, the limit, the "no further than this" ⭐

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

Returns the greatest lower bound value of the distribution. the floor, the basement, the bottom of the vibes 🌊

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

Generating functions. 🎲

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

Returns the parameter set of the distribution.

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.
template<typename _RealType = double>
void std::fisher_f_distribution< _RealType >::reset () [inline]

Resets the distribution state. fresh start, clean slate, new semester energy ✨

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. no in-between, either it slays or it's an error 💀

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. Both conditions, bestie, not just one 🤝

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. not a human, just a very hardworking robot 🧚

Okay that's the whole page, you made it, I'm so proud 🥹

Sign-off time, because the footer is where the lore lives: this whole thing is libstdc++, and the page title up top got cropped down to std::fishe..._RealType >(3) like a bad selfie crop — we still love it 💖 periodt 🎀

📦 where this page comes from
  • arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
  • fedora 44: libstdc++-docs 16.0.1-0.10.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.2.1-2.fc44
  • fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms