std::ellint_1, std::ellint_1f, std::ellint_1l

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
gcd (C++17)	lcm (C++17)
Interpolations
midpoint (C++20)	lerp (C++20)
Saturation arithmetic
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
Generic numeric operations
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
Bit operations
has_single_bit (C++20)     bit_cast (C++20) bit_ceil (C++20) bit_floor (C++20) bit_width (C++20) rotl (C++20) rotr (C++20)	popcount (C++20) countl_zero (C++20) countl_one (C++20) countr_zero (C++20) countr_one (C++20) byteswap (C++23) endian (C++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)
float       ellint_1 ( float k, float phi ); double      ellint_1 ( double k, double phi ); long double ellint_1 ( long double k, long double phi );			(since C++17) (until C++23)
/* floating-point-type */ ellint_1( /* floating-point-type */ k,                                     /* floating-point-type */ phi );			(since C++23)
float       ellint_1f( float k, float phi );		(2)	(since C++17)
long double ellint_1l( long double k, long double phi );		(3)	(since C++17)
Additional overloads
Defined in header <cmath>
template< class Arithmetic1, class Arithmetic2 > /* common-floating-point-type */     ellint_1( Arithmetic1 k, Arithmetic2 phi );		(A)	(since C++17)

1-3) Computes the incomplete elliptic integral of the first kind of k and phi. The library provides overloads of std::ellint_1 for all cv-unqualified floating-point types as the type of the parameters k and phi.(since C++23)

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

Parameters

k	-	elliptic modulus or eccentricity (a floating-point or integer value)
phi	-	Jacobi amplitude (a floating-point or integer value, measured in radians)

Return value

If no errors occur, value of the incomplete elliptic integral of the first kind of k and phi, that is ∫phi
0

dθ

√1-k2 sin2 θ

, 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 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::ellint_1(num1, num2) has the same effect as std::ellint_1(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::ellint_1(num1, num2) has the same effect as std::ellint_1(static_cast<double>(num1),               static_cast<double>(num2)). Otherwise, if num1 or num2 has type float, then std::ellint_1(num1, num2) has the same effect as std::ellint_1(static_cast<float>(num1),               static_cast<float>(num2)).

(until C++23)

If num1 and num2 have arithmetic types, then std::ellint_1(num1, num2) has the same effect as std::ellint_1(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.

(since C++23)

Example

Run this code

#include <cmath>
#include <iostream>
#include <numbers>
 
int main()
{
    const double hpi = std::numbers::pi / 2.0;
 
    std::cout << "F(0,π/2)  = " << std::ellint_1(0, hpi) << '\n'
              << "F(0,-π/2) = " << std::ellint_1(0, -hpi) << '\n'
              << "π/2       = " << hpi << '\n'
              << "F(0.7,0)  = " << std::ellint_1(0.7, 0) << '\n';
}

Output:

F(0,π/2)  = 1.5708
F(0,-π/2) = -1.5708
π/2       = 1.5708
F(0.7,0)  = 0

See also

comp_ellint_1comp_ellint_1fcomp_ellint_1l (C++17)(C++17)(C++17)

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

External links

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