std::cyl_be...yl_bessel_il(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay so this is the std::cyl_be...yl_bessel_il(3) page from the C++ Standard Libary, bestie β€” the manual name is folded in right here near the top 🫢. The stars of the show are std::cyl_bessel_i,std::cyl_bessel_if,std::cyl_bessel_il β€” and the NAME section is literally that same list again: std::cyl_bessel_i,std::cyl_bessel_if,std::cyl_bessel_il. We love an entrance that repeats itself, iconic πŸ’….

✨ Synopsis ✨

These cuties are defined in the header <cmath>, and here's the overload lineup in all its glory:

  • Defined in header <cmath>
  • float cyl_bessel_i ( float nu, float x ); β€” (since C++17)
  • double cyl_bessel_i ( double nu, double x ); β€” (until C++23)
  • long double cyl_bessel_i ( long double nu, long double x );
  • /* floating-point-type */ cyl_bessel_i( /* floating-point-type */ nu, /* floating-point-type */ x ); β€” (since C++23) (1)
  • float cyl_bessel_if( float nu, float x ); β€” (2) (since C++17)
  • long double cyl_bessel_il( long double nu, long double x ); β€” (3) (since C++17)

Additional overloads

  • Defined in header <cmath>
  • template< class Arithmetic1, class Arithmetic2 >
  • /* common-floating-point-type */ cyl_bessel_i( Arithmetic1 nu, Arithmetic2 x ); β€” (A) (since C++17)

1-3) Computes the regular modified cylindrical Bessel function of nu and x.

The library provides overloads of std::cyl_bessel_i for all cv-unqualified floating-point types as the type of the parameters nu and x. (since C++23)

A) Additional overloads are provided for all other combinations of arithmetic types.

🌸 Parameters 🌸

  • nu β€” the order of the function.
  • x β€” the argument of the function.

πŸŽ€ Return value πŸŽ€

If no errors occur, the value of the regular modified cylindrical Bessel function of nu and x, that is I nu(x) = Σ∞ k=0 (x/2)nu+2k / k!Ξ“(nu+k+1) (for xβ‰₯0), is returned. math girlie moment πŸ’–

πŸ’… Error handling πŸ’…

Errors may be reported as specified in math_errhandling.

  • If the argument is NaN, NaN is returned and domain error is not reported.
  • If nuβ‰₯128, the behavior is implementation-defined β€” so do not assume a specific answer, bestie 😭.

πŸ¦‹ Notes πŸ¦‹

Implementations that do not support C++17, but support ISO 29124:2010, provide this function if __STDCPP_MATH_SPEC_FUNCS__ is defined by the implementation to a value at least 201003L and if the user defines __STDCPP_WANT_MATH_SPEC_FUNCS__ before including any standard library headers.

Implementations that do not support ISO 29124:2010 but support TR 19768:2007 (TR1), provide this function in the header tr1/cmath and namespace std::tr1.

An implementation of this function is also available in boost.math.

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their first argument num1 and second argument num2:

  • If num1 or num2 has type long double, then std::cyl_bessel_i(num1, num2) has the same effect as std::cyl_bessel_i(static_cast<long double>(num1), static_cast<long double>(num2)).
  • Otherwise, if num1 and/or num2 has type double or an integer type, then std::cyl_bessel_i(num1, num2) has the same effect as std::cyl_bessel_i(static_cast<double>(num1), static_cast<double>(num2)). (until C++23)
  • Otherwise, if num1 or num2 has type float, then std::cyl_bessel_i(num1, num2) has the same effect as std::cyl_bessel_i(static_cast<float>(num1), static_cast<float>(num2)).

(since C++23) If num1 and num2 have arithmetic types, then std::cyl_bessel_i(num1, num2) has the same effect as std::cyl_bessel_i(static_cast</* common-floating-point-type */>(num1), static_cast</* common-floating-point-type */>(num2)), where /* common-floating-point-type */ is the floating-point type with the greatest floating-point conversion rank and greatest floating-point conversion subrank between the types of num1 and num2, arguments of integer type are considered to have the same floating-point conversion rank as double.

If no such floating-point type with the greatest rank and subrank exists, then overload resolution does not result in a usable candidate from the overloads provided.

πŸ”₯ Example πŸ”₯

// Run this code

#include <cmath>
#include <iostream>

int main()
{
    // spot check for nu == 0
    const double x = 1.2345;
    std::cout << "I_0(" << x << ") = " << std::cyl_bessel_i(0, x) << '\n';

    // series expansion for I_0
    double fct = 1;
    double sum = 0;
    for (int k = 0; k < 5; fct *= ++k)
    {
        sum += std::pow(x / 2, 2 * k) / std::pow(fct, 2);
        std::cout << "sum = " << sum << '\n';
    }
}

Output:

I_0(1.2345) = 1.41886
sum = 1
sum = 1.381
sum = 1.41729
sum = 1.41882
sum = 1.41886

πŸ‘‘ See also πŸ‘‘

  • cyl_bessel_j
  • cyl_bessel_jf
  • cyl_bessel_jl β€” cylindrical Bessel functions (of the first kind)
  • (C++17) (function)
  • (C++17)
  • (C++17)

Weisstein, Eric W. "Modified Bessel Function of the First Kind." From MathWorld β€” A Wolfram Web Resource.


okay that's the whole page, bestie 🫢 source: http://cppreference.com; version/date: 2024.06.10; footer manual name: std::cyl_be...yl_bessel_il(3) β€” go be iconic with your modified Bessel functions πŸ’–βœ¨

πŸ“¦ where this page comes from