| The Gaudi Framework v29r1 (5cd95fa2)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
Gaudi::Range_< CONTAINER, ITERATOR > Class Template Reference

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 >:
[legend]
Collaboration diagram for Gaudi::Range_< CONTAINER, ITERATOR >:
[legend]

## 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...
| Range_ (iterator ibegin, iterator iend)
| 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 108 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 112 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 120 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 130 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 133 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 117 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 124 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 119 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 129 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 132 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 128 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>

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

Constructor.

Parameters

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

Definition at line 144 of file Range.h.

144 : m_base( ibegin, iend ) {}
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 148 of file Range.h.

148 : m_base( base ) {}
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
Gaudi::Range_::base
const Base & base() const
conversion operator to the std::pair
Definition: Range.h:287
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 152 of file Range.h.

152 : m_base( cont.begin(), cont.end() ) {}
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

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

Definition at line 156 of file Range.h.

156 : m_base( ibegin, ibegin ) {}
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 229 of file Range.h.

230 {
231 if ( index < 0 || index >= (long)size() ) {
232 Gaudi::details::rangeException( index, size() );
233 }
234 return ( *this )( index );
235 }
Gaudi::details::rangeException
GAUDI_API void rangeException(const long index, const size_t size)
Helpful function to throw an "out-of-range exception" for class Range_.
Definition: Range.cpp:30
Gaudi::Range_::size
size_t size() const
size of the sequence (number of elements)
Definition: Range.h:163
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 179 of file Range.h.

179 { 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:167
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 287 of file Range.h.

287 { return m_base; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 165 of file Range.h.

165 { return m_base.first; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 169 of file Range.h.

169 { return m_base.first; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 171 of file Range.h.

171 { return m_base.second; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

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

empty sequence ?

Definition at line 161 of file Range.h.

161 { return m_base.second == m_base.first; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 167 of file Range.h.

167 { return m_base.second; }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 177 of file Range.h.

177 { return *begin(); }
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

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

non-empty sequence?

Definition at line 280 of file Range.h.

280 { return !empty(); }
Gaudi::Range_::empty
bool empty() const
empty sequence ?
Definition: Range.h:161
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 285 of file Range.h.

285 { return base(); }
Gaudi::Range_::base
const Base & base() const
conversion operator to the std::pair
Definition: Range.h:287
template<class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>

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

empty sequence?

Definition at line 278 of file Range.h.

278 { return empty(); }
Gaudi::Range_::empty
bool empty() const
empty sequence ?
Definition: Range.h:161
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 218 of file Range.h.

218 { 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:165
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 241 of file Range.h.

242 {
243 return std::lexicographical_compare( begin(), end(), right.begin(), right.end() );
244 }
std::right
T right(T...args)
std::lexicographical_compare
T lexicographical_compare(T...args)
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 247 of file Range.h.

248 {
249 return std::lexicographical_compare( begin(), end(), right.begin(), right.end() );
250 }
std::right
T right(T...args)
std::lexicographical_compare
T lexicographical_compare(T...args)
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 255 of file Range.h.

256 {
257 if ( &right == this ) {
258 return true;
259 } // RETURN
260 return right.size() == size() && std::equal( begin(), end(), right.begin() );
261 }
std::right
T right(T...args)
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
Gaudi::Range_::size
size_t size() const
size of the sequence (number of elements)
Definition: Range.h:163
std::equal
T equal(T...args)
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 264 of file Range.h.

265 {
266 return right.size() == size() && std::equal( begin(), end(), right.begin() );
267 }
std::right
T right(T...args)
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
Gaudi::Range_::size
size_t size() const
size of the sequence (number of elements)
Definition: Range.h:163
std::equal
T equal(T...args)
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 270 of file Range.h.

271 {
272 return right.size() == size() && std::equal( begin(), end(), right.begin() );
273 }
std::right
T right(T...args)
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
Gaudi::Range_::size
size_t size() const
size of the sequence (number of elements)
Definition: Range.h:163
std::equal
T equal(T...args)
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 223 of file Range.h.

223 { 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 173 of file Range.h.

173 { return reverse_iterator( end() ); }
Gaudi::Range_::reverse_iterator
std::reverse_iterator< iterator > reverse_iterator
Definition: Range.h:132
Gaudi::Range_::end
iterator end() const
access to end of the sequence (const version)
Definition: Range.h:167
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 175 of file Range.h.

175 { return reverse_iterator( begin() ); }
Gaudi::Range_::reverse_iterator
std::reverse_iterator< iterator > reverse_iterator
Definition: Range.h:132
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165
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 163 of file Range.h.

163 { return std::distance( m_base.first, m_base.second ); }
Gaudi::Range_::m_base
Base m_base
the base itself
Definition: Range.h:292
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 182 of file Range.h.

183 {
184 // trivial cases
185 if ( empty() || index1 == index2 ) {
186 return Range_();
187 } // RETURN
188 // adjust indices
189 if ( index1 < 0 ) {
190 index1 += size();
191 }
192 if ( index2 < 0 ) {
193 index2 += size();
194 }
195 // check
196 if ( index1 < 0 ) {
197 return Range_();
198 } // RETURN
199 if ( index2 < index1 ) {
200 return Range_();
201 } // RETURN
202
203 if ( index1 > (long)size() ) {
204 return Range_();
205 } // RETURN
206 if ( index2 > (long)size() ) {
207 index2 = size();
208 }
209
210 // construct the slice
211 return Range_( std::next( begin(), index1 ), std::next( begin(), index2 ) ); // RETURN
212 }
Gaudi::Range_::empty
bool empty() const
empty sequence ?
Definition: Range.h:161
std::next
T next(T...args)
Gaudi::Range_::Range_
Range_()=default
internal types
Gaudi::Range_::size
size_t size() const
size of the sequence (number of elements)
Definition: Range.h:163
Gaudi::Range_::begin
iterator begin() const
access to begin of the sequence (const version )
Definition: Range.h:165

## 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 292 of file Range.h.

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

- GaudiKernel/GaudiKernel/Range.h