Developer documentation
Version 3.0.3-105-gd3941f44
MR::Math::Legendre Namespace Reference

Functions

template<typename ValueType >
ValueType factorial (const ValueType n)
 
template<typename ValueType >
ValueType double_factorial (const ValueType n)
 
template<typename ValueType >
ValueType Plm (const int l, const int m, const ValueType x)
 
template<typename ValueType >
ValueType Plm_sph (const int l, const int m, const ValueType x)
 
template<typename VectorType >
void Plm_sph (VectorType &array, const int lmax, const int m, const typename VectorType::Scalar x)
 
template<typename VectorType >
void Plm_sph_deriv (VectorType &array, const int lmax, const int m, const typename VectorType::Scalar x)
 

Function Documentation

◆ double_factorial()

template<typename ValueType >
ValueType MR::Math::Legendre::double_factorial ( const ValueType  n)
inline

Definition at line 36 of file legendre.h.

◆ factorial()

template<typename ValueType >
ValueType MR::Math::Legendre::factorial ( const ValueType  n)
inline

Definition at line 30 of file legendre.h.

◆ Plm()

template<typename ValueType >
ValueType MR::Math::Legendre::Plm ( const int  l,
const int  m,
const ValueType  x 
)
inline

Definition at line 42 of file legendre.h.

◆ Plm_sph() [1/2]

template<typename ValueType >
ValueType MR::Math::Legendre::Plm_sph ( const int  l,
const int  m,
const ValueType  x 
)
inline

Definition at line 73 of file legendre.h.

◆ Plm_sph() [2/2]

template<typename VectorType >
void MR::Math::Legendre::Plm_sph ( VectorType &  array,
const int  lmax,
const int  m,
const typename VectorType::Scalar  x 
)
inline
Note
upon completion, the (l,m) value will be stored in array[l]. Entries in array for l<m will be left undefined.

Definition at line 101 of file legendre.h.

◆ Plm_sph_deriv()

template<typename VectorType >
void MR::Math::Legendre::Plm_sph_deriv ( VectorType &  array,
const int  lmax,
const int  m,
const typename VectorType::Scalar  x 
)
inline
Note
this function expects the previously computed array of associated Legendre functions to be stored in array, (as computed by Plm_sph (VectorType& array, const int lmax, const int m, const ValueType x)) and will overwrite the values in array with the derivatives

Definition at line 132 of file legendre.h.