STD::CAUCHY_DISTRIBUTION(3)

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

✨ NAME ✨</p>

std::cauchy_distribution< _RealType > — a cauchy_distribution random number distribution 💖

🎀 SYNOPSIS 🎀

#include <random>

Classes 💅

  • struct param_type

Public Types 🌸

  • typedef _RealType result_type

Public Member Functions 🦋

  • cauchy_distribution (_RealType __a, _RealType __b=1.0)
  • cauchy_distribution (const param_type &__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)
  • _RealType a () const
  • _RealType b () const
  • 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.
  • 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 💖

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

"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}$ ✨

Since C++11

🧚 MEMBER TYPEDEF DOCUMENTATION 🧚

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

The type of the range of the distribution. slay 🌈

⭐ 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. 👑

min() 💫

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

Returns the greatest lower bound value of the distribution. 🫶

operator() 💫

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

Generating functions. 🎰

Referenced by operator()().

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(const param_type & __param) 💫

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. 🔄

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.

okay bestie that's literally the whole page, no cap 💖 this was libstdc++'s std::cauch..._RealType >(3) — Library Functions Manual energy, and it's giving generated automatically by Doxygen for libstdc++ from the source code 🎀 periodt, go forth and generate some Cauchy randomness ✨🦋

📦 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