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

履歴 編集

function
<cmath>

# std::ellint_3(C++17)

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

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

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

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

## 概要

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

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

## 戻り値

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

## 備考

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

## 例

    #include <cmath>
    #include <iostream>

    constexpr double pi = 3.141592653589793;

    void p(double k, double nu) {
      for (double q : {0., 0.25, 0.5}) {
        std::cout << "ellint_3(" << k << ", " << nu << ", " << q << " pi) = ";
        try {
          std::cout << std::ellint_3(k, nu, q * pi) << "\n";
        } catch(const std::domain_error& e) {
          std::cout << "(domain_error)\n";
        }
      }
      std::cout << "\n";
    }

    int main() {
      p(0, -1);   // ellint_3(0, -1, phi) = atan(sqrt(2) * tan(phi)) / sqrt(2)
      p(0.5, -1);
      p(0, 0);    // ellint_3(0,  0, phi) = phi
      p(0.5, 0);
      p(0, 1);    // ellint_3(0,  1, phi) = tan(phi)
      p(0.5, 1);
    }

### 出力例

    ellint_3(0, -1, 0 pi) = 0
    ellint_3(0, -1, 0.25 pi) = 0.675511
    ellint_3(0, -1, 0.5 pi) = 1.11072

    ellint_3(0.5, -1, 0 pi) = 0
    ellint_3(0.5, -1, 0.25 pi) = 0.690078
    ellint_3(0.5, -1, 0.5 pi) = 1.17745

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

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

    ellint_3(0, 1, 0 pi) = 0
    ellint_3(0, 1, 0.25 pi) = 1
    ellint_3(0, 1, 0.5 pi) = (domain_error)

    ellint_3(0.5, 1, 0 pi) = 0
    ellint_3(0.5, 1, 0.25 pi) = 1.02866
    ellint_3(0.5, 1, 0.5 pi) = (domain_error)

## バージョン

### 言語

- C++17

### 処理系

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

### 備考

#### GCC (libstdc++)

GCC 7.1.0–8.0.0 では `1 - nu * sin^2(phi) < 0` のときに `std::domain_error` を送出する。

## 関連項目

- 第1種不完全楕円積分 `ellint_1`
- 第2種不完全楕円積分 `ellint_2`
- 第3種完全楕円積分 `comp_ellint_3`

## 参照

- 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`のオーバーロードに統合し、拡張浮動小数点数型も扱えるようにした