std::sph_legendre, std::sph_legendref, std::sph_legendrel

float       sph_legendre ( unsigned l, unsigned m, float theta );
double      sph_legendre ( unsigned l, unsigned m, double theta );
long double sph_legendre ( unsigned l, unsigned m, long double theta );

/* floating-point-type */ sph_legendre( unsigned l, unsigned m,
                                        /* floating-point-type */ theta );

float       sph_legendref( unsigned l, unsigned m, float theta );

long double sph_legendrel( unsigned l, unsigned m, long double theta );

template< class Integer >
double      sph_legendre ( unsigned l, unsigned m, Integer theta );

Параметры

Возвращаемое значение

Если ошибок не возникает, возвращается значение присоединённой сферической функции Лежандра (то есть сферической гармоники при ϕ = 0) для l, m и theta, где сферическая гармоническая функция определяется как Y

где P_ml(x) — std::assoc_legendre(l, m, x)), а |m|≤l.

Обратите внимание, что фазовый множитель Кондона — Шортли (-1)^m включён в это определение, поскольку он опущен в определении P_ml в std::assoc_legendre.

Обработка ошибок

Об ошибках может сообщаться согласно math_errhandling.

• Если аргумент равен NaN, возвращается NaN, и об ошибке области определения не сообщается.
• Если l≥128, поведение определяется реализацией.

Примечания

Реализации, не поддерживающие C++17, но поддерживающие ISO 29124:2010, предоставляют эту функцию, если реализация определяет __STDCPP_MATH_SPEC_FUNCS__ значением не меньше 201003L и если пользователь определяет __STDCPP_WANT_MATH_SPEC_FUNCS__ до включения любых заголовочных файлов стандартной библиотеки.

Реализации, не поддерживающие ISO 29124:2010, но поддерживающие TR 19768:2007 (TR1), предоставляют эту функцию в заголовочном файле tr1/cmath и пространстве имён std::tr1.

Реализация сферической гармонической функции доступна в boost.math; при вызове с параметром phi, равным нулю, она сводится к этой функции.

Дополнительные перегрузки не обязаны предоставляться в точности в виде (A). Они должны лишь обеспечивать, чтобы для аргумента num целочисленного типа std::sph_legendre(int_num1, int_num2, num) имело тот же эффект, что и std::sph_legendre(int_num1, int_num2, static_cast<double>(num)).

Пример

#include <cmath>
#include <iostream>
#include <numbers>

int main()
{
    // spot check for l=3, m=0
    double x = 1.2345;
    std::cout << "Y_3^0(" << x << ") = " << std::sph_legendre(3, 0, x) << '\n';

    // exact solution
    std::cout << "exact solution = "
              << 0.25 * std::sqrt(7 / std::numbers::pi)
                  * (5 * std::pow(std::cos(x), 3) - 3 * std::cos(x))
              << '\n';
}

Y_3^0(1.2345) = -0.302387
exact solution = -0.302387

См. также

Внешние ссылки