Useful class for representation of "sequence" of the objects through the range of valid iterators. More...

#include <GaudiUtils/Range.h>

Inheritance diagram for Gaudi::Range_< CONTAINER, ITERATOR >:

Collaboration diagram for Gaudi::Range_< CONTAINER, ITERATOR >:

Public Types
typedef std::pair< ITERATOR, ITERATOR >	Base

typedef Gaudi::details::container< CONTAINER >::Container	Container
	type for actual contained iterator More...

typedef ITERATOR	iterator

typedef ITERATOR	const_iterator

typedef iter_traits::value_type	value_type

typedef iter_traits::reference	reference

typedef iter_traits::reference	const_reference

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< iterator >	const_reverse_iterator

Public Member Functions

Range_ ()=default

internal types More...

template<typename InputIterator >

Range_ (InputIterator first, InputIterator last)

Constructor. More...

Range_ (const Base &base)

constructor from the pair of iterators More...

Range_ (const Container &cont)

constructor from the container More...

Range_ (iterator ibegin)

~Range_ ()=default

destructor More...

bool empty () const

empty sequence ? More...

size_t size () const

size of the sequence (number of elements) More...

iterator begin () const

access to begin of the sequence (const version ) More...

iterator end () const

access to end of the sequence (const version) More...

iterator cbegin () const

access to begin of the sequence (const version ) More...

iterator cend () const

access to end of the sequence (const version) More...

reverse_iterator rbegin () const

access to begin of the reversed sequence (const) More...

reverse_iterator rend () const

access to begin of the reversed sequence (const) More...

const_reference front () const

access for the first element (only for non-empty ranges!) More...

const_reference back () const

access for the back element (only for non-empty ranges!) More...

Range_ slice (long index1, long index2) const

get a "slice" of a range, in Python style More...

const_reference operator() (const size_t index) const

non-checked access to the elements by index (valid only for non-empty sequences) More...

const_reference operator[] (const long index) const

non-checked access to the elements by index (valid only for non-empty sequences) More...

const_reference at (const long index) const

Checked access to the elements by index (valid for all sequences)

Exceptions

GaudiException for out-of-range access.

More...

template<class C , class I >

bool operator< (const Range_< C, I > &right) const

compare with another range More...

template<class ANOTHERCONTAINER >

bool operator< (const ANOTHERCONTAINER &right) const

compare with another container More...

bool operator== (const Range_ &right) const

equality with another range More...

template<class CNT , class IT >

bool operator== (const Range_< CNT, IT > &right) const

equality with another range type More...

template<class ANOTHERCONTAINER >

bool operator== (const ANOTHERCONTAINER &right) const

compare with another container More...

bool operator! () const

empty sequence? More...

operator bool () const

non-empty sequence? More...

operator const Base & () const

conversion operator to the std::pair More...

const Base & base () const

conversion operator to the std::pair More...

Private Types
typedef std::iterator_traits< iterator >	iter_traits

Private Attributes
Base	m_base
	the base itself More...

Detailed Description

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>
class Gaudi::Range_< CONTAINER, ITERATOR >

Useful class for representation of "sequence" of the objects through the range of valid iterators.

The range could be created over ALL container types which supports at least bidirectional iterators.

The minimum requirements from the container type:

support the concept of "CONTAINER::value_type"
support the concept of "CONTAINER::const_iterator"
support the concept of "CONTAINER::const_reference"
support the concept of "CONTAINER::const_reverse_iterator"
the iterator should be ok for "std::distance" and "std::advance"
support for "const_iterator CONTAINER::begin () const"
support for "const_iterator CONTAINER::end () const"
support for "const_reverse_iterator CONTAINER::rbegin () const"
support for "const_reverse_iterator CONTAINER::rend () const"

Author: Vanya Belyaev Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date: 2002-07-12

Definition at line 88 of file Range.h.

Member Typedef Documentation

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef std::pair<ITERATOR, ITERATOR> Gaudi::Range_< CONTAINER, ITERATOR >::Base

Definition at line 92 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef ITERATOR Gaudi::Range_< CONTAINER, ITERATOR >::const_iterator

Definition at line 100 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef iter_traits::reference Gaudi::Range_< CONTAINER, ITERATOR >::const_reference

Definition at line 110 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef std::reverse_iterator<iterator> Gaudi::Range_< CONTAINER, ITERATOR >::const_reverse_iterator

Definition at line 113 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef Gaudi::details::container<CONTAINER>::Container Gaudi::Range_< CONTAINER, ITERATOR >::Container

type for actual contained iterator

Definition at line 97 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef std::iterator_traits<iterator> Gaudi::Range_< CONTAINER, ITERATOR >::iter_traits

private

