ellint_1

eve::ellint_1 = functor<ellint_1_t>

inlineconstexpr

Header file

#include <eve/module/elliptic.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto ellint_1(floating_value auto k)                                      noexcept; // 1
   constexpr auto ellint_1(floating_value auto phi, floating_value auto k)             noexcept; // 2
   constexpr auto ellint_2[modular](floating_value auto phi, floating_value auto alpha)noexcept; // 2
   constexpr auto ellint_2[eccentric](floating_value auto phi, floating_value auto m)  noexcept; // 2
 
   // Lanes masking
   constexpr auto ellint_1[conditional_expr auto c](/*any of the above overloads*/)    noexcept; // 3
   constexpr auto ellint_1[logical_value auto m](/*any of the above overloads*/)       noexcept; // 3
}

Parameters

• phi: floating Jacobi amplitude.
• k: floating elliptic modulus. k must satisfy \(k^2\sin^2\phi \le 1\) or the result is NaN. In the complete case this means \(|k| \le 1\).
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.

Return value

1. the complete elliptic integral of the first kind \(\mathbf{K}(k) = \int_0^{\pi/2} \frac{\mathrm{d}t}{\sqrt{1-k^2\sin^2 t}}\). (corresponding to \( \phi = \pi/2 \)) is returned.
2. the incomplete elliptic integral of the first kind is returned: \(\mathbf{F}(\phi, k) = \int_0^{\phi} \frac{\mathrm{d}t}{\sqrt{1-k^2\sin^2 t}}\)
3. The operation is performed conditionnaly

Note

Be aware that as \(\pi/2\) is not exactly represented by floating point values the result of the incomplete function with a \(\phi\) floating point value representing \(\pi/2\) can differ a lot with the result of the complete call.

External references

• C++ standard reference: ellint_1
• DLMF: Elliptic Integrals
• Wolfram MathWorld: Elliptic Integral

Example

// revision 1
#include <eve/module/elliptic.hpp>
#include <iostream>
 
eve::wide wf{1.0, 0.0, 0.75, 0.5};
eve::wide wphi{1.0, 1.0e-30, 0.5, 0.0};
 
int main(){
   std::cout << "<- wf   = " << wf << "\n";
   std::cout << "<- wphi = " << wphi << "\n";
 
   std::cout << "-> ellint_1(wf)                = " << eve::ellint_1(wf) << "\n";
   std::cout << "-> ellint_1(wphi, wf)          = " << eve::ellint_1(wphi, wf) << "\n";
   std::cout << "-> ellint_1[ignore_last(2)](wf)= " << eve::ellint_1[eve::ignore_last(2)](wf) << "\n";
   std::cout << "-> ellint_1[wf != 1.0](wf)     = " << eve::ellint_1[wf != -1.0f](wf) << "\n";
   std::cout << "-> ellint_1(pio_2[lower], wf)  = " << eve::ellint_1(eve::pio_2[eve::lower](eve::as(wphi)), wf) << '\n';
}