std::tr1(3)

🌸 std::tr1(3) β€” Library Functions Manual 🌸

okay bestie, welcome to the std::tr1(3) page from the Library Functions Manual. this is the ISO C++ TR1 toplevel namespace, and we're about to go through every single entity like it's a Spotify wrapped. no skips, no cap. πŸ’–


✨ NAME ✨

std::tr1 β€” the ISO C++ TR1 entities toplevel namespace is std::tr1. yes, it said it twice, and honestly? iconic. periodt.


✨ SYNOPSIS ✨

πŸ¦‹ Namespaces πŸ¦‹

  • namespace __detail β€” this is giving implementation details, and it is not part of the std::tr1 interface. like, don't touch, iykyk. πŸ™ˆ

πŸ’– Functions πŸ’–

okay bestie, here's the entire function lineup. every signature is exactly as it appears, and the descriptions are rewritten with love. πŸ’…

  • template<typename _Tp> std::complex< _Tp > acos (const std::complex< _Tp > &)
  • template<typename _Tp> std::complex< _Tp > acosh (const std::complex< _Tp > &)
  • template<typename _Tp> _Tp arg (const complex< _Tp > &) β€” returns the phase angle of z, periodt. πŸ’«
  • template<typename _Tp> std::complex< _Tp > asin (const std::complex< _Tp > &)
  • template<typename _Tp> std::complex< _Tp > asinh (const std::complex< _Tp > &)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type assoc_laguerre (unsigned int __n, unsigned int __m, _Tp __x) β€” this is the 5.2.1.1 Associated Laguerre polynomials moment. πŸŽ€
  • float assoc_laguerref (unsigned int __n, unsigned int __m, float __x)
  • long double assoc_laguerrel (unsigned int __n, unsigned int __m, long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type assoc_legendre (unsigned int __l, unsigned int __m, _Tp __x) β€” 5.2.1.2 Associated Legendre functions, slay. ✨
  • float assoc_legendref (unsigned int __l, unsigned int __m, float __x)
  • long double assoc_legendrel (unsigned int __l, unsigned int __m, long double __x)
  • template<typename _Tp> std::complex< _Tp > atan (const std::complex< _Tp > &)
  • template<typename _Tp> std::complex< _Tp > atanh (const std::complex< _Tp > &)
  • template<typename _Tpx, typename _Tpy> __gnu_cxx::__promote_2< _Tpx, _Tpy >::__type beta (_Tpx __x, _Tpy __y) β€” this is the 5.2.1.3 Beta functions vibe. πŸ’–
  • float betaf (float __x, float __y)
  • long double betal (long double __x, long double __y)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type comp_ellint_1 (_Tp __k) β€” 5.2.1.4 Complete elliptic integrals of the first kind, no cap. πŸŒ€
  • float comp_ellint_1f (float __k)
  • long double comp_ellint_1l (long double __k)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type comp_ellint_2 (_Tp __k) β€” 5.2.1.5 Complete elliptic integrals of the second kind, iconic. ✨
  • float comp_ellint_2f (float __k)
  • long double comp_ellint_2l (long double __k)
  • template<typename _Tp, typename _Tpn> __gnu_cxx::__promote_2< _Tp, _Tpn >::__type comp_ellint_3 (_Tp __k, _Tpn __nu) β€” 5.2.1.6 Complete elliptic integrals of the third kind, periodt. πŸ’…
  • float comp_ellint_3f (float __k, float __nu)
  • long double comp_ellint_3l (long double __k, long double __nu)
  • template<typename _Tpa, typename _Tpc, typename _Tp> __gnu_cxx::__promote_3< _Tpa, _Tpc, _Tp >::__type conf_hyperg (_Tpa __a, _Tpc __c, _Tp __x)
  • float conf_hypergf (float __a, float __c, float __x)
  • long double conf_hypergl (long double __a, long double __c, long double __x)
  • template<typename _Tp> std::complex< typename __gnu_cxx::__promote< _Tp >::__type > conj (_Tp __x)
  • template<typename _Tp> std::complex< _Tp > conj (const std::complex< _Tp > &__z)
  • template<typename _Tpnu, typename _Tp> __gnu_cxx::__promote_2< _Tpnu, _Tp >::__type cyl_bessel_i (_Tpnu __nu, _Tp __x) β€” 5.2.1.8 Regular modified cylindrical Bessel functions, bestie. 🫢
  • float cyl_bessel_if (float __nu, float __x)
  • long double cyl_bessel_il (long double __nu, long double __x)
  • template<typename _Tpnu, typename _Tp> __gnu_cxx::__promote_2< _Tpnu, _Tp >::__type cyl_bessel_j (_Tpnu __nu, _Tp __x) β€” 5.2.1.9 Cylindrical Bessel functions (of the first kind), slay. πŸ”₯
  • float cyl_bessel_jf (float __nu, float __x)
  • long double cyl_bessel_jl (long double __nu, long double __x)
  • template<typename _Tpnu, typename _Tp> __gnu_cxx::__promote_2< _Tpnu, _Tp >::__type cyl_bessel_k (_Tpnu __nu, _Tp __x) β€” 5.2.1.10 Irregular modified cylindrical Bessel functions, no cap. 🌸
  • float cyl_bessel_kf (float __nu, float __x)
  • long double cyl_bessel_kl (long double __nu, long double __x)
  • template<typename _Tpnu, typename _Tp> __gnu_cxx::__promote_2< _Tpnu, _Tp >::__type cyl_neumann (_Tpnu __nu, _Tp __x) β€” 5.2.1.11 Cylindrical Neumann functions, periodt. πŸ’œ
  • float cyl_neumannf (float __nu, float __x)
  • long double cyl_neumannl (long double __nu, long double __x)
  • template<typename _Tp, typename _Tpp> __gnu_cxx::__promote_2< _Tp, _Tpp >::__type ellint_1 (_Tp __k, _Tpp __phi) β€” 5.2.1.12 Incomplete elliptic integrals of the first kind, iconic. ✨
  • float ellint_1f (float __k, float __phi)
  • long double ellint_1l (long double __k, long double __phi)
  • template<typename _Tp, typename _Tpp> __gnu_cxx::__promote_2< _Tp, _Tpp >::__type ellint_2 (_Tp __k, _Tpp __phi) β€” 5.2.1.13 Incomplete elliptic integrals of the second kind, slay. πŸ’…
  • float ellint_2f (float __k, float __phi)
  • long double ellint_2l (long double __k, long double __phi)
  • template<typename _Tp, typename _Tpn, typename _Tpp> __gnu_cxx::__promote_3< _Tp, _Tpn, _Tpp >::__type ellint_3 (_Tp __k, _Tpn __nu, _Tpp __phi) β€” 5.2.1.14 Incomplete elliptic integrals of the third kind, no cap. πŸŒ€
  • float ellint_3f (float __k, float __nu, float __phi)
  • long double ellint_3l (long double __k, long double __nu, long double __phi)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type expint (_Tp __x) β€” 5.2.1.15 Exponential integrals, periodt. πŸ’–
  • float expintf (float __x)
  • long double expintl (long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type fabs (_Tp __x)
  • template<typename _Tp> std::complex< _Tp > fabs (const std::complex< _Tp > &__z) β€” literally fabs(__z) and it's [8.1.8], bestie. πŸ’…
  • float fabs (float __x)
  • long double fabs (long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type hermite (unsigned int __n, _Tp __x) β€” 5.2.1.16 Hermite polynomials, slay. ✨
  • float hermitef (unsigned int __n, float __x)
  • long double hermitel (unsigned int __n, long double __x)
  • template<typename _Tpa, typename _Tpb, typename _Tpc, typename _Tp> __gnu_cxx::__promote_4< _Tpa, _Tpb, _Tpc, _Tp >::__type hyperg (_Tpa __a, _Tpb __b, _Tpc __c, _Tp __x)
  • float hypergf (float __a, float __b, float __c, float __x)
  • long double hypergl (long double __a, long double __b, long double __c, long double __x)
  • template<typename _Tp> constexpr _Tp imag (const complex< _Tp > &__z)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type laguerre (unsigned int __n, _Tp __x) β€” 5.2.1.18 Laguerre polynomials, iconic. πŸŽ€
  • float laguerref (unsigned int __n, float __x)
  • long double laguerrel (unsigned int __n, long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type legendre (unsigned int __n, _Tp __x) β€” 5.2.1.19 Legendre polynomials, periodt. πŸ’œ
  • float legendref (unsigned int __n, float __x)
  • long double legendrel (unsigned int __n, long double __x)
  • template<typename _Tp> _Tp constexpr norm (const complex< _Tp > &) β€” returns z magnitude squared, slay. πŸ’«
  • template<typename _Tp> complex< _Tp > polar (const _Tp &, const _Tp &=_Tp(0)) β€” returns a complex with magnitude rho and angle theta, iconic. 🌈
  • template<typename _Tp, typename _Up> std::complex< typename __gnu_cxx::__promote_2< _Tp, _Up >::__type > polar (const _Tp &__rho, const _Up &__theta)
  • template<typename _Tp, typename _Up> __gnu_cxx::__promote_2< _Tp, _Up >::__type pow (_Tp __x, _Up __y)
  • template<typename _Tp> std::complex< _Tp > pow (const _Tp &__x, const std::complex< _Tp > &__y)
  • template<typename _Tp, typename _Up> std::complex< typename __gnu_cxx::__promote_2< _Tp, _Up >::__type > pow (const _Tp &__x, const std::complex< _Up > &__y)
  • template<typename _Tp> std::complex< _Tp > pow (const std::complex< _Tp > &__x, const _Tp &__y)
  • template<typename _Tp, typename _Up> std::complex< typename __gnu_cxx::__promote_2< _Tp, _Up >::__type > pow (const std::complex< _Tp > &__x, const _Up &__y) β€” these are the additional overloads, [8.1.9] energy. ✨
  • template<typename _Tp> std::complex< _Tp > pow (const std::complex< _Tp > &__x, const std::complex< _Tp > &__y)
  • template<typename _Tp, typename _Up> std::complex< typename __gnu_cxx::__promote_2< _Tp, _Up >::__type > pow (const std::complex< _Tp > &__x, const std::complex< _Up > &__y)
  • float pow (float __x, float __y)
  • long double pow (long double __x, long double __y)
  • template<typename _Tp> constexpr _Tp real (const complex< _Tp > &__z)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type riemann_zeta (_Tp __x) β€” 5.2.1.20 Riemann zeta function, no cap. πŸ’…
  • float riemann_zetaf (float __x)
  • long double riemann_zetal (long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type sph_bessel (unsigned int __n, _Tp __x) β€” 5.2.1.21 Spherical Bessel functions, slay. πŸ”₯
  • float sph_besself (unsigned int __n, float __x)
  • long double sph_bessell (unsigned int __n, long double __x)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type sph_legendre (unsigned int __l, unsigned int __m, _Tp __theta) β€” 5.2.1.22 Spherical associated Legendre functions, iconic. 🌸
  • float sph_legendref (unsigned int __l, unsigned int __m, float __theta)
  • long double sph_legendrel (unsigned int __l, unsigned int __m, long double __theta)
  • template<typename _Tp> __gnu_cxx::__promote< _Tp >::__type sph_neumann (unsigned int __n, _Tp __x) β€” 5.2.1.23 Spherical Neumann functions, periodt. πŸ’œ
  • float sph_neumannf (unsigned int __n, float __x)
  • long double sph_neumannl (unsigned int __n, long double __x)

🌈 Detailed Description 🌈

okay so the Detailed Description is literally just: the toplevel namespace for the ISO C++ TR1 entities is std::tr1. that's the whole thing. periodt. πŸ’–

✨ Function Documentation ✨

okay bestie, here's the function tea. we're going through every single one, no skipping. πŸ’…

✨ std::arg ✨

template<typename _Tp> _Tp std::arg (const complex< _Tp > & __z) [inline]

this one is literally just returning the phase angle of z. that's the whole vibe. πŸŒ€


✨ __gnu_cxx::conf_hyperg ✨

template<typename _Tpa, typename _Tpc, typename _Tp> __gnu_cxx::__promote_3<
    _Tpa, _Tpc, _Tp >::__type __gnu_cxx::conf_hyperg (_Tpa __a, _Tpc __c,
    _Tp __x) [inline]

so this returns the confluent hypergeometric function $ {}_1F_1(a;c;x) $ of real numeratorial parameter a, denominatorial parameter c, and argument x. iconic. ✨

the confluent hypergeometric function is defined by:

    {}_1F_1(a;c;x) = _{n=0}^{infty} ac{(a)_n x^n}{(c)_n n!} ]

where the Pochhammer symbol is $ (x)_k = (x)(x+1)...(x+k-1) $, $ (x)_0 = 1 $

Parameters:

  • __a β€” the numeratorial parameter
  • __c β€” the denominatorial parameter
  • __x β€” the argument

✨ __gnu_cxx::conf_hypergf ✨

float __gnu_cxx::conf_hypergf (float __a, float __c, float __x) [inline]

returns the confluent hypergeometric function $ {}_1F_1(a;c;x) $ of float numeratorial parameter a, denominatorial parameter c, and argument x.

See also: conf_hyperg for details. 🫢


✨ __gnu_cxx::conf_hypergl ✨

long double __gnu_cxx::conf_hypergl (long double __a, long double __c, long double __x) [inline]

returns the confluent hypergeometric function $ {}_1F_1(a;c;x) $ of long double numeratorial parameter a, denominatorial parameter c, and argument x.

See also: conf_hyperg for details. πŸ’–


✨ __gnu_cxx::hyperg ✨

template<typename _Tpa, typename _Tpb, typename _Tpc, typename _Tp>
    __gnu_cxx::__promote_4< _Tpa, _Tpb, _Tpc, _Tp >::__type
    __gnu_cxx::hyperg (_Tpa __a, _Tpb __b, _Tpc __c, _Tp __x) [inline]

returns the hypergeometric function $ {}_2F_1(a,b;c;x) $ of real numeratorial parameters a and b, denominatorial parameter c, and argument x. no cap. πŸ”₯

the hypergeometric function is defined by:

    {}_2F_1(a;c;x) = _{n=0}^{infty} ac{(a)_n (b)_n x^n}{(c)_n n!} ]

where the Pochhammer symbol is $ (x)_k = (x)(x+1)...(x+k-1) $, $ (x)_0 = 1 $

Parameters:

  • __a β€” the first numeratorial parameter
  • __b β€” the second numeratorial parameter
  • __c β€” the denominatorial parameter
  • __x β€” the argument

✨ __gnu_cxx::hypergf ✨

float __gnu_cxx::hypergf (float __a, float __b, float __c, float __x) [inline]

returns the hypergeometric function $ {}_2F_1(a,b;c;x) $ of @ float numeratorial parameters a and b, denominatorial parameter c, and argument x. (yes, that @ is literally in the original, we don't make the rules πŸ’€)

See also: hyperg for details. 🌸


✨ __gnu_cxx::hypergl ✨

long double __gnu_cxx::hypergl (long double __a, long double __b, long double __c, long double __x) [inline]

returns the hypergeometric function $ {}_2F_1(a,b;c;x) $ of long double numeratorial parameters a and b, denominatorial parameter c, and argument x.

See also: hyperg for details. πŸ¦‹


✨ std::norm ✨

template<typename _Tp> _Tp constexpr std::norm (const complex< _Tp > & ) [constexpr]

returns the magnitude squared of z. that's it. simple. elegant. periodt. πŸ’…


✨ std::polar ✨

template<typename _Tp> complex< _Tp > std::polar (const _Tp & __rho, const _Tp & __theta = _Tp(0)) [inline]

returns a complex with magnitude rho and angle theta. giving trigonometry realness. ✨


✨ Author ✨

this page was generated automatically by Doxygen for libstdc++ straight from the source code. iykyk. πŸ€–


okay bestie, that's the whole page. the footer says libstdc++ and std::tr1(3), and there's no date on this one, so that's the sign-off. slay, you made it to the end. πŸ’–βœ¨

πŸ“¦ 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