LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
proxy::details::BoundaryListRangeIterator< BoundaryIter > Class Template Reference

Iterator exposing elements of a boundary list as ranges. More...

#include "AssociatedData.h"

Inheritance diagram for proxy::details::BoundaryListRangeIterator< BoundaryIter >:

Public Types

using boundary_iterator_t = BoundaryIter
 Type of boundary iterator. More...
 
using rangeview_t = decltype(makeBoundaryListRange(std::declval< boundary_iterator_t >()))
 Type of range returned when dereferencing. More...
 
using value_type = rangeview_t
 
using pointer = std::add_pointer_t< std::decay_t< value_type >>
 
using reference = std::add_lvalue_reference_t< std::decay_t< value_type >>
 

Static Public Member Functions

static auto transform (BoundaryIter const &iter)
 Returns the pointed range. More...
 

Private Types

using base_t = IteratorWrapperBase< BoundaryListRangeIterator< BoundaryIter >, BoundaryIter >
 

Detailed Description

template<typename BoundaryIter>
class proxy::details::BoundaryListRangeIterator< BoundaryIter >

Iterator exposing elements of a boundary list as ranges.

Template Parameters
BoundaryItertype of iterator to boundary iterators

This iterator wraps an iterator (BoundaryIter) to a sequence of iterators representing ranges of data. As an example, let the data be a collection of real numbers:

std::vector<float> data;

and we have a list of iterators that define subranges within that data:

using data_iterator_t = std::vector<data>::const_iterator;
std::vector<data_iterator_t> rangeStart;

Here rangeStart holds the begin iterator of each of the subranges, plus a "global" end iterator, as in the convention described in lar::makeBoundaryListRange() (which takes an iterator to rangeStart as argument). The BoundaryIter type in this example would be

.

When dereferenced, this iterator returns a view of the range currently pointed. This view has a STL-vector-like interface (again, see lar::makeBoundaryListRange()).

Definition at line 606 of file AssociatedData.h.

Member Typedef Documentation

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::base_t = IteratorWrapperBase <BoundaryListRangeIterator<BoundaryIter>, BoundaryIter>
private

Definition at line 611 of file AssociatedData.h.

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::boundary_iterator_t = BoundaryIter

Type of boundary iterator.

Definition at line 614 of file AssociatedData.h.

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::pointer = std::add_pointer_t<std::decay_t<value_type>>

Definition at line 621 of file AssociatedData.h.

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::rangeview_t = decltype(makeBoundaryListRange(std::declval<boundary_iterator_t>()))

Type of range returned when dereferencing.

Definition at line 618 of file AssociatedData.h.

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::reference = std::add_lvalue_reference_t<std::decay_t<value_type>>

Definition at line 622 of file AssociatedData.h.

template<typename BoundaryIter>
using proxy::details::BoundaryListRangeIterator< BoundaryIter >::value_type = rangeview_t

Definition at line 620 of file AssociatedData.h.

Member Function Documentation

template<typename BoundaryIter>
static auto proxy::details::BoundaryListRangeIterator< BoundaryIter >::transform ( BoundaryIter const &  iter)
inlinestatic

Returns the pointed range.

Returns
the pointed range, as a view

The returned value may be a view object, that is a pure interface overlaid on a different data structure. As such, it may be not copiable and need to be propagated by reference.

Definition at line 635 of file AssociatedData.h.

References proxy::details::makeBoundaryListRange().

636  { return makeBoundaryListRange(iter); }
BoundaryListRange< BoundaryIter > makeBoundaryListRange(BoundaryIter const &iBegin)
Reinterprets a iterator to boundaries list as a range collection.

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