STD::CAUCHY_DISTRIBUTION(3cxx)

okay so bestie, welcome to the 3cxx manual page for std::cauchy_distribution< _RealType > — yes it's a whole libstdc++ situation and we're gonna get through it together, no cap 💅✨

🌸 NAME 🌸

std::cauchy_distribution< _RealType > — literally a cauchy_distribution random number distribution. that's the whole name, she's concise, we respect it 🎀

---

🦋 SYNOPSIS 🦋

you pull her in with:

#include <random

wait, bestie, the actual include is exactly this:

#include <random>

🎀 Classes

• struct param_type — the parameter struct, sitting there in the synopsis with no extra blurb. mysterious. iconic.

🌸 Public Types

• typedef _RealType result_type — listed here with no extra note; the full description is down in its own section, keep scrolling 🫶

💅 Public Member Functions

here's the whole roster, no skips, no cuts:

• cauchy_distribution (_RealType __a, _RealType __b=1.0) — the manual just drops the signature, no little description attached.
• cauchy_distribution (const param_type &__p) — same vibe, signature only.
• template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng) — no extra blurb in the roster.
• template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — still no extra blurb.
• template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p) — signature only, she's mysterious.
• _RealType a () const — no description in the roster, just vibes.
• _RealType b () const — same, no description attached.
• 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) — no extra blurb in the roster.
• 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 cauchy_distribution &__d1, const cauchy_distribution &__d2) — Return true if two Cauchy distributions have the same parameters.

---

💖 Detailed Description 💖

the class line is exactly this:

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

and then the manual says:

A cauchy_distribution random number distribution.

The formula for the normal probability mass function is:

$p(x|a,b) = (i b (1 + (ac{x-a}{b})^2))^{-1}$

and the Since note is:

• Since — C++11

---

🧚 Member Typedef Documentation

⭐ result_type

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

The type of the range of the distribution. she said what she said 💅

---

🔥 Member Function Documentation

🌟 max()

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

Returns the least upper bound value of the distribution.

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

🌟 min()

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

Returns the greatest lower bound value of the distribution.

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

🌟 operator()

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

Generating functions.

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

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

the manual literally says it references and is referenced by itself, and honestly? main character energy. we are not questioning the icon 🫶

🌟 param() const

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

Returns the parameter set of the distribution.

Referenced by std::operator>>().

🌟 param() setter

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

Sets the parameter set of the distribution.

Parameters

• __param — The new parameter set of the distribution.

🌟 reset()

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

Resets the distribution state.

---

👑 Friends And Related Symbol Documentation

💫 operator==

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

Return true if two Cauchy distributions have the same parameters.

---

🌈 Author

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

---

mwah 💋 this page came from libstdc++, manual section 3cxx — source/version noted, and the footer is just giving “she's from libstdc++ and she's in 3cxx” energy. no cap, we made it through the whole roster together, bestie 💖✨