Definition at line 104 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef ITERATOR Gaudi::Range_< CONTAINER, ITERATOR >::iterator

Definition at line 99 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef iter_traits::reference Gaudi::Range_< CONTAINER, ITERATOR >::reference

Definition at line 109 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef std::reverse_iterator<iterator> Gaudi::Range_< CONTAINER, ITERATOR >::reverse_iterator

Definition at line 112 of file Range.h.

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

typedef iter_traits::value_type Gaudi::Range_< CONTAINER, ITERATOR >::value_type

Definition at line 108 of file Range.h.

Constructor & Destructor Documentation

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::Range_ ( )

default

internal types

default constructor

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

template<typename InputIterator >

Gaudi::Range_< CONTAINER, ITERATOR >::Range_	(	InputIterator	first,
		InputIterator	last
	)

inline

Constructor.

Parameters

ibegin	iterator to begin of the sequence
iend	iterator to end of the sequence

Definition at line 125 of file Range.h.

                                                       : m_base( first, last )
     {
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::Range_ ( const Base & base )

inline

constructor from the pair of iterators

Parameters

base	pair of the iterators

Definition at line 131 of file Range.h.

131 : m_base( base ) {}

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

Gaudi::Range_::base

const Base & base() const

conversion operator to the std::pair

Definition: Range.h:270

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::Range_ ( const Container & cont )

inline

constructor from the container

Parameters

cont	reference to the container

Definition at line 135 of file Range.h.

135 : m_base( cont.begin(), cont.end() ) {}

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::Range_ ( iterator ibegin )

inline

Definition at line 139 of file Range.h.

139 : m_base( ibegin, ibegin ) {}

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::~Range_ ( )

default

destructor

Member Function Documentation

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const_reference Gaudi::Range_< CONTAINER, ITERATOR >::at ( const long index ) const

inline

Checked access to the elements by index (valid for all sequences)

Exceptions

GaudiException for out-of-range access.

Parameters

index the index of the element to be accessed

Definition at line 212 of file Range.h.

     {
       if ( index < 0 || index >= (long)size() ) {
         Gaudi::details::rangeException( index, size() );
       }
       return ( *this )( index );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const_reference Gaudi::Range_< CONTAINER, ITERATOR >::back ( ) const

inline

access for the back element (only for non-empty ranges!)

Definition at line 162 of file Range.h.

162 { return *std::prev( end() ); }

std::prev

T prev(T...args)

Gaudi::Range_::end

iterator end() const

access to end of the sequence (const version)

Definition: Range.h:150

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const Base& Gaudi::Range_< CONTAINER, ITERATOR >::base ( ) const

inline

conversion operator to the std::pair

Definition at line 270 of file Range.h.

270 { return m_base; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

iterator Gaudi::Range_< CONTAINER, ITERATOR >::begin ( ) const

inline

access to begin of the sequence (const version )

Definition at line 148 of file Range.h.

148 { return m_base.first; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

iterator Gaudi::Range_< CONTAINER, ITERATOR >::cbegin ( ) const

inline

access to begin of the sequence (const version )

Definition at line 152 of file Range.h.

152 { return m_base.first; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

iterator Gaudi::Range_< CONTAINER, ITERATOR >::cend ( ) const

inline

access to end of the sequence (const version)

Definition at line 154 of file Range.h.

154 { return m_base.second; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

bool Gaudi::Range_< CONTAINER, ITERATOR >::empty ( ) const

inline

empty sequence ?

Definition at line 144 of file Range.h.

144 { return m_base.second == m_base.first; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

iterator Gaudi::Range_< CONTAINER, ITERATOR >::end ( ) const

inline

access to end of the sequence (const version)

Definition at line 150 of file Range.h.

150 { return m_base.second; }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const_reference Gaudi::Range_< CONTAINER, ITERATOR >::front ( ) const

inline

access for the first element (only for non-empty ranges!)

Definition at line 160 of file Range.h.

160 { return *begin(); }

Gaudi::Range_::begin

iterator begin() const

access to begin of the sequence (const version )

Definition: Range.h:148

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::operator bool ( ) const

inlineexplicit

non-empty sequence?

Definition at line 263 of file Range.h.

263 { return !empty(); }

Gaudi::Range_::empty

bool empty() const

empty sequence ?

Definition: Range.h:144

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Gaudi::Range_< CONTAINER, ITERATOR >::operator const Base & ( ) const

inline

conversion operator to the std::pair

Definition at line 268 of file Range.h.

268 { return base(); }

Gaudi::Range_::base

const Base & base() const

conversion operator to the std::pair

Definition: Range.h:270

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator! ( ) const

inline

empty sequence?

Definition at line 261 of file Range.h.

261 { return empty(); }

Gaudi::Range_::empty

bool empty() const

empty sequence ?

Definition: Range.h:144

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const_reference Gaudi::Range_< CONTAINER, ITERATOR >::operator() ( const size_t index ) const

inline

non-checked access to the elements by index (valid only for non-empty sequences)

Parameters

index the index of the lement to be accessed

Definition at line 201 of file Range.h.

201 { return *std::next( begin(), index ); }

std::next

T next(T...args)

Gaudi::Range_::begin

iterator begin() const

access to begin of the sequence (const version )

Definition: Range.h:148

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

template<class C , class I >

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator< ( const Range_< C, I > & right ) const

inline

compare with another range

Definition at line 224 of file Range.h.

     {
       return std::lexicographical_compare( begin(), end(), right.begin(), right.end() );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

template<class ANOTHERCONTAINER >

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator< ( const ANOTHERCONTAINER & right ) const

inline

compare with another container

Definition at line 230 of file Range.h.

     {
       return std::lexicographical_compare( begin(), end(), right.begin(), right.end() );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator== ( const Range_< CONTAINER, ITERATOR > & right ) const

inline

equality with another range

Definition at line 238 of file Range.h.

     {
       if ( &right == this ) {
         return true;
       } // RETURN
       return right.size() == size() && std::equal( begin(), end(), right.begin() );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

template<class CNT , class IT >

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator== ( const Range_< CNT, IT > & right ) const

inline

equality with another range type

Definition at line 247 of file Range.h.

     {
       return right.size() == size() && std::equal( begin(), end(), right.begin() );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

template<class ANOTHERCONTAINER >

bool Gaudi::Range_< CONTAINER, ITERATOR >::operator== ( const ANOTHERCONTAINER & right ) const

inline

compare with another container

Definition at line 253 of file Range.h.

     {
       return right.size() == size() && std::equal( begin(), end(), right.begin() );
     }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

const_reference Gaudi::Range_< CONTAINER, ITERATOR >::operator[] ( const long index ) const

inline

non-checked access to the elements by index (valid only for non-empty sequences)

Parameters

index the index of the lement to be accessed

Definition at line 206 of file Range.h.

206 { return ( *this )( index ); }

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

reverse_iterator Gaudi::Range_< CONTAINER, ITERATOR >::rbegin ( ) const

inline

access to begin of the reversed sequence (const)

Definition at line 156 of file Range.h.

156 { return reverse_iterator( end() ); }

Gaudi::Range_::reverse_iterator

std::reverse_iterator< iterator > reverse_iterator

Definition: Range.h:112

Gaudi::Range_::end

iterator end() const

access to end of the sequence (const version)

Definition: Range.h:150

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

reverse_iterator Gaudi::Range_< CONTAINER, ITERATOR >::rend ( ) const

inline

access to begin of the reversed sequence (const)

Definition at line 158 of file Range.h.

158 { return reverse_iterator( begin() ); }

Gaudi::Range_::reverse_iterator

std::reverse_iterator< iterator > reverse_iterator

Definition: Range.h:112

Gaudi::Range_::begin

iterator begin() const

access to begin of the sequence (const version )

Definition: Range.h:148

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

size_t Gaudi::Range_< CONTAINER, ITERATOR >::size ( ) const

inline

size of the sequence (number of elements)

Definition at line 146 of file Range.h.

146 { return std::distance( m_base.first, m_base.second ); }

Gaudi::Range_::m_base

Base m_base

the base itself

Definition: Range.h:275

std::distance

T distance(T...args)

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Range_ Gaudi::Range_< CONTAINER, ITERATOR >::slice	(	long	index1,
		long	index2
	)		const

inline

get a "slice" of a range, in Python style

Definition at line 165 of file Range.h.

     {
       // trivial cases
       if ( empty() || index1 == index2 ) {
         return Range_();
       } // RETURN
       // adjust indices
       if ( index1 < 0 ) {
         index1 += size();
       }
       if ( index2 < 0 ) {
         index2 += size();
       }
       // check
       if ( index1 < 0 ) {
         return Range_();
       } // RETURN
       if ( index2 < index1 ) {
         return Range_();
       } // RETURN
 
       if ( index1 > (long)size() ) {
         return Range_();
       } // RETURN
       if ( index2 > (long)size() ) {
         index2 = size();
       }
 
       // construct the slice
       return Range_( std::next( begin(), index1 ), std::next( begin(), index2 ) ); // RETURN
     }

Member Data Documentation

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

Base Gaudi::Range_< CONTAINER, ITERATOR >::m_base

private

the base itself

Definition at line 275 of file Range.h.

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

GaudiKernel/GaudiKernel/Range.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator> class Gaudi::Range_< CONTAINER, ITERATOR >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>
class Gaudi::Range_< CONTAINER, ITERATOR >