Healpix C++  3.82
Public Member Functions | Static Public Member Functions | List of all members
Alm_Base Class Reference

#include <alm.h>

Inheritance diagram for Alm_Base:
Alm< T >

Public Member Functions

 Alm_Base (int lmax_=0, int mmax_=0)
 
void Set (int lmax_, int mmax_)
 
int Lmax () const
 
int Mmax () const
 
int index_l0 (int m) const
 
int index (int l, int m) const
 
bool conformable (const Alm_Base &other) const
 
void swap (Alm_Base &other)
 

Static Public Member Functions

static tsize Num_Alms (int l, int m)
 

Detailed Description

Base class for calculating the storage layout of spherical harmonic coefficients.

Definition at line 42 of file alm.h.

Constructor & Destructor Documentation

◆ Alm_Base()

Alm_Base::Alm_Base ( int  lmax_ = 0,
int  mmax_ = 0 
)
inline

Constructs an Alm_Base object with given lmax and mmax.

Definition at line 53 of file alm.h.

Member Function Documentation

◆ Num_Alms()

tsize Alm_Base::Num_Alms ( int  l,
int  m 
)
static

Returns the total number of coefficients for maximum quantum numbers l and m.

Definition at line 39 of file alm.cc.

◆ Set()

void Alm_Base::Set ( int  lmax_,
int  mmax_ 
)
inline

Changes the object's maximum quantum numbers to lmax and mmax.

Definition at line 57 of file alm.h.

◆ Lmax()

int Alm_Base::Lmax ( ) const
inline

Returns the maximum l

Definition at line 65 of file alm.h.

◆ Mmax()

int Alm_Base::Mmax ( ) const
inline

Returns the maximum m

Definition at line 67 of file alm.h.

◆ index_l0()

int Alm_Base::index_l0 ( int  m) const
inline

Returns an array index for a given m, from which the index of a_lm can be obtained by adding l.

Definition at line 71 of file alm.h.

◆ index()

int Alm_Base::index ( int  l,
int  m 
) const
inline

Returns the array index of the specified coefficient.

Definition at line 75 of file alm.h.

◆ conformable()

bool Alm_Base::conformable ( const Alm_Base other) const
inline

Returns true, if both objects have the same lmax and mmax, else false.

Definition at line 80 of file alm.h.

◆ swap()

void Alm_Base::swap ( Alm_Base other)

Swaps the contents of two Alm_Base objects.

Definition at line 45 of file alm.cc.


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

Generated on Thu Jul 28 2022 17:32:07 for Healpix C++