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
PackedIndex &	operator++ ()
int const	getOrder () const
int const	getX () const
int const	getY () const
int const	getIndex () const
	PackedIndex ()
	PackedIndex (int const x, int const y)

Static Public Member Functions
static int const	computeOffset (int order)
static int const	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.

: _n(0), _i(0), _x(0), _y(0) {}

PackedIndex() [2/2]

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

inline

Definition at line 72 of file GaussHermiteEvaluator.h.

: _n(x+y), _i(computeOffset(_n) + x), _x(x), _y(y) {}

Member Function Documentation

computeIndex()

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

inlinestatic

Definition at line 52 of file GaussHermiteEvaluator.h.

{ return computeOffset(x+y) + x; }

computeOffset()

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

inlinestatic

Definition at line 51 of file GaussHermiteEvaluator.h.

{ return order*(order+1)/2; }

getIndex()

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

inline

Definition at line 69 of file GaussHermiteEvaluator.h.

{ return _i; }

getOrder()

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

inline

Definition at line 65 of file GaussHermiteEvaluator.h.

{ return _n; }

getX()

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

inline

Definition at line 66 of file GaussHermiteEvaluator.h.

{ return _x; }

getY()

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

inline

Definition at line 67 of file GaussHermiteEvaluator.h.

{ return _y; }

operator++()

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

inline

Definition at line 54 of file GaussHermiteEvaluator.h.

                               {
        ++_i;
        if (--_y < 0) {
            _x = 0;
            _y = ++_n;
        } else {
            ++_x;
        }
        return *this;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/shapelet/22.0.1-1-g8e32f31+297cba6710/include/lsst/shapelet/GaussHermiteEvaluator.h