Iterator on the items of array. More...

#include <tpl_dynArray.H>

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

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

Public Types
using	Set_Type = DynArray

using	aleph_random_access_iterator = Iterator
	Opt-in marker for StlIterator random-access promotion.

Public Member Functions
	Iterator () noexcept=default
	Default constructor creates an "end" iterator.

	Iterator (const DynArray &array) noexcept
	Initializes an iterator on `array`

bool	has_curr () const noexcept
	Check whether the iterator refers to an item.

bool	is_last () const noexcept
	Check whether the current item is the last item.

T &	get_curr_ne () const noexcept
	Return the current link guaranteeing no exception. Be careful.

T &	get_curr () const
	Return the current item.

long	get_pos () const noexcept
	Return the ordinal position of current item.

void	next_ne () noexcept
	Move the iterator one position forward guaranteeing no exception.

void	next ()
	Advance one position, from the last item to the end if needed.

void	prev_ne () noexcept
	exception. Be careful.

void	prev ()
	Move the current a position backward.

void	reset_last () noexcept
	Reset the iterator to the last item.

void	end () noexcept
	Put the iterator in the end state.

void	reset_first () noexcept
	Reset the iterator to the first item.

void	set_pos (const long pos) noexcept

Protected Attributes
DynArray *	array_ptr = nullptr

long	curr_idx = 0

Detailed Description

template<typename T>
class Aleph::DynArray< T >::Iterator

Iterator on the items of array.

The visit order is from the lower index 0 to current dimension minus one.

It is assumed that all the entries between 0 and current dimension have been allocated.

Definition at line 1381 of file tpl_dynArray.H.

Member Typedef Documentation

◆ aleph_random_access_iterator

template<typename T >

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

Opt-in marker for StlIterator random-access promotion.

It is the iterator's own type on purpose: derived iterators that reuse this class as a base (e.g. DynArrayHeap::Iterator, which redefines get_pos() with an offset) do NOT inherit the promotion, because their own type differs from this marker. This keeps the promotion fail-safe.

Definition at line 1395 of file tpl_dynArray.H.

◆ Set_Type

template<typename T >

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

Definition at line 1388 of file tpl_dynArray.H.

Constructor & Destructor Documentation

◆ Iterator() [1/2]

template<typename T >

Aleph::DynArray< T >::Iterator::Iterator ( )

defaultnoexcept

Default constructor creates an "end" iterator.

◆ Iterator() [2/2]

template<typename T >

Aleph::DynArray< T >::Iterator::Iterator ( const DynArray & array )

inlinenoexcept

Initializes an iterator on array

Definition at line 1401 of file tpl_dynArray.H.

Member Function Documentation

◆ end()

template<typename T >

void Aleph::DynArray< T >::Iterator::end ( )

inlinenoexcept

Put the iterator in the end state.

Definition at line 1499 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::array_ptr, Aleph::DynArray< T >::Iterator::curr_idx, and Aleph::DynArray< T >::size().

◆ get_curr()

template<typename T >

T & Aleph::DynArray< T >::Iterator::get_curr ( ) const

inline

Return the current item.

Returns: Reference to the current item.

Exceptions

std::underflow_error	if positioned before the first item.
std::overflow_error	if singular or at or past the end.

Definition at line 1441 of file tpl_dynArray.H.

References ah_overflow_error_if, ah_underflow_error_if, Aleph::DynArray< T >::Iterator::array_ptr, Aleph::blossom_maximum_cardinality_matching(), Aleph::DynArray< T >::Iterator::curr_idx, Aleph::DynArray< T >::Iterator::get_curr_ne(), and Aleph::DynArray< T >::size().

Referenced by main().

◆ get_curr_ne()

template<typename T >

T & Aleph::DynArray< T >::Iterator::get_curr_ne ( ) const

inlinenoexcept

Return the current link guaranteeing no exception. Be careful.

Definition at line 1430 of file tpl_dynArray.H.

References Aleph::DynArray< T >::access(), Aleph::DynArray< T >::Iterator::array_ptr, and Aleph::DynArray< T >::Iterator::curr_idx.

Referenced by Aleph::DynArray< T >::Iterator::get_curr().

◆ get_pos()

template<typename T >

long Aleph::DynArray< T >::Iterator::get_pos ( ) const

inlinenoexcept

Return the ordinal position of current item.

Definition at line 1451 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::curr_idx.

◆ has_curr()

template<typename T >

bool Aleph::DynArray< T >::Iterator::has_curr ( ) const

inlinenoexcept

Check whether the iterator refers to an item.

A default-constructed (singular) iterator behaves as an empty sequence.

Returns: true if there is a current item; false for singular, empty, or out-of-range iterators.

Definition at line 1412 of file tpl_dynArray.H.

