Aleph::Array< T >::Iterator Struct Reference

Iterator on the items of an array. More...

#include <tpl_array.H>

Inheritance diagram for Aleph::Array< T >::Iterator:

Collaboration diagram for Aleph::Array< T >::Iterator:

Public Types
using	Base = typename MemArray< T >::Iterator
using	Set_Type = Array
using	aleph_random_access_iterator = Iterator
	Opt-in marker for StlIterator random-access promotion.
Public Types inherited from Aleph::MemArray< T >::Iterator
using	Base = Array_Iterator< T >
Public Types inherited from Aleph::Array_Iterator< T >
using	Item_Type = T
	The type of elements being iterated.

Public Member Functions
	Iterator (const Array< T > &s) noexcept
	Initialize an iterator on array s
Public Member Functions inherited from Aleph::MemArray< T >::Iterator
	Iterator (const MemArray< T > &a) noexcept
	Construct an iterator on array a
Public Member Functions inherited from Aleph::Array_Iterator< T >
T *	get_base () noexcept
	Get the base pointer of the array.
constexpr const T *	get_base () const noexcept
	Get the base pointer of the array (const version).
	Array_Iterator ()=default
	Default constructor - creates an invalid iterator.
	Array_Iterator (T *p, const size_t sz, const size_t n)
	Construct an iterator over an array.
	Array_Iterator (NoExceptionCtor, T *p, const size_t sz, const size_t n)
	Construct an iterator without exception checking.
	Array_Iterator (T *p, const size_t sz, const size_t n, const long f, const long l)
	Construct an iterator over a circular array region.
	Array_Iterator (NoExceptionCtor, T *p, const size_t sz, const size_t n, const long f, const long l)
	Construct a circular iterator without exception checking.
	Array_Iterator (const Array_Container< T > &c)
	Construct an iterator from an Array_Container.
bool	has_curr () const noexcept
	Check if there is a current valid item.
bool	is_last () const noexcept
	Check if positioned at the last item.
constexpr long	get_pos () const noexcept
	Get the current position index.
T &	get_curr_ne () const noexcept
	Get the current item without bounds checking.
T &	get_curr () const
	Get the current item with bounds checking.
void	next_ne () noexcept
	Advance to the next item without bounds checking.
void	next ()
	Advance to the next item with bounds checking.
void	prev_ne () noexcept
	Move to the previous item without bounds checking.
void	prev ()
	Move to the previous item with bounds checking.
void	reset () noexcept
	Reset the iterator to the first item.
void	reset_first () noexcept
	Reset the iterator to the first item (alias for reset()).
void	reset_last () noexcept
	Reset the iterator to the last item.
void	set_pos (const long new_pos) noexcept
	Move the iterator to the logical position new_pos.
void	end () noexcept
	Put the iterator at the end (past the last item).

Detailed Description

template<typename T>
struct Aleph::Array< T >::Iterator

Iterator on the items of an array.

Definition at line 607 of file tpl_array.H.

Member Typedef Documentation

aleph_random_access_iterator

template<typename T >

using Aleph::Array< T >::Iterator::aleph_random_access_iterator = Iterator

Opt-in marker for StlIterator random-access promotion.

The iterator inherits get_pos()/set_pos() unchanged from Array_Iterator, so the logical position is consistent and random access is safe.

Definition at line 616 of file tpl_array.H.

Base

template<typename T >

using Aleph::Array< T >::Iterator::Base = typename MemArray<T>::Iterator

Definition at line 609 of file tpl_array.H.

Set_Type

template<typename T >

using Aleph::Array< T >::Iterator::Set_Type = Array

Definition at line 611 of file tpl_array.H.

Constructor & Destructor Documentation

Iterator()

template<typename T >

Aleph::Array< T >::Iterator::Iterator ( const Array< T > &  s )

inlinenoexcept

Initialize an iterator on array s

Definition at line 619 of file tpl_array.H.

---

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

• tpl_array.H