STD::STUDENT_T_DISTRIBUTION(3)

💖 NAME 💖

std::student_t_distribution< _RealType > — a student_t_distribution random number distribution. yep, that's the whole name, she's long but she's iconic 👑

This page lives in the Library Functions Manual, section 3, so if you ever see std::stude...RealType >(3) floating around, bestie, that's literally her.

---

✨ SYNOPSIS ✨

#include <random>

🎀 Classes

• struct param_type

🎀 Public Types

• typedef _RealType result_type

🎀 Public Member Functions

• student_t_distribution (_RealType __n)
• student_t_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. this is the one that actually makes the numbers, main character energy 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::student_t_distribution< _RealType1 > &__x) — Inserts a student_t_distribution random number distribution __x into the output stream __os.
• 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.
• 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} ]

ok so that formula is literally copied straight off the page and it's a little cursed looking, but it's hers and we respect it 🫶 no editing, no cap.

Since: C++11 — so she's been around, she's not new here 💅

---

🦋 Member Typedef Documentation 🦋

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

The type of the range of the distribution. this is the type of every number she hands you, periodt.

---

💜 Member Function Documentation 💜

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

Returns the least upper bound value of the distribution. the ceiling, the limit, the "she will not go above this" 🚫⬆️

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

Returns the greatest lower bound value of the distribution. the floor, the "she will not go below this" 🚫⬇️

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

Generating functions. 🎲 feed her a uniform random number generator and she pops out a result — that's the whole bit.

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

Returns the parameter set of the distribution. the receipts 📋

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

Sets the parameter set of the distribution. swapping out the whole vibe in one move.

Parameters

• __param — The new parameter set of the distribution.

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

Resets the distribution state. it's giving factory reset, it's giving fresh start ✨

---

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

Inserts a student_t_distribution random number distribution __x into the output stream __os. she's posting herself to the stream, we love a self-publishing queen 📸

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.

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. twinning fr fr 👯

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. reading the group chat, catching up on the lore 📥

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.

no human wrote this, bestie, a robot did, and honestly? slay 🤖💅

---

and that's the whole page, you're welcome 🫶 this was libstdc++, std::stude...RealType >(3), so if you need her again just yell for that exact weird truncated title — she'll be there. byeeee 💖🎀🌸