STD::DISCRETE_DISTRIBUTION(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 8 versions
, in arch rolling, fedora 44

💖 NAME 💖

okay so bestie, this is the <pink>std::discrete_distribution< _IntType >(3)</pink> page from the <pink>Library Functions Manual</pink>. It's a discrete_distribution random number distribution. No cap, that's the whole name vibe.

✨ SYNOPSIS ✨

#include <random>

🎀 Classes 🎀

  • struct param_type

🌸 Public Types 🌸

  • typedef _IntType result_type

💅 Public Member Functions 💅

  • template<typename _InputIterator> discrete_distribution (_InputIterator __wbegin, _InputIterator __wend)
  • discrete_distribution (const param_type &__p)
  • discrete_distribution (initializer_list< double > __wl)
  • template<typename _Func> discrete_distribution (size_t __nw, double __xmin, double __xmax, _Func __fw)
  • 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)
  • param_type param () const — Returns the parameter set of the distribution.
  • void param (const param_type &__param) — Sets the parameter set of the distribution.
  • std::vector< double > probabilities () const — Returns the probabilities of the distribution.
  • void reset () — Resets the distribution state.

🫶 Friends 🫶

  • template<typename _IntType1, typename _CharT, typename _Traits> std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::discrete_distribution< _IntType1 > &__x) — Inserts a discrete_distribution random number distribution __x into the output stream __os.
  • bool operator== (const discrete_distribution &__d1, const discrete_distribution &__d2) — Return true if two discrete distributions have the same parameters.
  • template<typename _IntType1, typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::discrete_distribution< _IntType1 > &__x) — Extracts a discrete_distribution random number distribution __x from the input stream __is.

🔥 DETAILED DESCRIPTION 🔥

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

"A discrete_distribution random number distribution.

This distribution produces random numbers $ i, 0 i < n $, distributed according to the probability mass function $ p(i | p_0, ..., p_{n-1}) = p_i $.

⏳ Since ⏳

C++11

🧬 MEMBER TYPEDEF DOCUMENTATION 🧬

result_type

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

The type of the range of the distribution. 💖

📚 MEMBER FUNCTION DOCUMENTATION 📚

max

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

Returns the least upper bound value of the distribution. Slay.

min

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

Returns the greatest lower bound value of the distribution. 💅

operator()

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

Generating functions.

Referenced by operator()(). 🫶

param

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

Returns the parameter set of the distribution. ✨

param

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

Sets the parameter set of the distribution. 🔧

Parameters

  • __param — The new parameter set of the distribution.

probabilities

template<typename _IntType = int> std::vector< double > std::discrete_distribution< _IntType >::probabilities () const [inline]

Returns the probabilities of the distribution. 🎲

reset

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

Resets the distribution state. 🔄

operator<<

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::discrete_distribution< _IntType1 > & __x) [friend]

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

Parameters

  • __os — An output stream.
  • __x — A discrete_distribution random number distribution.

Returns

The output stream with the state of __x inserted or in an error state. 😭

operator==

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

Return true if two discrete distributions have the same parameters. 👯♀️

operator>>

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

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

Parameters

  • __is — An input stream.
  • __x — A discrete_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. 🤖💖

That's the whole vibe, bestie. This page is from libstdc++, and the footer tag is std::discr..._IntType >(3) — no date in the footer, just pure library energy. Bye! 💅✨

📦 where this page comes from
  • arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
  • fedora 44: libstdc++-docs 16.0.1-0.10.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.2.1-2.fc44
  • fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms