gum::SequenceIteratorSafe< Key > Class Template Reference

Safe iterators for Sequence. More...

#include <agrum/base/core/sequence.h>

Collaboration diagram for gum::SequenceIteratorSafe< Key >:

Public Types
using	iterator_category = std::bidirectional_iterator_tag
	types for STL compliance
using	value_type = Key
	types for STL compliance
using	reference = Key&
	types for STL compliance
using	const_reference = const Key&
	types for STL compliance
using	pointer = Key*
	types for STL compliance
using	const_pointer = const Key*
	types for STL compliance
using	difference_type = std::ptrdiff_t
	types for STL compliance

Public Member Functions
Constructors / Destructors
	SequenceIteratorSafe ()=delete
	Constructor, always give a valid iterator (even if pos too large).
	SequenceIteratorSafe (const Sequence< Key > &seq, Idx pos=0) noexcept
	Constructor, always give a valid iterator (even if pos too large).
	SequenceIteratorSafe (const SequenceIteratorSafe< Key > &source) noexcept
	Copy constructor.
	SequenceIteratorSafe (SequenceIteratorSafe< Key > &&source) noexcept
	Move constructor.
	~SequenceIteratorSafe () noexcept
	Class destructor.
Operators
SequenceIteratorSafe< Key > &	operator= (const SequenceIteratorSafe< Key > &source) noexcept
	Copy operator.
SequenceIteratorSafe< Key > &	operator= (SequenceIteratorSafe< Key > &&source) noexcept
	Move operator.
SequenceIteratorSafe< Key > &	operator++ () noexcept
	Point the iterator to the next value in the sequence.
SequenceIteratorSafe< Key > &	operator-- () noexcept
	Point the iterator to the preceding value in the sequence.
SequenceIteratorSafe< Key > &	operator+= (Size nb) noexcept
	Makes the iterator point to i elements further in the sequence.
SequenceIteratorSafe< Key > &	operator-= (Size nb) noexcept
	Makes the iterator point to i elements further in the sequence.
SequenceIteratorSafe< Key >	operator+ (Size nb) noexcept
	Returns a new iterator.
SequenceIteratorSafe< Key >	operator- (Size nb) noexcept
	Returns a new iterator.
bool	operator!= (const SequenceIteratorSafe< Key > &source) const noexcept
	Checks whether two iterators are pointing to different elements.
bool	operator== (const SequenceIteratorSafe< Key > &source) const noexcept
	Checks whether two iterators are pointing to the same elements.
const Key &	operator* () const
	Returns the value pointed to by the iterator.
const Key *	operator-> () const
	Returns the value pointed to by the iterator (works only for non-scalars).
Accessors / Modifiers
Idx	pos () const
	Returns the position of the iterator in the sequence.

Private Types
using	Getter = SequenceIteratorGet< std::is_scalar_v< Key > >
	The Getter used by this iterator.

Private Member Functions
template<bool Gen>
	SequenceIteratorSafe (const SequenceImplementation< Key, Gen > &seq, Idx pos=0) noexcept
	Constructor, always give a valid iterator (even if pos too large).
void	_setPos_ (Idx pos) noexcept
	The iterator points to the posth element (0 = beginning of the sequence).
void	_setAtRend_ () noexcept
	The iterator points to rend.
void	_setAtEnd_ () noexcept
	The iterator points to the end (which is pos size()-1).

Private Attributes
Idx	_iterator_
	The index in the sequence's vector where the iterator is pointing.
const SequenceImplementation< Key, std::is_scalar_v< Key > > *	_seq_ {nullptr}
	The sequence pointed to by the iterator (by default, key is a scalar).

Friends
template<typename K, bool>
class	SequenceImplementation
	Friend to speed up access.

Detailed Description

template<typename Key>
class gum::SequenceIteratorSafe< Key >

Safe iterators for Sequence.

This iterator enables to parse the elements in the sequence. Note that this is similar to a const safe iterator because the elements that can be accessed in the sequence are constant.

Usage example:

// creation of a sequence
Sequence<int> seq { 1, 2, 3, 4 };
Sequence<string> seq2;
 
// creation of iterators
auto iter1 = seq.beginSafe (); // points to 1
auto iiter2 = iter1;
auto iiter3 = std::move ( iter1 );
 
// parsing the sequence
for ( auto iter = seq.beginSafe (); iter != seq.endSafe (); ++iter )
  std::cout << *iter << std::endl;
for ( auto iter = seq.rbeginSafe (); iter != seq.rend (); --iter )
  std::cout << *iter << std::endl;
for ( auto iter = seq.beginSafe (); iter != seq.end (); ++iter )
  std::cout << iter->size () << std::endl;

Template Parameters

Key	The type of elements stored in the gum::Sequence.

Definition at line 1148 of file sequence.h.

Member Typedef Documentation

const_pointer

template<typename Key>

using gum::SequenceIteratorSafe< Key >::const_pointer = const Key*

types for STL compliance

Definition at line 1161 of file sequence.h.

const_reference

template<typename Key>

using gum::SequenceIteratorSafe< Key >::const_reference = const Key&

types for STL compliance

Definition at line 1159 of file sequence.h.

difference_type

template<typename Key>

using gum::SequenceIteratorSafe< Key >::difference_type = std::ptrdiff_t

types for STL compliance

Definition at line 1162 of file sequence.h.

Getter

template<typename Key>

using gum::SequenceIteratorSafe< Key >::Getter = SequenceIteratorGet< std::is_scalar_v< Key > >

private

The Getter used by this iterator.

Definition at line 1167 of file sequence.h.

iterator_category

template<typename Key>

using gum::SequenceIteratorSafe< Key >::iterator_category = std::bidirectional_iterator_tag

types for STL compliance

Definition at line 1156 of file sequence.h.

pointer

template<typename Key>

using gum::SequenceIteratorSafe< Key >::pointer = Key*

types for STL compliance

Definition at line 1160 of file sequence.h.

reference

template<typename Key>

using gum::SequenceIteratorSafe< Key >::reference = Key&

types for STL compliance

Definition at line 1158 of file sequence.h.

value_type

template<typename Key>

using gum::SequenceIteratorSafe< Key >::value_type = Key

types for STL compliance

Definition at line 1157 of file sequence.h.

Constructor & Destructor Documentation

SequenceIteratorSafe() [1/5]

template<typename Key>

template<bool Gen>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const SequenceImplementation< Key, Gen > & seq, Idx pos = 0 )

privatenoexcept

Constructor, always give a valid iterator (even if pos too large).

Warning

if pos is greater than the size of the sequence, the iterator is made pointing to end().

Template Parameters

Gen	Used for meta-programation.

Parameters

seq	The sequence.
pos	Indicates to which position of the sequence the iterator should be pointing. By default, the iterator points to begin().

Definition at line 88 of file sequence_tpl.h.

                                                                      :
      _seq_{
          reinterpret_cast< const SequenceImplementation< Key, std::is_scalar_v< Key > >* >(&seq)} {
    GUM_CONSTRUCTOR(SequenceIteratorSafe);
 
    if (pos > _seq_->size()) _iterator_ = _seq_->size();   // make the iterator point to end
    else _iterator_ = pos;
  }

References _seq_, pos(), and SequenceImplementation.

Referenced by SequenceIteratorSafe(), ~SequenceIteratorSafe(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

SequenceIteratorSafe() [2/5]

template<typename Key>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( )

delete

Constructor, always give a valid iterator (even if pos too large).

Warning

if pos is greater than the size of the sequence, the iterator is made pointing to end().

Parameters

seq	the sequence
pos	indicates to which position of the sequence the iterator should be pointing. By default, the iterator points to begin()

References SequenceIteratorSafe(), and pos().

Here is the call graph for this function:

SequenceIteratorSafe() [3/5]

template<typename Key>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const Sequence< Key > & seq, Idx pos = 0 )

noexcept

Constructor, always give a valid iterator (even if pos too large).

Warning

if pos is greater than the size of the sequence, the iterator is made pointing to end().

Parameters

seq	the sequence
pos	indicates to which position of the sequence the iterator should be pointing. By default, the iterator points to begin()

Definition at line 100 of file sequence_tpl.h.

                                                                                                :
      _seq_{
          reinterpret_cast< const SequenceImplementation< Key, std::is_scalar_v< Key > >* >(&seq)} {
    GUM_CONSTRUCTOR(SequenceIteratorSafe);
 
    if (pos > _seq_->size()) _iterator_ = _seq_->size();   // make the iterator point to end
    else _iterator_ = pos;
  }

References _seq_, pos(), and SequenceImplementation.

Here is the call graph for this function:

SequenceIteratorSafe() [4/5]

template<typename Key>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const SequenceIteratorSafe< Key > & source )

noexcept

Copy constructor.

Parameters

source

The iterator to copy.

Definition at line 111 of file sequence_tpl.h.

                                                          :
      _iterator_{source._iterator_}, _seq_{source._seq_} {
    GUM_CONS_CPY(SequenceIteratorSafe);
  }

References _iterator_.

SequenceIteratorSafe() [5/5]

template<typename Key>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( SequenceIteratorSafe< Key > && source )

noexcept

Move constructor.

Parameters

source

The iterator to move.

Definition at line 119 of file sequence_tpl.h.

                                                                                                 :
      _iterator_{source._iterator_}, _seq_{source._seq_} {
    GUM_CONS_MOV(SequenceIteratorSafe);
  }

References _iterator_.

~SequenceIteratorSafe()

template<typename Key>

gum::SequenceIteratorSafe< Key >::~SequenceIteratorSafe ( )

noexcept

Class destructor.

Definition at line 126 of file sequence_tpl.h.

                                                              {
    GUM_DESTRUCTOR(SequenceIteratorSafe);
  }

References SequenceIteratorSafe().

Here is the call graph for this function:

Member Function Documentation

_setAtEnd_()

template<typename Key>

void gum::SequenceIteratorSafe< Key >::_setAtEnd_ ( )

privatenoexcept

The iterator points to the end (which is pos size()-1).

Definition at line 237 of file sequence_tpl.h.

                                                        {
    _iterator_ = _seq_->size();
  }

References _iterator_, and _seq_.

_setAtRend_()

template<typename Key>

void gum::SequenceIteratorSafe< Key >::_setAtRend_ ( )

privatenoexcept

The iterator points to rend.

Definition at line 231 of file sequence_tpl.h.

                                                         {
    _iterator_ = std::numeric_limits< Idx >::max();
  }

References _iterator_.

_setPos_()

template<typename Key>

void gum::SequenceIteratorSafe< Key >::_setPos_ ( Idx pos )

privatenoexcept

The iterator points to the posth element (0 = beginning of the sequence).

Definition at line 224 of file sequence_tpl.h.

                                                             {
    if (pos > _seq_->size()) _iterator_ = _seq_->size();
    else _iterator_ = pos;
  }

References _iterator_, _seq_, and pos().

Here is the call graph for this function:

operator!=()

template<typename Key>

bool gum::SequenceIteratorSafe< Key >::operator!= ( const SequenceIteratorSafe< Key > & source ) const

noexcept

Checks whether two iterators are pointing to different elements.

Parameters

source

The iterator to test for inequality.

Returns

Returns true if both iterators are not equal.

Definition at line 207 of file sequence_tpl.h.

                                                                {
    return !operator==(source);
  }

References gum::operator==().

Here is the call graph for this function:

operator*()

template<typename Key>

const Key & gum::SequenceIteratorSafe< Key >::operator*

(

)

const

Returns the value pointed to by the iterator.

Returns

Returns the value pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised on end() or rend().

Definition at line 243 of file sequence_tpl.h.

                                                          {
    return Getter::op_star(_seq_->_v_[pos()]);
  }

operator+()

template<typename Key>

SequenceIteratorSafe< Key > gum::SequenceIteratorSafe< Key >::operator+ ( Size nb )

noexcept

Returns a new iterator.

Warning

The created iterator should point outside the Sequence, then it is set either to end or rend, depending on the sign of nb.

Parameters

nb	The number of steps the created iterator is ahead of this.

Returns

Returns a new iterator.

Definition at line 184 of file sequence_tpl.h.

                                                                                     {
    return SequenceIteratorSafe< Key >{*this} += nb;
  }

operator++()

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator++ ( )

noexcept

Point the iterator to the next value in the sequence.

Warning

if the iterator already points to end(), it is unaltered.

Returns

Returns this iterator.

Definition at line 147 of file sequence_tpl.h.

                                                                                {
    if (_iterator_ < _seq_->size()) ++_iterator_;
    else _iterator_ = _seq_->size();
 
    return *this;
  }

References _iterator_, and _seq_.

operator+=()

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator+= ( Size nb )

noexcept

Makes the iterator point to i elements further in the sequence.

Warning

If moving the iterator nb would make it point outside the Sequence, then iterator is moved to end or rend, depending on the sign of nb.

Parameters

nb	The number of steps to move the iterator.

Returns

Returns this iterator.

Definition at line 164 of file sequence_tpl.h.

                                                                                     {
    if (_iterator_ == std::numeric_limits< Idx >::max()) return *this;
    _iterator_ += nb;
    if (_iterator_ > _seq_->size()) _iterator_ = _seq_->size();
 
    return *this;
  }

References _iterator_, and _seq_.

operator-()

template<typename Key>

SequenceIteratorSafe< Key > gum::SequenceIteratorSafe< Key >::operator- ( Size nb )

noexcept

Returns a new iterator.

Warning

The created iterator should point outside the Sequence, then it is set either to end or rend, depending on the sign of nb.

Parameters

nb	The number of steps the created iterator is behind of this.

Returns a new iterator.

Definition at line 190 of file sequence_tpl.h.

                                                                                     {
    return SequenceIteratorSafe< Key >{*this} -= nb;
  }

operator--()

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator-- ( )

noexcept

Point the iterator to the preceding value in the sequence.

Warning

If the iterator already points to rend(), it is unaltered.

Returns

Returns this iterator.

Definition at line 156 of file sequence_tpl.h.

                                                                                {
    if (_iterator_ != std::numeric_limits< Idx >::max()) --_iterator_;
 
    return *this;
  }

References _iterator_.

operator-=()

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator-= ( Size nb )

noexcept

Makes the iterator point to i elements further in the sequence.

Warning

If moving the iterator nb would make it point outside the Sequence, then iterator is moved to end or rend, depending on the sign of nb.

Parameters

nb	The number of steps to move the iterator.

Returns

Returns this iterator.

Definition at line 174 of file sequence_tpl.h.

                                                                                     {
    if (_iterator_ == std::numeric_limits< Idx >::max()) return *this;
    _iterator_ -= nb;
    if (_iterator_ > _seq_->size()) _iterator_ = std::numeric_limits< Idx >::max();
 
    return *this;
  }

operator->()

template<typename Key>

const Key * gum::SequenceIteratorSafe< Key >::operator->

(

)

const

Returns the value pointed to by the iterator (works only for non-scalars).

Returns

Returns the value pointed to by the iterator (works only for non-scalars).

Definition at line 249 of file sequence_tpl.h.

                                                           {
    return Getter::op_arrow(_seq_->_v_[pos()]);
  }

References _seq_, and pos().

Here is the call graph for this function:

operator=() [1/2]

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator= ( const SequenceIteratorSafe< Key > & source )

defaultnoexcept

Copy operator.

Parameters

source

The iterator to copy.

Returns

Returns this iterator.

References SequenceIteratorSafe(), and pos().

Here is the call graph for this function:

operator=() [2/2]

template<typename Key>

SequenceIteratorSafe< Key > & gum::SequenceIteratorSafe< Key >::operator= ( SequenceIteratorSafe< Key > && source )

noexcept

Move operator.

Parameters

source

The iterator to move.

Returns

Returns this iterator.

Definition at line 139 of file sequence_tpl.h.

                                                                                        {
    _iterator_ = source._iterator_;
    _seq_      = source._seq_;
    return *this;
  }

References _iterator_.

operator==()

template<typename Key>

bool gum::SequenceIteratorSafe< Key >::operator== ( const SequenceIteratorSafe< Key > & source ) const

noexcept

Checks whether two iterators are pointing to the same elements.

Parameters

source

The iterator to test for equality.

Returns

Returns true if both iterators are equal.

Definition at line 196 of file sequence_tpl.h.

                                                                {
    if (_seq_->empty()) return true;   // all iterators are the same if seq is empty
 
    if ((_iterator_ != source._iterator_) || (_seq_ != source._seq_)) return false;
 
    return true;
  }

References _seq_.

pos()

template<typename Key>

Idx gum::SequenceIteratorSafe< Key >::pos

(

)

const

Returns the position of the iterator in the sequence.

Returns

Returns the position of the iterator in the sequence.

Exceptions

UndefinedIteratorValue

Raised on end() or rend().

Definition at line 214 of file sequence_tpl.h.

                                             {
    if (_iterator_ >= _seq_->size()) {
      GUM_ERROR(UndefinedIteratorValue, "iterator is end() or rend()")
    }
 
    return _iterator_;
  }

References _iterator_, _seq_, and GUM_ERROR.

Referenced by SequenceIteratorSafe(), SequenceIteratorSafe(), SequenceIteratorSafe(), _setPos_(), operator->(), and operator=().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

SequenceImplementation

template<typename Key>

template<typename K, bool>

friend class SequenceImplementation

friend

Friend to speed up access.

Definition at line 1151 of file sequence.h.

References SequenceImplementation.

Referenced by SequenceIteratorSafe(), SequenceIteratorSafe(), and SequenceImplementation.

Member Data Documentation

_iterator_

template<typename Key>

Idx gum::SequenceIteratorSafe< Key >::_iterator_

private

The index in the sequence's vector where the iterator is pointing.

Definition at line 1354 of file sequence.h.

Referenced by SequenceIteratorSafe(), SequenceIteratorSafe(), _setAtEnd_(), _setAtRend_(), _setPos_(), operator++(), operator+=(), operator--(), operator=(), and pos().

_seq_

template<typename Key>

const SequenceImplementation< Key, std::is_scalar_v< Key > >* gum::SequenceIteratorSafe< Key >::_seq_ {nullptr}

private

The sequence pointed to by the iterator (by default, key is a scalar).

Definition at line 1357 of file sequence.h.

{nullptr};

Referenced by SequenceIteratorSafe(), SequenceIteratorSafe(), _setAtEnd_(), _setPos_(), operator++(), operator+=(), operator->(), operator==(), and pos().

---

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

• agrum/base/core/sequence.h
• agrum/base/core/sequence_tpl.h