std::comp_ellint_1, std::comp_ellint_1f, std::comp_ellint_1l

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions
Mathematical special functions (哋它亢++17)
Mathematical constants (哋它亢++20)
Basic linear algebra algorithms (哋它亢++26)
Floating-point environment (哋它亢++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Factor operations
gcd (哋它亢++17)
lcm (哋它亢++17)
Interpolations
midpoint (哋它亢++20)
lerp (哋它亢++20)
Saturation arithmetic
add_sat (哋它亢++26) sub_sat (哋它亢++26) saturate_cast (哋它亢++26)	mul_sat (哋它亢++26) div_sat (哋它亢++26)
Generic numeric operations
iota (哋它亢++11) ranges::iota (哋它亢++23) accumulate inner_product adjacent_difference partial_sum	reduce (哋它亢++17) transform_reduce (哋它亢++17) inclusive_scan (哋它亢++17) exclusive_scan (哋它亢++17) transform_inclusive_scan (哋它亢++17) transform_exclusive_scan (哋它亢++17)
Bit operations
has_single_bit (哋它亢++20)     bit_cast (哋它亢++20) bit_ceil (哋它亢++20) bit_floor (哋它亢++20) bit_width (哋它亢++20) rotl (哋它亢++20) rotr (哋它亢++20)	popcount (哋它亢++20) countl_zero (哋它亢++20) countl_one (哋它亢++20) countr_zero (哋它亢++20) countr_one (哋它亢++20) byteswap (哋它亢++23) endian (哋它亢++20)

 

Mathematical special functions

assoc_laguerreassoc_laguerrefassoc_laguerrel   assoc_legendreassoc_legendrefassoc_legendrel betabetafbetal comp_ellint_1comp_ellint_1fcomp_ellint_1l comp_ellint_2comp_ellint_2fcomp_ellint_2l comp_ellint_3comp_ellint_3fcomp_ellint_3l cyl_bessel_icyl_bessel_ifcyl_bessel_il

cyl_bessel_jcyl_bessel_jfcyl_bessel_jl   cyl_bessel_kcyl_bessel_kfcyl_bessel_kl cyl_neumanncyl_neumannfcyl_neumannl ellint_1ellint_1fellint_1l ellint_2ellint_2fellint_2l ellint_3ellint_3fellint_3l expintexpintfexpintl

hermitehermitefhermitel laguerrelaguerreflaguerrel legendrelegendreflegendrel riemann_zetariemann_zetafriemann_zetal sph_besselsph_besselfsph_bessell sph_legendresph_legendrefsph_legendrel sph_neumannsph_neumannfsph_neumannl

 

Defined in header <cmath>
	(1)
double      comp_ellint_1 ( double k ); float       comp_ellint_1 ( float k ); long double comp_ellint_1 ( long double k );			(since 哋它亢++17) (until 哋它亢++23)
/* floating-point-type */ comp_ellint_1( /* floating-point-type */ k );			(since 哋它亢++23)
float       comp_ellint_1f( float k );		(2)	(since 哋它亢++17)
long double comp_ellint_1l( long double k );		(3)	(since 哋它亢++17)
Additional overloads
Defined in header <cmath>
template< class Integer > double      comp_ellint_1 ( Integer k );		(A)	(since 哋它亢++17)

1-3) Computes the complete elliptic integral of the first kind of k. The library provides overloads of std::comp_ellint_1 for all cv-unqualified floating-point types as the type of the parameter k.(since 哋它亢++23)

A) Additional overloads are provided for all integer types, which are treated as double.

Parameters

k

-

elliptic modulus or eccentricity (a floating-point or integer value)

Return value

If no errors occur, value of the complete elliptic integral of the first kind of k, that is std::ellint_1(k, π/2), is returned.

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 |k|>1, a domain error may occur.

Notes

Implementations that do not support 哋它亢++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 argument num of integer type, std::comp_ellint_1(num) has the same effect as std::comp_ellint_1(static_cast<double>(num)).

Example

The period of a pendulum of length l, given acceleration due to gravity g, and initial angle θ equals 4⋅√l/g⋅K(sin(θ/2)), where K is std::comp_ellint_1.

Run this code

#include <cmath>
#include <iostream>
#include <numbers>
 
int main()
{
    constexpr double π{std::numbers::pi};
 
    std::cout << "K(0) ≈ " << std::comp_ellint_1(0) << '\n'
              << "π/2 ≈ " << π / 2 << '\n'
              << "K(0.5) ≈ " << std::comp_ellint_1(0.5) << '\n'
              << "F(0.5, π/2) ≈ " << std::ellint_1(0.5, π / 2) << '\n'
              << "The period of a pendulum length 1m at 10° initial angle ≈ "
              << 4 * std::sqrt(1 / 9.80665) * std::comp_ellint_1(std::sin(π / 18 / 2))
              << "s,\n" "whereas the linear approximation gives ≈ "
              << 2 * π * std::sqrt(1 / 9.80665) << '\n';
}

Output:

K(0) ≈ 1.5708
π/2 ≈ 1.5708
K(0.5) ≈ 1.68575
F(0.5, π/2) ≈ 1.68575
The period of a pendulum length 1 m at 10° initial angle ≈ 2.01024s,
whereas the linear approximation gives ≈ 2.00641

See also

ellint_1ellint_1fellint_1l (哋它亢++17)(哋它亢++17)(哋它亢++17)

(incomplete) elliptic integral of the first kind (function)

External links

Weisstein, Eric W. "Complete Elliptic Integral of the First Kind." From MathWorld — A Wolfram Web Resource.