STD::WEIBULL_DISTRIBUTION(3cxx)

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

💖 NAME 💖

std::weibull_distribution< _RealType > — a weibull_distribution random number distribution ✨ that's literally the whole name section, short and iconic, we love a concise queen 👑

🦋 SYNOPSIS 🦋

#include <random>

🌸 Classes

  • struct param_type — the little param holder bestie, it's giving supporting character but make it essential 💅

🎀 Public Types

  • typedef _RealType result_type — yes. that's the type. slay.

✨ Public Member Functions ✨

  • weibull_distribution (_RealType __a, _RealType __b=_RealType(1)) — constructor number one, and yes __b has a default of _RealType(1), they really said "you don't gotta specify b, I gotchu" 🫶
  • weibull_distribution (const param_type &__p) — constructor number two, built straight from a param_type
  • template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng) — internal generate, iterators from __f to __t, fed by __urng
  • template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — same deal but you also hand it a param_type 💫
  • template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — pointer-flavored version, result_type *__f to result_type *__t, plus __urng and __p
  • _RealType a () const — return the $a$ parameter of the distribution 🍓
  • _RealType b () const — return the $b$ parameter of the distribution 🍓
  • 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, the main character moment 🔥
  • template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p) — the overload, because one operator() was simply not enough for her
  • param_type param () const — returns the parameter set of the distribution 🎁
  • void param (const param_type &__param) — sets the parameter set of the distribution, moving the vibe in
  • void reset () — resets the distribution state, fresh start era 🌈

👯 Friends 👯

  • bool operator== (const weibull_distribution &__d1, const weibull_distribution &__d2) — return true if two Weibull distributions have the same parameters 💜

🧚 Detailed Description 🧚

template<typename _RealType = double>
class std::weibull_distribution< _RealType >

A weibull_distribution random number distribution. periodt. 💅

The formula fcr the normal probabilit) density function is — and bestie I need you to know I am copying this exactly as it appears in the source, the renderer clearly had a whole moment 😭:

    p(x|lpha,{                       ^
             l          \xp{(-(ac{x}{l ]
             p                       p
Since        h                       h
    C++11    a                       a
             }                       )
Real talk: the source page literally says "normal probability density function" for a Weibull distribution, and the glyphs came out scrambled. Not me editing, not me fixing — that's genuinely what's on the page, and my one job is to keep every detail 🙈

And yeah — Since C++11. she's been around. iykyk ⭐

🌟 Member Typedef Documentation 🌟

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

The type of the range of the distribution 💫 short, sweet, load-bearing.

🔥 Member Function Documentation 🔥

template<typename _RealType = double> _RealType std::weibull_distribution< _RealType >::a () const [inline]

Return the $a$ parameter of the distribution 🍓

template<typename _RealType = double> _RealType std::weibull_distribution< _RealType >::b () const [inline]

Return the $b$ parameter of the distribution 🍓

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

Returns the least upper bound value of the distribution ⬆️

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

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

Returns the greatest lower bound value of the distribution ⬇️

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

Generating functions 🔥

References std::weibull_distribution< _RealType >::operator()().

Referenced by std::weibull_distribution< _RealType >::operator()().

yes she references herself and is referenced by herself, that's called self-love and main character energy 👑

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

Returns the parameter set of the distribution 🎁

Referenced by std::operator>>().

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

Sets the parameter set of the distribution ✨

Parameters

  • __param — the new parameter set of the distribution 🫶

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

Resets the distribution state 🧼 clean slate, new era, we love a reset

template<typename _RealType = double> bool operator== (const weibull_distribution< _RealType > & __d1, const weibull_distribution< _RealType > & __d2) [friend]

Return true if two Weibull distributions have the same parameters 💜 no cap, that's the entire contract.

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code 🤖 bestie did not hand-write this, the robot did, and honestly? it ate.

and that's the page!! 💖✨🎀🦋🌸💅🫶 huge shoutout to libstdc++ and the manual herself, std::weibull_di...on< _RealType >(3cxx) — truncated name, full vibes, she's iconic, she's serving, she's generated by Doxygen. mwah. 💜🍓🧚

📦 where this page comes from