lsst.geom gf0d0fc72e1+a6fc7e2af0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst::geom::polynomials::Index2d Struct Reference

A custom tuple that relates the indices of two 1-d functions for x and y to the flattened index for the 2-d function they form. More...

#include <PackedIndex.h>

Public Member Functions

constexpr Index2d () noexcept
 Construct an index with zero entries. More...
 
constexpr Index2d (std::size_t flat_, std::size_t nx_, std::size_t ny_) noexcept
 Construct with the provided values. More...
 
constexpr bool operator== (Index2d const &other) const noexcept
 Equality comparison. More...
 
constexpr bool operator!= (Index2d const &other) const noexcept
 Inequality comparison. More...
 

Public Attributes

std::size_t flat
 Index into the flattened 2-d function. More...
 
std::size_t nx
 Index into the 1-d function for nx. More...
 
std::size_t ny
 Index into the 1-d functoin for ny. More...
 

Detailed Description

A custom tuple that relates the indices of two 1-d functions for x and y to the flattened index for the 2-d function they form.

The packing algorithm is not specified by Index2d itself; it is intended to be a common data structure for other classes that define possibly different algorithms (e.g. PackedIndexIterator).

Definition at line 69 of file PackedIndex.h.

Constructor & Destructor Documentation

◆ Index2d() [1/2]

constexpr lsst::geom::polynomials::Index2d::Index2d ( )
inlineconstexprnoexcept

Construct an index with zero entries.

Definition at line 72 of file PackedIndex.h.

◆ Index2d() [2/2]

constexpr lsst::geom::polynomials::Index2d::Index2d ( std::size_t  flat_,
std::size_t  nx_,
std::size_t  ny_ 
)
inlineconstexprnoexcept

Construct with the provided values.

Definition at line 75 of file PackedIndex.h.

Member Function Documentation

◆ operator!=()

constexpr bool lsst::geom::polynomials::Index2d::operator!= ( Index2d const &  other) const
inlineconstexprnoexcept

Inequality comparison.

Definition at line 85 of file PackedIndex.h.

◆ operator==()

constexpr bool lsst::geom::polynomials::Index2d::operator== ( Index2d const &  other) const
inlineconstexprnoexcept

Equality comparison.

Definition at line 80 of file PackedIndex.h.

Member Data Documentation

◆ flat

std::size_t lsst::geom::polynomials::Index2d::flat

Index into the flattened 2-d function.

Definition at line 89 of file PackedIndex.h.

◆ nx

std::size_t lsst::geom::polynomials::Index2d::nx

Index into the 1-d function for nx.

Definition at line 90 of file PackedIndex.h.

◆ ny

std::size_t lsst::geom::polynomials::Index2d::ny

Index into the 1-d functoin for ny.

Definition at line 91 of file PackedIndex.h.


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