std::bernoulli_distribution(3cxx)

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

🌸 NAME 🌸

std::bernoulli_distribution — A Bernoulli random number distribution.

Manual name check, bestie: this whole page is std::bernoulli_distribution(3cxx) from libstdc++, folded in right here near the top instead of copied as a header line. Slay. 💅✨

✨ SYNOPSIS ✨

#include <random>

🎀 Classes

  • struct param_type

🫶 Public Types

  • typedef bool result_type

💅 Public Member Functions

  • bernoulli_distribution () — Constructs a Bernoulli distribution with likelihood 0.5.
  • bernoulli_distribution (const param_type &__p)
  • bernoulli_distribution (double __p) — Constructs a Bernoulli distribution with likelihood 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.
  • result_type min () const — Returns the greatest lower bound value of the distribution.
  • template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng) — Generating functions.
  • template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
  • double p () const — Returns the p parameter of the distribution.
  • 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 bernoulli_distribution &__d1, const bernoulli_distribution &__d2) — Return true if two Bernoulli distributions have the same parameters.

🌈 Detailed Description 🌈

A Bernoulli random number distribution.

Generates a sequence of true and false values with likelihood $p$ that true will come up and $(1 - p)$ that false will appear.

Since: C++11

🧚 Member Typedef Documentation 🧚

typedef bool std::bernoulli_distribution::result_type

The type of the range of the distribution. Iconic little typedef behavior. 🎀

🎀 Constructor & Destructor Documentation 🎀

std::bernoulli_distribution::bernoulli_distribution () [inline]

Constructs a Bernoulli distribution with likelihood 0.5.

std::bernoulli_distribution::bernoulli_distribution (double __p) [inline], [explicit]

Constructs a Bernoulli distribution with likelihood p.

Parameters

  • __p [IN] The likelihood of a true result being returned. Must be in the interval $[0, 1]$.

💖 Member Function Documentation 💖

result_type std::bernoulli_distribution::max () const [inline]

Returns the least upper bound value of the distribution.

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

result_type std::bernoulli_distribution::min () const [inline]

Returns the greatest lower bound value of the distribution.

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

template<typename _UniformRandomNumberGenerator > result_type std::bernoulli_distribution::operator() (_UniformRandomNumberGenerator &__urng) [inline]

Generating functions.

References operator()().

Referenced by operator()().

double std::bernoulli_distribution::p () const [inline]

Returns the p parameter of the distribution.

param_type std::bernoulli_distribution::param () const [inline]

Returns the parameter set of the distribution.

Referenced by std::operator>>().

void std::bernoulli_distribution::param (const param_type & __param) [inline]

Sets the parameter set of the distribution.

Parameters

  • __param The new parameter set of the distribution.

void std::bernoulli_distribution::reset () [inline]

Resets the distribution state. Does nothing for a Bernoulli distribution.

bool operator== (const bernoulli_distribution & __d1, const bernoulli_distribution & __d2) [friend]

Return true if two Bernoulli distributions have the same parameters.

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

Okay bye bestie — the footer source/version energy is libstdc++, and the manual name is std::bernoulli_distribution(3cxx). That’s the whole page, no cap. 💖✨🎀

📦 where this page comes from