Developer documentation
Version 3.0.3-105-gd3941f44
Public Types | Public Member Functions | Protected Attributes | List of all members
MR::Math::SH::PrecomputedAL< ValueType > Class Template Reference
Spherical Harmonics

Precomputed Associated Legrendre Polynomials - used to speed up SH calculation. More...

#include "math/SH.h"

Public Types

using value_type = ValueType
 

Public Member Functions

 PrecomputedAL ()
 
 PrecomputedAL (int up_to_lmax, int num_dir=512)
 
bool operator! () const
 
 operator bool () const
 
void init (int up_to_lmax, int num_dir=512)
 
void set (PrecomputedFraction< ValueType > &f, const ValueType elevation) const
 
ValueType get (const PrecomputedFraction< ValueType > &f, int i) const
 
ValueType get (const PrecomputedFraction< ValueType > &f, int l, int m) const
 
void get (ValueType *dest, const PrecomputedFraction< ValueType > &f) const
 
template<class VectorType , class UnitVectorType >
ValueType value (const VectorType &val, const UnitVectorType &unit_dir) const
 

Protected Attributes

int lmax
 
int ndir
 
int nAL
 
ValueType inc
 
vector< ValueType > AL
 

Detailed Description

template<typename ValueType>
class MR::Math::SH::PrecomputedAL< ValueType >

Precomputed Associated Legrendre Polynomials - used to speed up SH calculation.

Definition at line 399 of file SH.h.

Member Typedef Documentation

◆ value_type

template<typename ValueType >
using MR::Math::SH::PrecomputedAL< ValueType >::value_type = ValueType

Definition at line 402 of file SH.h.

Constructor & Destructor Documentation

◆ PrecomputedAL() [1/2]

template<typename ValueType >
MR::Math::SH::PrecomputedAL< ValueType >::PrecomputedAL ( )
inline

Definition at line 404 of file SH.h.

◆ PrecomputedAL() [2/2]

template<typename ValueType >
MR::Math::SH::PrecomputedAL< ValueType >::PrecomputedAL ( int  up_to_lmax,
int  num_dir = 512 
)
inline

Definition at line 405 of file SH.h.

Member Function Documentation

◆ get() [1/3]

template<typename ValueType >
ValueType MR::Math::SH::PrecomputedAL< ValueType >::get ( const PrecomputedFraction< ValueType > &  f,
int  i 
) const
inline

Definition at line 457 of file SH.h.

◆ get() [2/3]

template<typename ValueType >
ValueType MR::Math::SH::PrecomputedAL< ValueType >::get ( const PrecomputedFraction< ValueType > &  f,
int  l,
int  m 
) const
inline

Definition at line 462 of file SH.h.

◆ get() [3/3]

template<typename ValueType >
void MR::Math::SH::PrecomputedAL< ValueType >::get ( ValueType *  dest,
const PrecomputedFraction< ValueType > &  f 
) const
inline

Definition at line 466 of file SH.h.

◆ init()

template<typename ValueType >
void MR::Math::SH::PrecomputedAL< ValueType >::init ( int  up_to_lmax,
int  num_dir = 512 
)
inline

Definition at line 416 of file SH.h.

◆ operator bool()

template<typename ValueType >
MR::Math::SH::PrecomputedAL< ValueType >::operator bool ( ) const
inline

Definition at line 412 of file SH.h.

◆ operator!()

template<typename ValueType >
bool MR::Math::SH::PrecomputedAL< ValueType >::operator! ( ) const
inline

Definition at line 409 of file SH.h.

◆ set()

template<typename ValueType >
void MR::Math::SH::PrecomputedAL< ValueType >::set ( PrecomputedFraction< ValueType > &  f,
const ValueType  elevation 
) const
inline

Definition at line 435 of file SH.h.

◆ value()

template<typename ValueType >
template<class VectorType , class UnitVectorType >
ValueType MR::Math::SH::PrecomputedAL< ValueType >::value ( const VectorType &  val,
const UnitVectorType &  unit_dir 
) const
inline

Definition at line 476 of file SH.h.

Member Data Documentation

◆ AL

template<typename ValueType >
vector<ValueType> MR::Math::SH::PrecomputedAL< ValueType >::AL
protected

Definition at line 500 of file SH.h.

◆ inc

template<typename ValueType >
ValueType MR::Math::SH::PrecomputedAL< ValueType >::inc
protected

Definition at line 499 of file SH.h.

◆ lmax

template<typename ValueType >
int MR::Math::SH::PrecomputedAL< ValueType >::lmax
protected

Definition at line 498 of file SH.h.

◆ nAL

template<typename ValueType >
int MR::Math::SH::PrecomputedAL< ValueType >::nAL
protected

Definition at line 498 of file SH.h.

◆ ndir

template<typename ValueType >
int MR::Math::SH::PrecomputedAL< ValueType >::ndir
protected

Definition at line 498 of file SH.h.

The documentation for this class was generated from the following file: