lsst::sphgeom::RangeSet::Iterator Struct Reference

A constant iterator over the ranges (represented as 2-tuples) in a RangeSet. More...

#include <RangeSet.h>

Public Types
using	difference_type = ptrdiff_t
using	value_type = std::tuple<uint64_t, uint64_t>
using	pointer = void
using	reference = std::tuple<uint64_t, uint64_t>
using	iterator_category = std::input_iterator_tag

Public Member Functions
	Iterator ()=default
	Iterator (uint64_t const *ptr)
Iterator &	operator++ ()
Iterator &	operator-- ()
Iterator	operator++ (int)
Iterator	operator-- (int)
Iterator	operator+ (ptrdiff_t n) const
Iterator	operator- (ptrdiff_t n) const
Iterator &	operator+= (ptrdiff_t n)
Iterator &	operator-= (ptrdiff_t n)
ptrdiff_t	operator- (Iterator const &i) const
bool	operator== (Iterator const &i) const
bool	operator!= (Iterator const &i) const
bool	operator< (Iterator const &i) const
bool	operator> (Iterator const &i) const
bool	operator<= (Iterator const &i) const
bool	operator>= (Iterator const &i) const
std::tuple< uint64_t, uint64_t >	operator* ()
std::tuple< uint64_t, uint64_t >	operator[] (ptrdiff_t n) const

Public Attributes
uint64_t const *	p = nullptr

Friends
void	swap (Iterator &a, Iterator &b)
Iterator	operator+ (ptrdiff_t n, Iterator const &i)

Detailed Description

A constant iterator over the ranges (represented as 2-tuples) in a RangeSet.

RangeSet does not store an array of 2-tuples internally. But, §24.2.5 of the C++11 standard requires the following from constant forward iterators:

• (1.3) The reference type of the iterator must be a reference to const value_type
• (6) If a and b are both dereferenceable, then a == b if and only if *a and *b are bound to the same object.

So, dereferencing a forward iterator cannot return by value, or return a reference to a member of the iterator itself. As a result, it seems impossible to provide more than an input iterator for container objects that do not store their values directly.

While this class only claims to be an input iterator, it nevertheless implements most random access iterator requirements. Dereferencing an iterator returns a tuple by value, and operator-> is omitted.

Definition at line 129 of file RangeSet.h.

Member Typedef Documentation

difference_type

using lsst::sphgeom::RangeSet::Iterator::difference_type = ptrdiff_t

Definition at line 131 of file RangeSet.h.

iterator_category

using lsst::sphgeom::RangeSet::Iterator::iterator_category = std::input_iterator_tag

Definition at line 135 of file RangeSet.h.

pointer

using lsst::sphgeom::RangeSet::Iterator::pointer = void

Definition at line 133 of file RangeSet.h.

reference

using lsst::sphgeom::RangeSet::Iterator::reference = std::tuple<uint64_t, uint64_t>

Definition at line 134 of file RangeSet.h.

value_type

using lsst::sphgeom::RangeSet::Iterator::value_type = std::tuple<uint64_t, uint64_t>

Definition at line 132 of file RangeSet.h.

Constructor & Destructor Documentation

Iterator() [1/2]

lsst::sphgeom::RangeSet::Iterator::Iterator ( )

default

Iterator() [2/2]

lsst::sphgeom::RangeSet::Iterator::Iterator ( uint64_t const * ptr )

inlineexplicit

Definition at line 138 of file RangeSet.h.

: p{ptr} {}

Member Function Documentation

operator!=()

bool lsst::sphgeom::RangeSet::Iterator::operator!= ( Iterator const & i ) const

inline

Definition at line 165 of file RangeSet.h.

{ return p != i.p; }

operator*()

std::tuple< uint64_t, uint64_t > lsst::sphgeom::RangeSet::Iterator::operator* ( )

inline

Definition at line 171 of file RangeSet.h.

                                                 {
            return std::make_tuple(p[0], p[1]);
        }