References FunctionalMethods< DynArray< T >, T >::and, Aleph::DynArray< T >::Iterator::array_ptr, Aleph::DynArray< T >::Iterator::curr_idx, and Aleph::DynArray< T >::size().

Referenced by Aleph::DynArray< T >::Iterator::is_last(), and main().

◆ is_last()

template<typename T >

bool Aleph::DynArray< T >::Iterator::is_last ( ) const

inlinenoexcept

Check whether the current item is the last item.

Returns: true only when a current item exists and it is the last; false for singular or empty iterators.

Definition at line 1423 of file tpl_dynArray.H.

References FunctionalMethods< DynArray< T >, T >::and, Aleph::DynArray< T >::Iterator::array_ptr, Aleph::DynArray< T >::Iterator::curr_idx, Aleph::DynArray< T >::Iterator::has_curr(), and Aleph::DynArray< T >::size().

◆ next()

template<typename T >

void Aleph::DynArray< T >::Iterator::next ( )

inline

Advance one position, from the last item to the end if needed.

Exceptions

std::overflow_error if the iterator is singular or already at or past the end.

Definition at line 1468 of file tpl_dynArray.H.

References ah_overflow_error_if, FunctionalMethods< DynArray< T >, T >::and, Aleph::DynArray< T >::Iterator::array_ptr, Aleph::blossom_maximum_cardinality_matching(), Aleph::DynArray< T >::Iterator::curr_idx, Aleph::DynArray< T >::Iterator::next_ne(), and Aleph::DynArray< T >::size().

◆ next_ne()

template<typename T >

void Aleph::DynArray< T >::Iterator::next_ne ( )

inlinenoexcept

Move the iterator one position forward guaranteeing no exception.

Be careful.

Definition at line 1458 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::curr_idx.

Referenced by Aleph::DynArrayHeap< T, Compare >::Iterator::Iterator(), and Aleph::DynArray< T >::Iterator::next().

◆ prev()

template<typename T >

void Aleph::DynArray< T >::Iterator::prev ( )

inline

Move the current a position backward.

Throw underflow_error if current is the first item

Definition at line 1486 of file tpl_dynArray.H.

References ah_underflow_error_if, Aleph::DynArray< T >::Iterator::curr_idx, and Aleph::DynArray< T >::Iterator::prev_ne().

Referenced by main().

◆ prev_ne()

template<typename T >

void Aleph::DynArray< T >::Iterator::prev_ne ( )

inlinenoexcept

exception. Be careful.

Definition at line 1479 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::curr_idx.

Referenced by Aleph::DynArray< T >::Iterator::prev().

◆ reset_first()

template<typename T >

void Aleph::DynArray< T >::Iterator::reset_first ( )

inlinenoexcept

Reset the iterator to the first item.

Definition at line 1505 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::curr_idx.

◆ reset_last()

template<typename T >

void Aleph::DynArray< T >::Iterator::reset_last ( )

inlinenoexcept

Reset the iterator to the last item.

Definition at line 1493 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::array_ptr, Aleph::DynArray< T >::Iterator::curr_idx, and Aleph::DynArray< T >::size().

Referenced by main().

◆ set_pos()

template<typename T >

void Aleph::DynArray< T >::Iterator::set_pos ( const long pos )

inlinenoexcept

Definition at line 1510 of file tpl_dynArray.H.

References Aleph::DynArray< T >::Iterator::curr_idx.

Referenced by Aleph::DynArray< T >::get_it().

Member Data Documentation

◆ array_ptr

template<typename T >

DynArray* Aleph::DynArray< T >::Iterator::array_ptr = nullptr

protected

Definition at line 1384 of file tpl_dynArray.H.

Referenced by Aleph::DynArray< T >::Iterator::end(), Aleph::DynArray< T >::Iterator::get_curr(), Aleph::DynArray< T >::Iterator::get_curr_ne(), Aleph::DynArray< T >::Iterator::has_curr(), Aleph::DynArrayHeap< T, Compare >::Iterator::has_curr(), Aleph::DynArray< T >::Iterator::is_last(), Aleph::DynArray< T >::Iterator::next(), and Aleph::DynArray< T >::Iterator::reset_last().

◆ curr_idx

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

tpl_dynArray.H

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ aleph_random_access_iterator

◆ Set_Type

Constructor & Destructor Documentation

◆ Iterator() [1/2]

◆ Iterator() [2/2]

Member Function Documentation

◆ end()

◆ get_curr()

◆ get_curr_ne()

◆ get_pos()

◆ has_curr()

◆ is_last()

◆ next()

◆ next_ne()

◆ prev()

◆ prev_ne()

◆ reset_first()

◆ reset_last()

◆ set_pos()

Member Data Documentation

◆ array_ptr

◆ curr_idx