gum::SequenceIteratorSafe< Key > Class Template Reference

Safe iterators for Sequence. More...

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

Collaboration diagram for gum::SequenceIteratorSafe< Key >:

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

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

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

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 1205 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 1218 of file sequence.h.

const_reference

template<typename Key>

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

types for STL compliance

Definition at line 1216 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 1219 of file sequence.h.

Getter

template<typename Key>

using gum::SequenceIteratorSafe< Key >::Getter = SequenceIteratorGet< std::is_scalar< Key >::value >

private

The Getter used by this iterator.

Definition at line 1224 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 1213 of file sequence.h.

pointer

template<typename Key>

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

types for STL compliance

Definition at line 1217 of file sequence.h.

reference

template<typename Key>

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

types for STL compliance

Definition at line 1215 of file sequence.h.

value_type

template<typename Key>

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

types for STL compliance

Definition at line 1214 of file sequence.h.

Constructor & Destructor Documentation

SequenceIteratorSafe() [1/6]

template<typename Key>

template<typename Alloc , bool Gen>

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const SequenceImplementation< Key, Alloc, 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

Alloc	The sequence allocator.
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().

SequenceIteratorSafe() [2/6]

template<typename Key>

template<typename Alloc >

gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const Sequence< Key, Alloc > &  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()

Template Parameters

Alloc

The sequence allocator.

SequenceIteratorSafe() [3/6]

template<typename Key>

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

noexcept

Copy constructor.

Parameters

source

The iterator to copy.

Definition at line 101 of file sequence_tpl.h.

                                                         :
      iterator__{source.iterator__},
      seq__{source.seq__} {
    GUM_CONS_CPY(SequenceIteratorSafe);
  }

SequenceIteratorSafe() [4/6]

template<typename Key>

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

noexcept

Move constructor.

Parameters

source

The iterator to move.

Definition at line 110 of file sequence_tpl.h.

                                                    :
      iterator__{source.iterator__},
      seq__{source.seq__} {
    GUM_CONS_MOV(SequenceIteratorSafe);
  }

~SequenceIteratorSafe()

template<typename Key >

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

noexcept

Class destructor.

Definition at line 119 of file sequence_tpl.h.

                                                                     {
    GUM_DESTRUCTOR(SequenceIteratorSafe);
  }

SequenceIteratorSafe() [5/6]

template<typename Key>

template<typename Alloc , bool Gen>

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

noexcept

Definition at line 66 of file sequence_tpl.h.

                                                                    :
      seq__{reinterpret_cast<
         const SequenceImplementation< Key,
                                       std::allocator< Key >,
                                       std::is_scalar< Key >::value >* >(&seq)} {
    GUM_CONSTRUCTOR(SequenceIteratorSafe);

    if (pos > seq__->size())
      iterator__ = seq__->size();   // make the iterator point to end
    else
      iterator__ = pos;
  }

SequenceIteratorSafe() [6/6]

template<typename Key>

template<typename Alloc >

INLINE gum::SequenceIteratorSafe< Key >::SequenceIteratorSafe ( const Sequence< Key, Alloc > &  seq, Idx  pos  )

noexcept

Definition at line 84 of file sequence_tpl.h.

                                                 :
      seq__{reinterpret_cast<
         const SequenceImplementation< Key,
                                       std::allocator< Key >,
                                       std::is_scalar< Key >::value >* >(&seq)} {
    GUM_CONSTRUCTOR(SequenceIteratorSafe);

    if (pos > seq__->size())
      iterator__ = seq__->size();   // make the iterator point to end
    else
      iterator__ = pos;
  }

Member Function Documentation

operator!=()

template<typename Key>

INLINE 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 212 of file sequence_tpl.h.

                                                               {
    return !operator==(source);
  }

operator*()

template<typename Key >

INLINE 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 250 of file sequence_tpl.h.

                                                                 {
    return Getter::op_star(seq__->v__[pos()]);
  }

operator+()

template<typename Key >

INLINE 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 187 of file sequence_tpl.h.

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

operator++()

template<typename Key >

INLINE 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 144 of file sequence_tpl.h.

                                                      {
    if (iterator__ < seq__->size())
      ++iterator__;
    else
      iterator__ = seq__->size();

    return *this;
  }

operator+=()

template<typename Key >

INLINE 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 165 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;
  }

operator-()

template<typename Key >

INLINE 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 194 of file sequence_tpl.h.

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

operator--()

template<typename Key >

INLINE 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;
  }

operator-=()

template<typename Key >

INLINE 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 176 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 >

INLINE 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 256 of file sequence_tpl.h.

                                                                  {
    return Getter::op_arrow(seq__->v__[pos()]);
  }

operator=() [1/2]

template<typename Key>

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

noexcept

Copy operator.

Parameters

source

The iterator to copy.

Returns

Returns this iterator.

Definition at line 125 of file sequence_tpl.h.

                                                         {
    iterator__ = source.iterator__;
    seq__      = source.seq__;
    return *this;
  }

operator=() [2/2]

template<typename Key>

INLINE 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 134 of file sequence_tpl.h.

                                                    {
    iterator__ = source.iterator__;
    seq__      = source.seq__;
    return *this;
  }

operator==()

template<typename Key>

INLINE 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 200 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;
  }

pos()

template<typename Key >

INLINE 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 219 of file sequence_tpl.h.

                                                    {
    if (iterator__ >= seq__->size()) {
      GUM_ERROR(UndefinedIteratorValue, "iterator is end() or rend()");
    }

    return iterator__;
  }

setAtEnd__()

template<typename Key >

INLINE void gum::SequenceIteratorSafe< Key >::setAtEnd__ ( )

privatenoexcept

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

Definition at line 244 of file sequence_tpl.h.

                                                               {
    iterator__ = seq__->size();
  }

setAtRend__()

template<typename Key >

INLINE void gum::SequenceIteratorSafe< Key >::setAtRend__ ( )

privatenoexcept

The iterator points to rend.

Definition at line 238 of file sequence_tpl.h.

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

setPos__()

template<typename Key >

INLINE void gum::SequenceIteratorSafe< Key >::setPos__ ( Idx  pos )

privatenoexcept

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

Definition at line 229 of file sequence_tpl.h.

                                                                    {
    if (pos > seq__->size())
      iterator__ = seq__->size();
    else
      iterator__ = pos;
  }

Friends And Related Function Documentation

SequenceImplementation

template<typename Key>

template<typename K , typename A , bool >

friend class SequenceImplementation

friend

Friend to speed up access.

Definition at line 1208 of file sequence.h.

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 1416 of file sequence.h.

seq__

template<typename Key>

const SequenceImplementation< Key, std::allocator< Key >, std::is_scalar< Key >::value >* gum::SequenceIteratorSafe< Key >::seq__

private

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

Definition at line 1421 of file sequence.h.

---

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

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