lsst.shapelet  tickets.DM-23835-g1eb20aa80b
Public Member Functions | Static Public Member Functions | List of all members
lsst::shapelet::PackedIndex Class Reference

An iterator-like object to help in traversing "packed" shapelet or Hermite polynomial matrix or vector dimensions. More...

#include <GaussHermiteEvaluator.h>

Public Member Functions

PackedIndexoperator++ ()
 
const int getOrder () const
 
const int getX () const
 
const int getY () const
 
const int getIndex () const
 
 PackedIndex ()
 
 PackedIndex (int const x, int const y)
 

Static Public Member Functions

static const int computeOffset (int order)
 
static const int computeIndex (int x, int y)
 

Detailed Description

An iterator-like object to help in traversing "packed" shapelet or Hermite polynomial matrix or vector dimensions.

A pair of indices (x,y) is mapped to the packed position i = (x+y)(x+y+1)/2 + x.

Typical usage is in a nested loop of the form:

for (PackedIndex i; i.getOrder() <= order; ++i) {
// utilize i
}

Definition at line 48 of file GaussHermiteEvaluator.h.

Constructor & Destructor Documentation

◆ PackedIndex() [1/2]

lsst::shapelet::PackedIndex::PackedIndex ( )
inline

Definition at line 71 of file GaussHermiteEvaluator.h.

◆ PackedIndex() [2/2]

lsst::shapelet::PackedIndex::PackedIndex ( int const  x,
int const  y 
)
inline

Definition at line 72 of file GaussHermiteEvaluator.h.

Member Function Documentation

◆ computeIndex()

static const int lsst::shapelet::PackedIndex::computeIndex ( int  x,
int  y 
)
inlinestatic

Definition at line 52 of file GaussHermiteEvaluator.h.

◆ computeOffset()

static const int lsst::shapelet::PackedIndex::computeOffset ( int  order)
inlinestatic

Definition at line 51 of file GaussHermiteEvaluator.h.

◆ getIndex()

const int lsst::shapelet::PackedIndex::getIndex ( ) const
inline

Definition at line 69 of file GaussHermiteEvaluator.h.

◆ getOrder()

const int lsst::shapelet::PackedIndex::getOrder ( ) const
inline

Definition at line 65 of file GaussHermiteEvaluator.h.

◆ getX()

const int lsst::shapelet::PackedIndex::getX ( ) const
inline

Definition at line 66 of file GaussHermiteEvaluator.h.

◆ getY()

const int lsst::shapelet::PackedIndex::getY ( ) const
inline

Definition at line 67 of file GaussHermiteEvaluator.h.

◆ operator++()

PackedIndex& lsst::shapelet::PackedIndex::operator++ ( )
inline

Definition at line 54 of file GaussHermiteEvaluator.h.


The documentation for this class was generated from the following file:
lsst::shapelet::PackedIndex::PackedIndex
PackedIndex()
Definition: GaussHermiteEvaluator.h:71