STD::GEOMETRIC_DISTRIBUTION(3)

💖 std::geometric_distribution< _IntType > 💖

okay bestie, welcome to the Library Functions Manual, section 3, and yes we are talking about std::geometric_distribution< _IntType > today. it's a whole template class and it's lowkey iconic, let's get into it 🎀

---

✨ NAME ✨

std::geometric_distribution< _IntType > — a discrete geometric random number distribution. that's it, that's the vibe. 💅

---

🌸 SYNOPSIS 🌸

#include <random>

---

🦋 Classes

• struct param_type

🦋 Public Types

• typedef _IntType result_type

🦋 Public Member Functions

• geometric_distribution (const param_type &__p)
• geometric_distribution (double __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, const param_type &__p)
• result_type max () const — returns the least upper bound value of the distribution. the ceiling, bestie 🫶
• result_type min () const — returns the greatest lower bound value of the distribution. the floor, fr fr
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng) — generating functions. this is the one that actually spits out numbers ✨
• template<typename _UniformRandomNumberGenerator> result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
• double p () const — returns the distribution parameter 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

• bool operator== (const geometric_distribution &__d1, const geometric_distribution &__d2) — return true if two geometric distributions have the same parameters. twin check 💖

---

👑 Detailed Description 👑

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

"A discrete geometric random number distribution.

the formula for the geometric probability density function is $p(i|p) = p(1 - p)^{i}$ where $p$ is the parameter of the distribution. like, that's the whole math girlie. ✨

Since

C++11 — so it's been serving since 2011, no cap 🎀

---

💜 Member Typedef Documentation 💜

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

the type of the range of the distribution. that's what you get back, periodt. 🦋

---

🌈 Member Function Documentation 🌈

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

returns the least upper bound value of the distribution. the top of the range, bestie 🫶

---

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

returns the greatest lower bound value of the distribution. the bottom of the range, slay 💅

---

template<typename _IntType = int> template<typename _UniformRandomNumberGenerator> result_type std::geometric_distribution< _IntType >::operator() (_UniformRandomNumberGenerator & __urng) [inline]

generating functions. 🎲

Referenced by operator()().

---

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

returns the distribution parameter p. 🌸

---

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

returns the parameter set of the distribution.

Referenced by std::operator>>().

---

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

sets the parameter set of the distribution.

Parameters

• __param — the new parameter set of the distribution. give it the new vibes 💖

---

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

resets the distribution state. does nothing for the geometric distribution. so like, it's there, it's cute, it does absolutely nothing 🙈 not a bug, just how it is, fr fr.

---

🧚 Friends And Related Symbol Documentation 🧚

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

return true if two geometric distributions have the same parameters. matching params = matching energy 💯

---

🎀 Author 🎀

generated automatically by Doxygen for libstdc++ from the source code. not me writing this by hand, it's giving robot-authored 😭

---

and that's the whole page bestie, go forth and generate those discrete geometric random numbers, you're the main character of <random> now 👑

this lil manual page lives under libstdc++ and the page title was std::geome... _IntType >(3) — yeah it got cut off with an ellipsis, iconic of it honestly. mwah, bye! 💖✨🎀