最終更新日時: 2024年06月11日 22時45分38秒 (JST)
Akira Takahashi が更新

履歴 編集

function
<cmath>

# std::ellint_1(C++17)

    namespace std {
      double
        ellint_1(double k,
                 double phi);              // (1) C++17
      floating-point-type
        ellint_1(floating-point-type k,
                 floating-point-type phi); // (1) C++23

      Promoted
        ellint_1(Arithmetic1 k,
                 Arithmetic2 phi);         // (2) C++17

      float
        ellint_1f(float k,
                  float phi);              // (3) C++17

      long double
        ellint_1l(long double k,
                  long double phi);        // (4) C++17
    }

## 概要

第1種不完全楕円積分 (incomplete elliptic integral of the first kind) を計算する。

- (1) :
  - C++17 : `double`に対するオーバーロード
  - C++23 : 浮動小数点数型に対するオーバーロード
- (2) : 算術型に対するオーバーロード (対応する大きい方の精度の浮動小数点数型にキャストして計算される)
- (3) : `float`型規定
- (4) : `long double`型規定

## 戻り値

引数 `k`, `phi` の第1種不完全楕円積分 $$ F(k, \phi) = \int_0^\phi \frac{\mathrm d\theta}{\sqrt{1 - k^2 \sin^2 \theta}} \quad \text{for } |k| \le 1 $$ を返す。

## 備考

- $ F(k, \pi/2) = K(k)$ (第1種完全楕円積分 `comp_ellint_1`)
- (1) : C++23では、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

## 例

    #include <cmath>
    #include <iostream>

    constexpr double pi = 3.141592653589793;

    void p(double k) {
      for (double q : {0., 0.25, 0.5})
        std::cout << "ellint_1(" << k << ", " << q << " pi) = " << std::ellint_1(k, q * pi) << "\n";
      std::cout << "\n";
    }

    int main() {
      p(0);   // ellint_1(0, phi) = phi
      p(0.5);
      p(1);   // ellint_1(1, phi) = log(tan(phi) + 1 / cos(phi)) for phi ∈ [-π/2, π/2]
    }

### 出力例

    ellint_1(0, 0 pi) = 0
    ellint_1(0, 0.25 pi) = 0.785398
    ellint_1(0, 0.5 pi) = 1.5708

    ellint_1(0.5, 0 pi) = 0
    ellint_1(0.5, 0.25 pi) = 0.804366
    ellint_1(0.5, 0.5 pi) = 1.68575

    ellint_1(1, 0 pi) = 0
    ellint_1(1, 0.25 pi) = 0.881374
    ellint_1(1, 0.5 pi) = nan

## バージョン

### 言語

- C++17

### 処理系

- Clang: ??
- GCC: 7.1.0 ✅
- ICC: ??
- Visual C++: ??

### 備考

#### GCC (libstdc++)

GCC 7.1.0–8.0.0 では `|k| == 1 && |phi| >= π / 2` の場合 `nan` を返す。

## 関連項目

- 第2種不完全楕円積分 `ellint_2`
- 第3種不完全楕円積分 `ellint_3`
- 第1種完全楕円積分 `comp_ellint_1`

## 参照

- N3060 JTC1.22.29124 Programming Language C++ — Special Math Functions
- WG21 P0226R1 Mathematical Special Functions for C++17, v5
- ISO/IEC 29124:2010 Information technology -- Programming languages, their environments and system software interfaces -- Extensions to the C++ Library to support mathematical special functions
- P1467R9 Extended floating-point types and standard names
  - C++23で導入された拡張浮動小数点数型への対応として、`float`、`double`、`long double`のオーバーロードを`floating-point-type`のオーバーロードに統合し、拡張浮動小数点数型も扱えるようにした