operator+()

Iterator lsst::sphgeom::RangeSet::Iterator::operator+ ( ptrdiff_t n ) const

inline

Definition at line 151 of file RangeSet.h.

{ return Iterator(p + 2 * n); }

operator++() [1/2]

Iterator & lsst::sphgeom::RangeSet::Iterator::operator++ ( )

inline

Definition at line 145 of file RangeSet.h.

{ p += 2; return *this; }

operator++() [2/2]

Iterator lsst::sphgeom::RangeSet::Iterator::operator++ ( int )

inline

Definition at line 148 of file RangeSet.h.

{ Iterator i(*this); p += 2; return i; }

operator+=()

Iterator & lsst::sphgeom::RangeSet::Iterator::operator+= ( ptrdiff_t n )

inline

Definition at line 154 of file RangeSet.h.

{ p += 2 * n; return *this; }

operator-() [1/2]

ptrdiff_t lsst::sphgeom::RangeSet::Iterator::operator- ( Iterator const & i ) const

inline

Definition at line 161 of file RangeSet.h.

{ return (p - i.p) / 2; }

operator-() [2/2]

Iterator lsst::sphgeom::RangeSet::Iterator::operator- ( ptrdiff_t n ) const

inline

Definition at line 152 of file RangeSet.h.

{ return Iterator(p + 2 * n); }

operator--() [1/2]

Iterator & lsst::sphgeom::RangeSet::Iterator::operator-- ( )

inline

Definition at line 146 of file RangeSet.h.

{ p -= 2; return *this; }

operator--() [2/2]

Iterator lsst::sphgeom::RangeSet::Iterator::operator-- ( int )

inline

Definition at line 149 of file RangeSet.h.

{ Iterator i(*this); p -= 2; return i; }

operator-=()

Iterator & lsst::sphgeom::RangeSet::Iterator::operator-= ( ptrdiff_t n )

inline

Definition at line 155 of file RangeSet.h.

{ p -= 2 * n; return *this; }

operator<()

bool lsst::sphgeom::RangeSet::Iterator::operator< ( Iterator const & i ) const

inline

Definition at line 166 of file RangeSet.h.

{ return p < i.p; }

operator<=()

bool lsst::sphgeom::RangeSet::Iterator::operator<= ( Iterator const & i ) const

inline

Definition at line 168 of file RangeSet.h.

{ return p <= i.p; }

operator==()

bool lsst::sphgeom::RangeSet::Iterator::operator== ( Iterator const & i ) const

inline

Definition at line 164 of file RangeSet.h.

{ return p == i.p; }

operator>()

bool lsst::sphgeom::RangeSet::Iterator::operator> ( Iterator const & i ) const

inline

Definition at line 167 of file RangeSet.h.

{ return p > i.p; }

operator>=()

bool lsst::sphgeom::RangeSet::Iterator::operator>= ( Iterator const & i ) const

inline

Definition at line 169 of file RangeSet.h.

{ return p >= i.p; }

operator[]()

std::tuple< uint64_t, uint64_t > lsst::sphgeom::RangeSet::Iterator::operator[] ( ptrdiff_t n ) const

inline

Definition at line 175 of file RangeSet.h.

                                                                   {
            return std::make_tuple(p[2 * n], p[2 * n + 1]);
        }

Friends And Related Symbol Documentation

operator+

Iterator operator+ ( ptrdiff_t n, Iterator const & i )

friend

Definition at line 157 of file RangeSet.h.

                                                                   {
            return i + n;
        }

swap

void swap ( Iterator & a, Iterator & b )

friend

Definition at line 140 of file RangeSet.h.

                                                     {
            std::swap(a.p, b.p);
        }

Member Data Documentation

p

uint64_t const* lsst::sphgeom::RangeSet::Iterator::p = nullptr

Definition at line 179 of file RangeSet.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/sphgeom/g8a8a8dda67+585e252eca/include/lsst/sphgeom/RangeSet.h