lsst::geom::polynomials::PackedIndexRange< packing > Class Template Reference

A specialized iterator range class for PackedIndexIterator, providing size calculation, comparison, and range-based for support. More...

#include <PackedIndex.h>

Public Types
using	iterator = PackedIndexIterator< packing >
using	const_iterator = iterator
using	value_type = typename iterator::value_type
using	reference = typename iterator::reference
using	pointer = typename iterator::pointer
using	difference_type = typename iterator::difference_type
using	size_type = std::size_t

Public Member Functions
constexpr	PackedIndexRange (iterator first, iterator last) noexcept
	Construct from begin and end iterators. More...
constexpr iterator	begin () const noexcept
	Return an iterator to the start of the range. More...
constexpr iterator	cbegin () const noexcept
	Return an iterator to the start of the range. More...
constexpr iterator	end () const noexcept
	Return an iterator to one past the end of the range. More...
constexpr iterator	cend () const noexcept
	Return an iterator to one past the end of the range. More...
constexpr std::size_t	size () const noexcept
	Return the number of elements in the flattened expansion. More...
constexpr bool	empty () const noexcept
	Return true if the number of elements in the flattened expansion is zero. More...
constexpr bool	operator== (PackedIndexRange const &other) const noexcept
	Equality comparison. More...
constexpr bool	operator!= (PackedIndexRange const &other) const noexcept
	Inequality comparison. More...

Static Public Member Functions
static constexpr std::size_t	computeOffset (std::size_t order) noexcept
	Return the flattened offset to the start of the given order. More...
static constexpr std::size_t	computeSize (std::size_t order) noexcept
	Return the flattened size of an expansion with the given maximum order (inclusive). More...
static constexpr std::size_t	computeIndex (std::size_t nx, std::size_t ny) noexcept
	Return the flattened index for the element with the given x and y orders. More...

Detailed Description

template<PackingOrder packing>
class lsst::geom::polynomials::PackedIndexRange< packing >

A specialized iterator range class for PackedIndexIterator, providing size calculation, comparison, and range-based for support.

See also

PackedIndexIterator for information on the packing algorithm.

Definition at line 248 of file PackedIndex.h.

Member Typedef Documentation

const_iterator

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::const_iterator = iterator

Definition at line 252 of file PackedIndex.h.

difference_type

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::difference_type = typename iterator::difference_type

Definition at line 256 of file PackedIndex.h.

iterator

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::iterator = PackedIndexIterator<packing>

Definition at line 251 of file PackedIndex.h.

pointer

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::pointer = typename iterator::pointer

Definition at line 255 of file PackedIndex.h.

reference

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::reference = typename iterator::reference

Definition at line 254 of file PackedIndex.h.

size_type

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::size_type = std::size_t

Definition at line 257 of file PackedIndex.h.

value_type

template<PackingOrder packing>

using lsst::geom::polynomials::PackedIndexRange< packing >::value_type = typename iterator::value_type

Definition at line 253 of file PackedIndex.h.

Constructor & Destructor Documentation

PackedIndexRange()

template<PackingOrder packing>

constexpr lsst::geom::polynomials::PackedIndexRange< packing >::PackedIndexRange ( iterator  first, iterator  last  )

inlineconstexprnoexcept

Construct from begin and end iterators.

Definition at line 275 of file PackedIndex.h.

                                                                       :
        _begin(first),
        _end(last)
    {}

Member Function Documentation

begin()

template<PackingOrder packing>

constexpr iterator lsst::geom::polynomials::PackedIndexRange< packing >::begin ( ) const

inlineconstexprnoexcept

Return an iterator to the start of the range.

Definition at line 281 of file PackedIndex.h.

{ return _begin; }

cbegin()

template<PackingOrder packing>

constexpr iterator lsst::geom::polynomials::PackedIndexRange< packing >::cbegin ( ) const

inlineconstexprnoexcept

Return an iterator to the start of the range.

Definition at line 284 of file PackedIndex.h.

{ return _begin; }

cend()

template<PackingOrder packing>

constexpr iterator lsst::geom::polynomials::PackedIndexRange< packing >::cend ( ) const

inlineconstexprnoexcept

Return an iterator to one past the end of the range.

Definition at line 290 of file PackedIndex.h.

{ return _end; }

computeIndex()

template<PackingOrder packing>

static constexpr std::size_t lsst::geom::polynomials::PackedIndexRange< packing >::computeIndex ( std::size_t  nx, std::size_t  ny  )

inlinestaticconstexprnoexcept

Return the flattened index for the element with the given x and y orders.

Definition at line 270 of file PackedIndex.h.

                                                                                 {
        return iterator::computeIndex(nx, ny);
    }

computeOffset()

template<PackingOrder packing>

static constexpr std::size_t lsst::geom::polynomials::PackedIndexRange< packing >::computeOffset ( std::size_t  order )

inlinestaticconstexprnoexcept

Return the flattened offset to the start of the given order.

Definition at line 260 of file PackedIndex.h.

                                                                       {
        return iterator::computeOffset(order);
    }

computeSize()

template<PackingOrder packing>

static constexpr std::size_t lsst::geom::polynomials::PackedIndexRange< packing >::computeSize ( std::size_t  order )

inlinestaticconstexprnoexcept

Return the flattened size of an expansion with the given maximum order (inclusive).

Definition at line 265 of file PackedIndex.h.

                                                                     {
        return iterator::computeSize(order);
    }

empty()

template<PackingOrder packing>

constexpr bool lsst::geom::polynomials::PackedIndexRange< packing >::empty ( ) const

inlineconstexprnoexcept

Return true if the number of elements in the flattened expansion is zero.

Definition at line 296 of file PackedIndex.h.

{ return size() == 0u; }

end()

template<PackingOrder packing>

constexpr iterator lsst::geom::polynomials::PackedIndexRange< packing >::end ( ) const

inlineconstexprnoexcept

Return an iterator to one past the end of the range.

Definition at line 287 of file PackedIndex.h.

{ return _end; }

operator!=()

template<PackingOrder packing>

constexpr bool lsst::geom::polynomials::PackedIndexRange< packing >::operator!= ( PackedIndexRange< packing > const &  other ) const

inlineconstexprnoexcept

Inequality comparison.

Definition at line 304 of file PackedIndex.h.

                                                                             {
        return !(*this == other);
    }

operator==()

template<PackingOrder packing>

constexpr bool lsst::geom::polynomials::PackedIndexRange< packing >::operator== ( PackedIndexRange< packing > const &  other ) const

inlineconstexprnoexcept

Equality comparison.

Definition at line 299 of file PackedIndex.h.

                                                                             {
        return _begin == other._begin && _end == other._end;
    }

size()

template<PackingOrder packing>

constexpr std::size_t lsst::geom::polynomials::PackedIndexRange< packing >::size ( ) const

inlineconstexprnoexcept

Return the number of elements in the flattened expansion.

Definition at line 293 of file PackedIndex.h.

{ return _end->flat - _begin->flat; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/geom/22.0.1-6-g8d3140d+720564cf76/include/lsst/geom/polynomials/PackedIndex.h