STD::CHI_SQUARED_DISTRIBUTION(3cxx)

🎀 NAME 🎀

okay so bestie, welcome to the 3cxx manual page for std::chi_squared_distribution< _RealType > — it's a chi_squared_distribution random number distribution. 💖

✨ SYNOPSIS ✨

#include <random>

🌈 Classes

• struct param_type

🦋 Public Types

• typedef _RealType result_type

💅 Public Member Functions

• chi_squared_distribution (_RealType __n)
• chi_squared_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)
• 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.
• 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::chi_squared_distribution< _RealType1 > &__x) — inserts a chi_squared_distribution random number distribution __x into the output stream __os.
• bool operator== (const chi_squared_distribution &__d1, const chi_squared_distribution &__d2) — return true if two Chi-squared 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::chi_squared_distribution< _RealType1 > &__x) — extracts a chi_squared_distribution random number distribution __x from the input stream __is.

💖 Detailed Description 💖

template<typename _RealType = double> class std::chi_squared_distribution< _RealType > is a chi_squared_distribution random number distribution.

The formula for the normal probability mass function is:

$p(x|n) = ac{x^{(n/2) - 1}e^{-x/2}}{Gamma(n/2) 2^{n/2}}$

Since C++11.

🌸 Member Typedef Documentation 🌸

• template<typename _RealType = double> typedef _RealType std::chi_squared_distribution< _RealType >::result_type — the type of the range of the distribution.

⭐ Member Function Documentation ⭐

• template<typename _RealType = double> result_type std::chi_squared_distribution< _RealType >::max () const [inline] — returns the least upper bound value of the distribution.
  • References std::numeric_limits< _Tp >::max().
• template<typename _RealType = double> result_type std::chi_squared_distribution< _RealType >::min () const [inline] — returns the greatest lower bound value of the distribution.
• template<typename _RealType = double> template<typename _UniformRandomNumberGenerator > result_type std::chi_squared_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng) [inline] — generating functions.
• template<typename _RealType = double> param_type std::chi_squared_distribution< _RealType >::param () const [inline] — returns the parameter set of the distribution.
• template<typename _RealType = double> void std::chi_squared_distribution< _RealType >::param (const param_type & __param) [inline] — sets the parameter set of the distribution.
  • Parameters: __param — the new parameter set of the distribution.
  • References std::gamma_distribution< _RealType >::param().
• template<typename _RealType = double> void std::chi_squared_distribution< _RealType >::reset () [inline] — resets the distribution state.
  • References std::gamma_distribution< _RealType >::reset().

🧚 Friends And Related Symbol Documentation 🧚

• 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::chi_squared_distribution< _RealType1 > & __x) [friend] — inserts a chi_squared_distribution random number distribution __x into the output stream __os.
  • Parameters: __os — an output stream. __x — a chi_squared_distribution random number distribution.
  • Returns: the output stream with the state of __x inserted or in an error state.
• template<typename _RealType = double> bool operator== (const chi_squared_distribution< _RealType > & __d1, const chi_squared_distribution< _RealType > & __d2) [friend] — Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal.
• template<typename _RealType = double> template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > & __is, std::chi_squared_distribution< _RealType1 > & __x) [friend] — extracts a chi_squared_distribution random number distribution __x from the input stream __is.
  • Parameters: __is — an input stream. __x — a chi_squared_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.

---

okay that's the whole page, bestie 🫶 — the footer/source line is literally libststd::chi_square...on< _RealType >(3cxx), and this was generated automatically by Doxygen for libstdc++ from the source code. No date is printed on the page, so I'm not inventing one 💜.