STD::STUDENT_T_DISTRIBUTION(3cxx)

📦
version 14-20240412 · 19 versions
, in ubuntu noble

okay bestie, welcome to the std::student_t_distribution< _RealType >(3cxx) page from libstdc++ — it’s giving random-number-distribution main character energy, and I’m obsessed. 💖

💖 NAME 💖

std::student_t_distribution< _RealType > — A student_t_distribution random number distribution. periodt. ✨

🎀 SYNOPSIS 🎀

#include <random>

🦋 Classes 🦋

  • struct param_type

🌸 Public Types 🌸

  • typedef _RealType result_type

💅 Public Member Functions 💅

  • constructor — student_t_distribution (_RealType __n)
  • constructor — student_t_distribution (const param_type &__p)
  • iterator __generate, no param — template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
  • iterator __generate, with param — template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
  • pointer __generate, no param — template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng)
  • pointer __generate, with param — template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p)
  • max() — result_type max () const — Returns the least upper bound value of the distribution. 🫶
  • min() — result_type min () const — Returns the greatest lower bound value of the distribution. 🫶
  • n() — _RealType n () const
  • operator() — template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng) — Generating functions.
  • operator() with param — template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
  • param() — param_type param () const — Returns the parameter set of the distribution.
  • param(const param_type &__param) — void param (const param_type &__param) — Sets the parameter set of the distribution.
  • reset() — void reset () — Resets the distribution state.

🫶 Friends 🫶

  • operator<< — template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::student_t_distribution< _RealType1 > &__x) — Inserts a student_t_distribution random number distribution __x into the output stream __os. 💖
  • operator== — bool operator== (const student_t_distribution &__d1, const student_t_distribution &__d2) — Return true if two Student t distributions have the same parameters and the sequences that would be generated are equal. ✨
  • operator>> — template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::student_t_distribution< _RealType1 > &__x) — Extracts a student_t_distribution random number distribution __x from the input stream __is. 💅

✨ Detailed Description ✨

template<typename _RealType = double>
    class std::student_t_distribution< _RealType >"A student_t_distribution
    random number distribution.

The formula for the normal probability mass function is:

p(x|n) = ac{1}{t(ni)}
ac{Gamma((n+1)/2)}{Gamma(n/2)}
             (1 + ac{x^2}{n}) ^{-(n+1)/2} ]

Since C++11 — yes bestie, that’s the era. 🕰️

🌈 Member Typedef Documentation 🌈

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

🌟 Member Function Documentation 🌟

max()

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

Returns the least upper bound value of the distribution. 🫶

References std::numeric_limits< _Tp >::max().

min()

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

Returns the greatest lower bound value of the distribution. 🫶

References std::numeric_limits< _Tp >::lowest().

operator()

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

Generating functions.

References std::sqrt().

param() const

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

Returns the parameter set of the distribution.

param(const param_type & __param)

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

Resets the distribution state.

References std::normal_distribution< _RealType >::reset(), and std::gamma_distribution< _RealType >::reset().

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::student_t_distribution< _RealType1 > & __x) [friend]

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

Parameters:

  • __os — An output stream.
  • __x — A student_t_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 student_t_distribution< _RealType > & __d1, const student_t_distribution< _RealType > & __d2) [friend]

Return true if two Student t 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::student_t_distribution< _RealType1 > & __x) [friend]

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

Parameters:

  • __is — An input stream.
  • __x — A student_t_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. Cute sign-off vibe check: source/version is libstdc++, manual page std::student_t_distribution< _RealType >(3cxx), generated by Doxygen from the source code — and the footer’s date slot isn’t filled in on this copy, so I’m not making one up, fr fr. mwah 💋🎀

📦 where this page comes from