STD::NEGATIVE_BINOMIAL_DISTRIBUTION(3)

💖 std::negative_binomial_distribution< _IntType > 💖

okay bestie, real talk: you just opened a page from the Library Functions Manual and it's the one and only std::negative_binomial_distribution< _IntType > 🎀 she's a negative_binomial_distribution random number distribution and she's literally serving C++11 realness. no cap.

---

🌸 NAME 🌸

std::negative_binomial_distribution< _IntType > — a negative_binomial_distribution random number distribution. that's her. that's the whole vibe. 💅

---

✨ SYNOPSIS ✨

#include <random>

🦋 Classes

• struct param_type

🎀 Public Types

• typedef _IntType result_type

💜 Public Member Functions

• negative_binomial_distribution (_IntType __k, double __p=0.5)
• negative_binomial_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)
• _IntType k () const — hands you the $k$ parameter of the distribution 🫶
• result_type max () const — gives you the least upper bound value of the distribution
• result_type min () const — gives you the greatest lower bound value of the distribution
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng) — generating functions, bb ✨
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
• double p () const — hands you the $p$ parameter of the distribution 🫶
• param_type param () const — gives you 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, fresh start energy 🌈

👑 Friends

• template<typename _IntType1, typename _CharT, typename _Traits> std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::negative_binomial_distribution< _IntType1 > &__x) — inserts a negative_binomial_distribution random number distribution __x into the output stream __os 💌
• bool operator== (const negative_binomial_distribution &__d1, const negative_binomial_distribution &__d2) — returns true if two negative binomial distributions have the same parameters and the sequences that would be generated are equal
• template<typename _IntType1, typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::negative_binomial_distribution< _IntType1 > &__x) — extracts a negative_binomial_distribution random number distribution __x from the input stream __is 📥

---

🌈 Detailed Description 🌈

template<typename _IntType = int>
    class std::negative_binomial_distribution< _IntType >

"A nenative_binomial_distribution random number distribution." (yes bestie, it says nenative. not me fixing it, i don't make the rules 😭 the page is sacred.)

the formula for the negative binomial probability mass function is:

$p(i) = {} p^i (1 - p)^{t - i}$

where $t$ and $p$ are the parameters of the distribution. iconic math behaviour, fr fr. 🧚

Since: C++11 ⭐

---

💜 Member Typedef Documentation 💜

template<typename _IntType = int>
    typedef _IntType std::negative_binomial_distribution< _IntType >::result_type

the type of the range of the distribution. that's the whole assignment, periodt. 🎀

---

🔥 Member Function Documentation 🔥

template<typename _IntType = int>
    _IntType std::negative_binomial_distribution< _IntType >::k () const [inline]

returns the $k$ parameter of the distribution. 💅

template<typename _IntType = int>
    result_type std::negative_binomial_distribution< _IntType >::max () const [inline]

returns the least upper bound value of the distribution. the ceiling, the limit, the "that's enough" ✋

template<typename _IntType = int>
    result_type std::negative_binomial_distribution< _IntType >::min () const [inline]

returns the greatest lower bound value of the distribution. the floor, the bare minimum, the "you must be at least this tall" 🌱

template<typename _IntType>
template<typename _UniformRandomNumberGenerator>
    negative_binomial_distribution< _IntType >::result_type
    std::negative_binomial_distribution< _IntType >::operator()
    (_UniformRandomNumberGenerator & __urng)

generating functions. she generates. that's the job bestie ✨

template<typename _IntType = int>
    double std::negative_binomial_distribution< _IntType >::p () const [inline]

returns the $p$ parameter of the distribution. 🫶

template<typename _IntType = int>
    param_type std::negative_binomial_distribution< _IntType >::param () const [inline]

returns the parameter set of the distribution. the whole fit, the full lewk 💖

template<typename _IntType = int>
    void std::negative_binomial_distribution< _IntType >::param
    (const param_type & __param) [inline]

sets the parameter set of the distribution. new fit, who dis 💅

Parameters

• __param — the new parameter set of the distribution.

template<typename _IntType = int>
    void std::negative_binomial_distribution< _IntType >::reset () [inline]

resets the distribution state. clean slate, no baggage, therapy arc complete 🌸

---

🦋 Friends And Related Symbol Documentation 🦋

template<typename _IntType = int>
template<typename _IntType1, typename _CharT, typename _Traits>
    std::basic_ostream< _CharT, _Traits > &
    operator<< (std::basic_ostream< _CharT, _Traits > & __os,
                const std::negative_binomial_distribution< _IntType1 > & __x) [friend]

inserts a negative_binomial_distribution random number distribution __x into the output stream __os. she's posting. she's on the feed. 📤

Parameters

• __os — an output stream.
• __x — a negative_binomial_distribution random number distribution.

Returns

the output stream with the state of __x inserted or in an error state. 💀 (pray it's not the error state)

template<typename _IntType = int>
    bool operator== (const negative_binomial_distribution< _IntType > & __d1,
                     const negative_binomial_distribution< _IntType > & __d2) [friend]

returns true if two negative binomial distributions have the same parameters and the sequences that would be generated are equal. twin flames fr fr 👯

template<typename _IntType = int>
template<typename _IntType1, typename _CharT, typename _Traits>
    std::basic_istream< _CharT, _Traits > &
    operator>> (std::basic_istream< _CharT, _Traits > & __is,
                std::negative_binomial_distribution< _IntType1 > & __x) [friend]

extracts a negative_binomial_distribution random number distribution __x from the input stream __is. she's reading the room, she's consuming content 📥

Parameters

• __is — an input stream.
• __x — a negative_binomial_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. the robot wrote it, i just gave it a makeover 💅✨

---

and that's the whole page, bestie 🫶 this was the libstdc++ manual page for std::negat... _IntType >(3) — no cap, that's the title and that's the source, and she ate. go forth and generate those negative binomials responsibly. mwah 💖🎀🌈