DerivationFramework::TriggerMatchingUtils::RangedItr< T > Class Template Reference

utility class that acts wraps a bidirectional iterator. More...

#include <RangedItr.h>

Collaboration diagram for DerivationFramework::TriggerMatchingUtils::RangedItr< T >:

Public Types
using	iterator_category = std::bidirectional_iterator_tag
using	value_type = typename tr::value_type
using	reference = typename tr::reference
using	pointer = typename tr::pointer
using	difference_type = typename tr::difference_type

Public Member Functions
	RangedItr ()=default
	Default Constructor. More...
	RangedItr (const T &begin, const T &end)
	Construct from a beginning and an end. More...
	RangedItr (const T &begin, const T &end, const T &position)
	Construct from a beginning, an end and a starting position. More...
reference	operator* ()
	Iterator interface. More...
pointer	operator-> ()
RangedItr &	operator++ ()
RangedItr	operator++ (int)
RangedItr &	operator-- ()
RangedItr	operator-- (int)
bool	operator== (const RangedItr &other)
bool	operator!= (const RangedItr &other)
bool	exhausted () const
	Is this iterator exhausted? More...
void	restart ()
	Reset this iterator to its start. More...
RangedItr	begin () const
	Make this act as a range. More...
RangedItr	end () const
difference_type	size () const
	operator T () const
	Allow conversion back to the original iterator type. More...

Protected Types
using	tr = std::iterator_traits< T >

Private Attributes
T	m_begin
T	m_end
T	m_position

Detailed Description

template<typename T>
class DerivationFramework::TriggerMatchingUtils::RangedItr< T >

utility class that acts wraps a bidirectional iterator.

This class acts as both and range and an iterator.

Definition at line 18 of file RangedItr.h.

Member Typedef Documentation

difference_type

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::difference_type = typename tr::difference_type

Definition at line 30 of file RangedItr.h.

iterator_category

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::iterator_category = std::bidirectional_iterator_tag

Definition at line 26 of file RangedItr.h.

pointer

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::pointer = typename tr::pointer

Definition at line 29 of file RangedItr.h.

reference

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::reference = typename tr::reference

Definition at line 28 of file RangedItr.h.

tr

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::tr = std::iterator_traits<T>

protected

Definition at line 20 of file RangedItr.h.

value_type

template<typename T >

using DerivationFramework::TriggerMatchingUtils::RangedItr< T >::value_type = typename tr::value_type

Definition at line 27 of file RangedItr.h.

Constructor & Destructor Documentation

RangedItr() [1/3]

template<typename T >

DerivationFramework::TriggerMatchingUtils::RangedItr< T >::RangedItr ( )

default

Default Constructor.

RangedItr() [2/3]

template<typename T >

DerivationFramework::TriggerMatchingUtils::RangedItr< T >::RangedItr ( const T &  begin, const T &  end  )

inline

Construct from a beginning and an end.

Definition at line 36 of file RangedItr.h.

                                              : 
        RangedItr(begin, end, begin) {}

RangedItr() [3/3]

template<typename T >

DerivationFramework::TriggerMatchingUtils::RangedItr< T >::RangedItr ( const T &  begin, const T &  end, const T &  position  )

inline

Construct from a beginning, an end and a starting position.

Definition at line 40 of file RangedItr.h.

                                                                 :
        m_begin(begin), m_end(end), m_position(position) {}

Member Function Documentation

begin()

template<typename T >

RangedItr DerivationFramework::TriggerMatchingUtils::RangedItr< T >::begin ( ) const

inline

Make this act as a range.

Definition at line 84 of file RangedItr.h.

{ return RangedItr(m_begin, m_end, m_begin); }

end()

template<typename T >

RangedItr DerivationFramework::TriggerMatchingUtils::RangedItr< T >::end ( ) const

inline

Definition at line 85 of file RangedItr.h.

{ return RangedItr(m_begin, m_end, m_end); }

exhausted()

template<typename T >

bool DerivationFramework::TriggerMatchingUtils::RangedItr< T >::exhausted ( ) const

inline

Is this iterator exhausted?

Definition at line 78 of file RangedItr.h.

{ return m_position == m_end; }

operator T()

template<typename T >

DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator T ( ) const

inline

Allow conversion back to the original iterator type.

Definition at line 89 of file RangedItr.h.

{ return m_position; }

operator!=()

template<typename T >

bool DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator!= ( const RangedItr< T > &  other )

inline

Definition at line 73 of file RangedItr.h.

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

operator*()

template<typename T >

reference DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator* ( )

inline

Iterator interface.

Definition at line 44 of file RangedItr.h.

{ return m_position.operator*(); }

operator++() [1/2]

template<typename T >

RangedItr& DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator++ ( )

inline

Definition at line 47 of file RangedItr.h.

                              {
        ++m_position;
        return *this;
      }

operator++() [2/2]

template<typename T >

RangedItr DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator++ ( int  )

inline

Definition at line 51 of file RangedItr.h.

                                {
        RangedItr ret = *this;
        ++m_position;
        return ret;
      }

operator--() [1/2]

template<typename T >

RangedItr& DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator-- ( )

inline

Definition at line 57 of file RangedItr.h.

                              {
        --m_position;
        return *this;
      }

operator--() [2/2]

template<typename T >

RangedItr DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator-- ( int  )

inline

Definition at line 61 of file RangedItr.h.

                                {
        RangedItr ret = *this;
        --m_position;
        return ret;
      }

operator->()

template<typename T >

pointer DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator-> ( )

inline

Definition at line 45 of file RangedItr.h.

{ return m_position.operator->(); }

operator==()

template<typename T >

bool DerivationFramework::TriggerMatchingUtils::RangedItr< T >::operator== ( const RangedItr< T > &  other )

inline

Definition at line 67 of file RangedItr.h.

                                              {
        return m_begin == other.m_begin &&
                m_end == other.m_end &&
                m_position == other.m_position;
      }

restart()

template<typename T >

void DerivationFramework::TriggerMatchingUtils::RangedItr< T >::restart ( )

inline

Reset this iterator to its start.

Definition at line 81 of file RangedItr.h.

{ m_position = m_begin; }

size()

template<typename T >

difference_type DerivationFramework::TriggerMatchingUtils::RangedItr< T >::size ( ) const

inline

Definition at line 86 of file RangedItr.h.

{ return std::distance(m_begin, m_end); }

Member Data Documentation

m_begin

template<typename T >

T DerivationFramework::TriggerMatchingUtils::RangedItr< T >::m_begin

private

Definition at line 91 of file RangedItr.h.

m_end

template<typename T >

T DerivationFramework::TriggerMatchingUtils::RangedItr< T >::m_end

private

Definition at line 92 of file RangedItr.h.

m_position

template<typename T >

T DerivationFramework::TriggerMatchingUtils::RangedItr< T >::m_position

private

Definition at line 93 of file RangedItr.h.

---

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

• RangedItr.h