sph_legendre.md

sph_legendre

• cmath[meta header]
• function[meta id-type]
• std[meta namespace]
• [mathjax enable]
• cpp17[meta cpp]

namespace std {
  double
    sph_legendre(unsigned int l,
                 unsigned int m,
                 double theta);               // (1) C++17
  floating-point-type
    sph_legendre(unsigned int l,
                 unsigned int m,
                 floating-point-type theta);  // (1) C++23

  Promoted
    sph_legendre(unsigned int l,
                 unsigned int m,
                 Arithmetic theta);           // (2) C++17

  float
    sph_legendref(unsigned int l,
                  unsigned int m,
                  float theta);               // (3) C++17

  long double
    sph_legendrel(unsigned int l,
                  unsigned int m,
                  long double theta);         // (4) C++17
}

• Promoted[italic]
• Arithmetic[italic]

概要

球面調和関数 (spherical harmonic function) の θ 成分を求める。

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

戻り値

引数 l, m, theta について $Y_l^m(\theta, 0)$ を返す。 $Y_l^m(\theta, \phi)$ は球面調和関数 $$ Y_l^m(\theta, \phi) = (-1)^m \sqrt{\frac{2l + 1}{4\pi} \frac{(l - m)!}{(l + m)!}} P_l^m(\cos \theta) \exp(i m \phi) \quad \text{for } |m| \le l $$ である。 $P_l^m$ はルジャンドル陪関数 (assoc_legendre) である。

備考

• l >= 128 の場合、この関数の呼び出しの効果は実装定義である
• (1) : C++23では、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

例

#include <cmath>
#include <complex>
#include <iostream>

constexpr double pi = 3.141592653589793;

// 球面調和関数
std::complex<double> sph_harmonics(unsigned l, unsigned m, double theta, double phi) {
  return std::sph_legendre(l, m, theta) * std::polar(1.0, m * phi);
}

int main() {
  constexpr unsigned l = 1;
  constexpr unsigned m = 1;
  // Y_1^1(θ, φ) = - sqrt(3 / 8π) |sin θ| exp(iφ)

  std::cout << "#θ / π\tφ / π\tY_" << l << "^" << m << "(θ, φ)\n";
  for (double t : {0., 0.25, 0.5, 0.75, 1.}) {
    double theta = t * pi;
    for (double p : {0., 0.25, 0.5, 0.75, 1., 1.25, 1.5, 1.75, 2.}) {
      double phi = p * pi / 4;
      std::cout << t << "\t" << p << "\t" << sph_harmonics(l, m, theta, phi) << "\n";
      if (t == 0 || t == 1) break;
    }
  }
}

• std::sph_legendre[color ff0000]
• std::polar[link /reference/complex/complex/polar.md]

出力例

#θ / π	φ / π	Y_1^1(θ, φ)
0	0	(0,0)
0.25	0	(-0.244301,-0)
0.25	0.25	(-0.239607,-0.0476608)
0.25	0.5	(-0.225705,-0.09349)
0.25	0.75	(-0.203129,-0.135727)
0.25	1	(-0.172747,-0.172747)
0.25	1.25	(-0.135727,-0.203129)
0.25	1.5	(-0.09349,-0.225705)
0.25	1.75	(-0.0476608,-0.239607)
0.25	2	(-1.49591e-17,-0.244301)
0.5	0	(-0.345494,-0)
0.5	0.25	(-0.338856,-0.0674026)
0.5	0.5	(-0.319195,-0.132215)
0.5	0.75	(-0.287268,-0.191946)
0.5	1	(-0.244301,-0.244301)
0.5	1.25	(-0.191946,-0.287268)
0.5	1.5	(-0.132215,-0.319195)
0.5	1.75	(-0.0674026,-0.338856)
0.5	2	(-2.11554e-17,-0.345494)
0.75	0	(-0.244301,-0)
0.75	0.25	(-0.239607,-0.0476608)
0.75	0.5	(-0.225705,-0.09349)
0.75	0.75	(-0.203129,-0.135727)
0.75	1	(-0.172747,-0.172747)
0.75	1.25	(-0.135727,-0.203129)
0.75	1.5	(-0.09349,-0.225705)
0.75	1.75	(-0.0476608,-0.239607)
0.75	2	(-1.49591e-17,-0.244301)
1	0	(0,0)

バージョン

言語

• C++17

処理系

• Clang: ??
• GCC: 7.1.0
• ICC: ??
• Visual C++: ??

備考

GCC (libstdc++)

GCC 7.1.0–8.0.0 では l < m の場合 ($Y_l^m = 0$) std::domain_error を送出する。

関連項目

• ルジャンドル陪関数 assoc_legendre

参照

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