StlConstIterator< SetType > Struct Template Reference

STL-compatible const iterator adapter for Aleph containers. More...

#include <ah-iterator.H>

Inheritance diagram for StlConstIterator< SetType >:

Collaboration diagram for StlConstIterator< SetType >:

Public Types
using	T = typename SetType::Item_Type
using	Itor = typename SetType::Iterator
using	iterator_category = std::forward_iterator_tag
using	iterator_concept = std::forward_iterator_tag
using	difference_type = std::ptrdiff_t
using	pointer = const T *
using	reference = const T &
using	value_type = T

Public Member Functions
	StlConstIterator () noexcept=default
	Default constructor creates an "end" iterator (no current element).
StlConstIterator &	operator++ ()
	Pre-increment: advance to the next element.
StlConstIterator	operator++ (int)
	Post-increment: advance to the next element and return the old iterator.
bool	operator== (const StlConstIterator &it) const
	Equality compares positions when both iterators are valid; otherwise both must be in the end state.
bool	operator!= (const StlConstIterator &it) const
	Inequality.
const T &	operator* () const
	Dereference: return the current element.
const T *	operator-> () const
	Member access to the current element.

Static Public Member Functions
static StlConstIterator	cbegin (const SetType &s)
	Create a const iterator positioned at the first element of the container.
static StlConstIterator	cend (const SetType &s)
	Create a const end iterator for the container.

Detailed Description

template<class SetType>
struct StlConstIterator< SetType >

STL-compatible const iterator adapter for Aleph containers.

This adapter provides a read-only view over the underlying Aleph iterator.

Template Parameters

SetType

Aleph container type.

Definition at line 161 of file ah-iterator.H.

Member Typedef Documentation

difference_type

template<class SetType >

using StlConstIterator< SetType >::difference_type = std::ptrdiff_t

Definition at line 168 of file ah-iterator.H.

iterator_category

template<class SetType >

using StlConstIterator< SetType >::iterator_category = std::forward_iterator_tag

Definition at line 165 of file ah-iterator.H.

iterator_concept

template<class SetType >

using StlConstIterator< SetType >::iterator_concept = std::forward_iterator_tag

Definition at line 166 of file ah-iterator.H.

Itor

template<class SetType >

using StlConstIterator< SetType >::Itor = typename SetType::Iterator

Definition at line 164 of file ah-iterator.H.

pointer

template<class SetType >

using StlConstIterator< SetType >::pointer = const T*

Definition at line 170 of file ah-iterator.H.

reference

template<class SetType >

using StlConstIterator< SetType >::reference = const T&

Definition at line 172 of file ah-iterator.H.

T

template<class SetType >

using StlConstIterator< SetType >::T = typename SetType::Item_Type

Definition at line 163 of file ah-iterator.H.

value_type

template<class SetType >

using StlConstIterator< SetType >::value_type = T

Definition at line 174 of file ah-iterator.H.

Constructor & Destructor Documentation

StlConstIterator()

template<class SetType >

StlConstIterator< SetType >::StlConstIterator ( )

defaultnoexcept

Default constructor creates an "end" iterator (no current element).

Referenced by StlConstIterator< SetType >::cbegin().

Member Function Documentation

cbegin()

template<class SetType >

static StlConstIterator StlConstIterator< SetType >::cbegin ( const SetType &  s )

inlinestatic

Create a const iterator positioned at the first element of the container.

Definition at line 228 of file ah-iterator.H.

References StlConstIterator< SetType >::StlConstIterator().

Referenced by StlAlephIterator< SetName >::begin(), and StlAlephIterator< SetName >::cbegin().

cend()

template<class SetType >

static StlConstIterator StlConstIterator< SetType >::cend ( const SetType &  s )

inlinestatic

Create a const end iterator for the container.

Definition at line 234 of file ah-iterator.H.

Referenced by StlAlephIterator< SetName >::cend(), and StlAlephIterator< SetName >::end().

operator!=()

template<class SetType >

bool StlConstIterator< SetType >::operator!= ( const StlConstIterator< SetType > &  it ) const

inline

Inequality.

Definition at line 216 of file ah-iterator.H.

operator*()

template<class SetType >

const T & StlConstIterator< SetType >::operator* ( ) const

inline

Dereference: return the current element.

Definition at line 222 of file ah-iterator.H.

operator++() [1/2]

template<class SetType >

StlConstIterator & StlConstIterator< SetType >::operator++ ( )

inline

Pre-increment: advance to the next element.

Definition at line 182 of file ah-iterator.H.

operator++() [2/2]

template<class SetType >

StlConstIterator StlConstIterator< SetType >::operator++ ( int  )

inline

Post-increment: advance to the next element and return the old iterator.

Definition at line 189 of file ah-iterator.H.

operator->()

template<class SetType >

const T * StlConstIterator< SetType >::operator-> ( ) const

inline

Member access to the current element.

Definition at line 225 of file ah-iterator.H.

operator==()

template<class SetType >

bool StlConstIterator< SetType >::operator== ( const StlConstIterator< SetType > &  it ) const

inline

Equality compares positions when both iterators are valid; otherwise both must be in the end state.

Definition at line 198 of file ah-iterator.H.

---

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

• ah-iterator.H