Safe const iterators for Lists. More...

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

Inheritance diagram for gum::ListConstIteratorSafe< Val >:

Collaboration diagram for gum::ListConstIteratorSafe< Val >:

Public Types

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

Public Member Functions
Constructors / Destructors
	ListConstIteratorSafe () noexcept
	Default constructor.
	ListConstIteratorSafe (const List< Val > &theList)
	Constructor for a begin.
	ListConstIteratorSafe (const ListConstIteratorSafe< Val > &src)
	Copy constructor.
	ListConstIteratorSafe (const List< Val > &theList, Size ind_elt)
	Constructor for an iterator pointing to the ind_eltth element of a List.
	ListConstIteratorSafe (ListConstIteratorSafe< Val > &&src)
	Move constructor.
	~ListConstIteratorSafe ()
	Class Desctructor.
Accessors / Modifiers
void	clear ()
	Makes the iterator point toward nothing.
void	setToEnd ()
	Positions the iterator to the end of the list.
bool	isEnd () const
	Returns a bool indicating whether the iterator points to the end of the list.
Operators
ListConstIteratorSafe< Val > &	operator= (const ListConstIteratorSafe< Val > &src)
	Copy operator.
ListConstIteratorSafe< Val > &	operator= (ListConstIteratorSafe< Val > &&src)
	Move operator.
ListConstIteratorSafe< Val > &	operator++ () noexcept
	Makes the iterator point to the next element in the List.
ListConstIteratorSafe< Val > &	operator+= (difference_type i) noexcept
	Makes the iterator point to i elements further in the List.
ListConstIteratorSafe< Val > &	operator-- () noexcept
	Makes the iterator point to the preceding element in the List.
ListConstIteratorSafe< Val > &	operator-= (difference_type i) noexcept
	Makes the iterator point to i elements befor in the List.
ListConstIteratorSafe< Val >	operator+ (difference_type i) noexcept
	Returns a new iterator pointing to i further elements in the gum::List.
ListConstIteratorSafe< Val >	operator- (difference_type i) noexcept
	Returns a new iterator pointing to i preceding elements in the gum::List.
bool	operator!= (const ListConstIteratorSafe< Val > &src) const
	Checks whether two iterators point toward different elements.
bool	operator== (const ListConstIteratorSafe< Val > &src) const
	Checks whether two iterators point toward the same elements.
const Val &	operator* () const
	Gives access to the content of the iterator.
const Val *	operator-> () const
	Dereferences the value pointed to by the iterator.

Private Member Functions
ListBucket< Val > *	_getBucket_ () const noexcept
	Returns the bucket the iterator is pointing to.
void	_removeFromSafeList_ () const
	Remove the iterator for its list' safe iterators list.
ListConstIteratorSafe< Val > &	_opPlus_ (Size i) noexcept
	Makes the iterator point to the next element in the List.
ListConstIteratorSafe< Val > &	_opMinus_ (Size i) noexcept
	Makes the iterator point to i elements before in the List.

Private Attributes
const List< Val > *	_list_ {nullptr}
	The list the iterator is pointing to.
ListBucket< Val > *	_bucket_ {nullptr}
	The bucket in the chained list pointed to by the iterator.
ListBucket< Val > *	_next_current_bucket_ {nullptr}
	The bucket we should start from when we are pointing on a deleted bucket and we decide to do a ++.
ListBucket< Val > *	_prev_current_bucket_ {nullptr}
	The bucket we should start from when we are pointing on a deleted bucket and we decide to do a –.
bool	_null_pointing_ {false}
	Indicates whether the bucket the iterator points to has been deleted.

Friends

class	List< Val >
	class List must be a friend because it uses the getBucket method to speed up some processes.
class	ListConstIterator< Val >
	class List must be a friend because it uses the getBucket method to speed up some processes.

Detailed Description

template<typename Val>
class gum::ListConstIteratorSafe< Val >

Safe const iterators for Lists.

Class ListConstIteratorSafe implements safe const iterators for List. However, developers may consider using List<x>::const_iterator_safe instead of ListConstIteratorSafe<x>.

These const iterators ensure that whenever they point to an element that is being deleted from memory, their accessing this element will never produce a segmentation fault but rather throw an exception. Similarly, incrementing or decrementing an iterator pointing to a deleted element is guaranteed to make the iterator point on the next (or preceding) element that has not been deleted.

Usage example:: // create a list of strings

List<string> list;

list.pushBack ("toto"); list.pushBack ("titi");

// parse all the elements of a list

for ( List<string>::const_iterator_safe iter = list.cbeginSafe ();

iter != list.cendSafe (); ++iter )

cerr << *iter << endl;

for ( List<string>::const_iterator_safe iter = list.cbeginSafe ();

iter != list.cendSafe (); iter += 2 ) // step = 2

cerr << *iter << endl;

for ( List<string>::const_iterator_safe iter = list.cbeginSafe ();

iter != list.cendSafe (); iter = iter + 2 ) // step = 2

cerr << *iter << endl;

for ( List<string>::const_iterator_safe iter = list.crbeginSafe ();

iter != list.crendSafe (); --iter )

cerr << *iter << endl;

// use member size() of the strings

for ( List<string>::const_iterator_safe iter = list.cbeginSafe ();

iter != list.cendSafe (); ++iter )

cerr << iter->size() << endl;

gum::List
Generic doubly linked lists.
Definition list.h:378

gum::List::const_iterator_safe
ListConstIteratorSafe< Val > const_iterator_safe
Types for STL compliance.
Definition list.h:392

gum::List::pushBack
Val & pushBack(const Val &val)
Inserts a new element (a copy) at the end of the chained list.
Definition list_tpl.h:1481

gum::List::cbeginSafe
const_iterator_safe cbeginSafe() const
Returns a safe const iterator pointing to the beginning of the List.
Definition list_tpl.h:1335

gum::List::crbeginSafe
const_iterator_safe crbeginSafe() const
Returns a safe const iterator pointing to the last element of the List.
Definition list_tpl.h:1365

gum::List::cendSafe
const const_iterator_safe & cendSafe() const noexcept
Returns a safe const iterator pointing to the end of the List.
Definition list_tpl.h:1275

gum::List::crendSafe
const const_iterator_safe & crendSafe() const noexcept
Return a safe const iterator pointing just before the beginning of the List.
Definition list_tpl.h:1305

Template Parameters

Val	The gum::List values type.

Definition at line 2005 of file list.h.

Member Typedef Documentation

◆ const_pointer

template<typename Val>

using gum::ListConstIteratorSafe< Val >::const_pointer = const Val*

Types for STL compliance.

Definition at line 2014 of file list.h.

◆ const_reference

template<typename Val>

using gum::ListConstIteratorSafe< Val >::const_reference = const Val&

Types for STL compliance.

Definition at line 2012 of file list.h.

◆ difference_type

template<typename Val>

using gum::ListConstIteratorSafe< Val >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 2015 of file list.h.

◆ iterator_category

template<typename Val>

using gum::ListConstIteratorSafe< Val >::iterator_category = std::bidirectional_iterator_tag

Types for STL compliance.

Definition at line 2009 of file list.h.

◆ pointer

template<typename Val>

using gum::ListConstIteratorSafe< Val >::pointer = Val*

Types for STL compliance.

Definition at line 2013 of file list.h.

◆ reference

template<typename Val>

using gum::ListConstIteratorSafe< Val >::reference = Val&

Types for STL compliance.

Definition at line 2011 of file list.h.

◆ value_type

template<typename Val>

using gum::ListConstIteratorSafe< Val >::value_type = Val

Types for STL compliance.

Definition at line 2010 of file list.h.

Constructor & Destructor Documentation

◆ ListConstIteratorSafe() [1/5]

template<typename Val>

gum::ListConstIteratorSafe< Val >::ListConstIteratorSafe ( )

explicitnoexcept

Default constructor.

Returns an iterator pointing toward nothing.

Definition at line 507 of file list_tpl.h.

                                                               {
    // for debugging purposes
    GUM_CONSTRUCTOR(ListConstIteratorSafe);
  }

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), ListConstIteratorSafe(), ListConstIteratorSafe(), gum::ListIteratorSafe< Val >::ListIteratorSafe(), gum::ListIteratorSafe< Val >::ListIteratorSafe(), gum::ListIteratorSafe< Val >::ListIteratorSafe(), gum::ListIteratorSafe< Val >::ListIteratorSafe(), ~ListConstIteratorSafe(), _opMinus_(), _opPlus_(), operator!=(), operator+(), operator++(), operator+=(), operator-(), operator--(), operator-=(), operator=(), and operator==().

Here is the caller graph for this function:

◆ ListConstIteratorSafe() [2/5]

template<typename Val>

gum::ListConstIteratorSafe< Val >::ListConstIteratorSafe ( const List< Val > & theList )

Constructor for a begin.

Definition at line 514 of file list_tpl.h.

                                                                                :
      _list_{&theList}, _bucket_{theList._deb_list_} {
    // for debugging purposes
    GUM_CONSTRUCTOR(ListConstIteratorSafe);
 
    // add the iterator to the list of safe iterators
    theList._safe_iterators_.push_back(this);
  }

References ListConstIteratorSafe(), _bucket_, _list_, and List< Val >.

Here is the call graph for this function:

◆ ListConstIteratorSafe() [3/5]

template<typename Val>

gum::ListConstIteratorSafe< Val >::ListConstIteratorSafe ( const ListConstIteratorSafe< Val > & src )

Copy constructor.

Parameters

src	The gum::ListConstIteratorSafe to copy.

Definition at line 525 of file list_tpl.h.

                                                                                             :
      _list_{src._list_}, _bucket_{src._bucket_}, _next_current_bucket_{src._next_current_bucket_},
      _prev_current_bucket_{src._prev_current_bucket_}, _null_pointing_{src._null_pointing_} {
    // for debugging purposes
    GUM_CONS_CPY(ListConstIteratorSafe);
 
    // add the iterator to the list of safe iterators
    if (_list_ != nullptr) _list_->_safe_iterators_.push_back(this);
  }

References ListConstIteratorSafe(), _bucket_, _list_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Here is the call graph for this function:

◆ ListConstIteratorSafe() [4/5]

template<typename Val>

gum::ListConstIteratorSafe< Val >::ListConstIteratorSafe	(	const List< Val > &	theList,
		Size	ind_elt )

Constructor for an iterator pointing to the ind_eltth element of a List.

Parameters

theList	The list to iterate over.
ind_elt	The iterator starting position.

Exceptions

UndefinedIteratorValue Raised if the element does not exist in the list.

Definition at line 539 of file list_tpl.h.

                                                                                              :
      _list_{&theList} {
    // for debugging purposes
    GUM_CONSTRUCTOR(ListConstIteratorSafe);
 
    // check if the index ind_elt passed as parameter is valid
    if (ind_elt >= _list_->_nb_elements_) {
      GUM_ERROR(UndefinedIteratorValue, "Not enough elements in the list")
    }
 
    // check if it is faster to find the indexth element src the start or
    // src the end of the list
    if (ind_elt < (_list_->_nb_elements_ >> 1)) {
      // find the element we shall point to src the start of the list
      for (_bucket_ = _list_->_deb_list_; ind_elt; --ind_elt, _bucket_ = _bucket_->_next_) {}
    } else {
      // find the element we shall point to src the end of the list
      for (_bucket_ = _list_->_end_list_, ind_elt = _list_->_nb_elements_ - ind_elt - 1; ind_elt;
           --ind_elt, _bucket_                    = _bucket_->_prev_) {}
    }
 
    // add the iterator to the list of safe iterators
    theList._safe_iterators_.push_back(this);
  }

References ListConstIteratorSafe(), _list_, GUM_ERROR, and List< Val >.

Here is the call graph for this function:

◆ ListConstIteratorSafe() [5/5]

template<typename Val>

gum::ListConstIteratorSafe< Val >::ListConstIteratorSafe ( ListConstIteratorSafe< Val > && src )

Move constructor.

Parameters

src	The gum::ListConstIterator to move.

Definition at line 566 of file list_tpl.h.

                                                                                        :
      _list_{src._list_}, _bucket_{src._bucket_}, _next_current_bucket_{src._next_current_bucket_},
      _prev_current_bucket_{src._prev_current_bucket_}, _null_pointing_{src._null_pointing_} {
    // for debugging purposes
    GUM_CONS_MOV(ListConstIteratorSafe);
 
    if (_list_ != nullptr) {
      // substitute src by this in the list of safe iterators
      std::vector< ListConstIteratorSafe< Val >* >& vect = _list_->_safe_iterators_;
 
      for (auto ptr = vect.rbegin(); ptr != vect.rend(); --ptr) {
        if (*ptr == &src) {
          *ptr = this;
          break;
        }
      }
 
      src._list_          = nullptr;
      src._bucket_        = nullptr;
      src._null_pointing_ = false;
    }
  }

References ListConstIteratorSafe(), _bucket_, _list_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Here is the call graph for this function:

◆ ~ListConstIteratorSafe()

template<typename Val>

gum::ListConstIteratorSafe< Val >::~ListConstIteratorSafe ( )

Class Desctructor.

Definition at line 690 of file list_tpl.h.

                                                       {
    // for debugging purposes
    GUM_DESTRUCTOR(ListConstIteratorSafe);
 
    // remove the iterator src the table's iterator list
    if (_list_) _removeFromSafeList_();
  }

References ListConstIteratorSafe(), _list_, and _removeFromSafeList_().

Here is the call graph for this function:

Member Function Documentation

◆ _getBucket_()

template<typename Val>

ListBucket< Val > * gum::ListConstIteratorSafe< Val >::_getBucket_ ( ) const

privatenoexcept

Returns the bucket the iterator is pointing to.

Definition at line 700 of file list_tpl.h.

                                                                              {
    return _bucket_;
  }

Referenced by gum::List< Val >::_insert_(), gum::List< Val >::erase(), and gum::List< Val >::erase().

Here is the caller graph for this function:

◆ _opMinus_()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::_opMinus_ ( Size i )

privatenoexcept

Makes the iterator point to i elements before in the List.

Definition at line 769 of file list_tpl.h.

                                                                                       {
    // check if we are pointing to something that has been deleted
    if (_null_pointing_) {
      _null_pointing_ = false;
 
      // if we are pointing to an element of the chained list that has been
      // deleted
      // but that has a preceding element, just point on the latter
      if (_prev_current_bucket_ != nullptr) {
        _bucket_ = _prev_current_bucket_->_prev_;
      } else {
        // here we were pointing on an extremity of the list (either end or
        // rend)
        // if next_current_bucket is not null, then we are at end and doing
        // a -- shall now point to the beginning of the list
        if (_next_current_bucket_ != nullptr) {
          _bucket_ = _next_current_bucket_;
        } else {
          // here, we are at the rend of the chained list, hence we shall remain
          // at rend
          _bucket_ = nullptr;
          return *this;
        }
      }
    } else {
      // if we are pointing to an element of the chained list, just
      // point on the preceding bucket in this list
      if (_bucket_ != nullptr) { _bucket_ = _bucket_->_prev_; }
    }
 
    for (--i; i && (_bucket_ != nullptr); --i, _bucket_ = _bucket_->_prev_) {}
 
    return *this;
  }

References ListConstIteratorSafe(), and _null_pointing_.

Referenced by operator+=(), and operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _opPlus_()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::_opPlus_ ( Size i )

privatenoexcept

Makes the iterator point to the next element in the List.

Definition at line 806 of file list_tpl.h.

                                                                                      {
    // check if we are pointing to something that has been deleted
    if (_null_pointing_) {
      _null_pointing_ = false;
 
      // if we are pointing to an element of the chained list that has been
      // deleted
      // but that has a next element, just point on the latter
      if (_next_current_bucket_ != nullptr) {
        _bucket_ = _next_current_bucket_->_next_;
      } else {
        // here we were pointing on an extremity of the list (either end or
        // rend)
        // if prev_current_bucket is not null, then we are at rend and doing
        // a ++ shall now point to the beginning of the list
        if (_prev_current_bucket_ != nullptr) {
          _bucket_ = _prev_current_bucket_;
        } else {
          // here, we are at the end of the chained list, hence we shall
          // remain at end
          _bucket_ = nullptr;
          return *this;
        }
      }
    } else {
      // if we are pointing to an element of the chained list, just
      // point on the next bucket in this list
      if (_bucket_ != nullptr) { _bucket_ = _bucket_->_next_; }
    }
 
    for (--i; i && (_bucket_ != nullptr); --i, _bucket_ = _bucket_->_next_) {}
 
    return *this;
  }

References ListConstIteratorSafe(), _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Referenced by operator+=(), and operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _removeFromSafeList_()

template<typename Val>

void gum::ListConstIteratorSafe< Val >::_removeFromSafeList_ ( ) const

private

Remove the iterator for its list' safe iterators list.

Definition at line 591 of file list_tpl.h.

                                                                {
    // find where the iterator is
    std::vector< ListConstIteratorSafe< Val >* >& vect = _list_->_safe_iterators_;
 
    for (auto i = vect.size() - 1; i >= 0; --i) {
      if (vect[i] == this) {
        vect.erase(vect.begin() + i);
        break;
      }
    }
  }

References _list_.

Referenced by ~ListConstIteratorSafe(), and clear().

Here is the caller graph for this function:

◆ clear()

template<typename Val>

void gum::ListConstIteratorSafe< Val >::clear ( )

Makes the iterator point toward nothing.

A method for detaching the iterator from the List it is attached to. It is mainly used by the List when the latter is deleted while the iterator is still alive. After being detached, the iterator does not point to any element, i.e., trying to access its content will raise an exception.

Definition at line 706 of file list_tpl.h.

                                           {
    // remove the iterator src the list's iterator list
    if (_list_) _removeFromSafeList_();
 
    // set its list as well as the element it points to to nullptr
    _list_          = nullptr;
    _bucket_        = nullptr;
    _null_pointing_ = false;
  }

References _bucket_, _list_, _null_pointing_, and _removeFromSafeList_().

Referenced by setToEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnd()

template<typename Val>

bool gum::ListConstIteratorSafe< Val >::isEnd ( ) const

Returns a bool indicating whether the iterator points to the end of the list.

Returns: Returns a bool indicating whether the iterator points to the end of the list.

Definition at line 725 of file list_tpl.h.

                                                 {
    return _null_pointing_
             ? (_next_current_bucket_ == nullptr) && (_prev_current_bucket_ == nullptr)
             : (_bucket_ == nullptr);
  }

References _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

◆ operator!=()

template<typename Val>

bool gum::ListConstIteratorSafe< Val >::operator!= ( const ListConstIteratorSafe< Val > & src ) const

Checks whether two iterators point toward different elements.

Warning: the end and rend iterators are always equal, whatever the list they belong to, i.e., list1.end() == list2.rend().

Parameters

src	The gum::ListConstIteratorSafe to test for inequality.

Returns: Returns true if src and this are equal.

Definition at line 913 of file list_tpl.h.

                                                                                           {
    return _null_pointing_ ? (_next_current_bucket_ != src._next_current_bucket_)
                                 || (_prev_current_bucket_ != src._prev_current_bucket_)
                           : (_bucket_ != src._bucket_);
  }

References ListConstIteratorSafe(), _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Here is the call graph for this function:

◆ operator*()

template<typename Val>

const Val & gum::ListConstIteratorSafe< Val >::operator* ( ) const

Gives access to the content of the iterator.

Exceptions

UndefinedIteratorValue Raised if the iterator points to nothing.

Returns: Returns the content of the iterator.

Definition at line 936 of file list_tpl.h.

                                                           {
    if (_bucket_ != nullptr) return _bucket_->_val_;
    else { GUM_ERROR(UndefinedIteratorValue, "Accessing a NULL object") }
  }

References _bucket_, and GUM_ERROR.

Referenced by gum::ListIteratorSafe< Val >::operator*(), and gum::ListIteratorSafe< Val >::operator*().

Here is the caller graph for this function:

◆ operator+()

template<typename Val>

ListConstIteratorSafe< Val > gum::ListConstIteratorSafe< Val >::operator+ ( difference_type i )

noexcept

Returns a new iterator pointing to i further elements in the gum::List.

Parameters

i	The number of steps to move the iterator.

Returns: Returns a new gum::ListConstIteratoSafe.

Definition at line 899 of file list_tpl.h.

                                                                       {
    return ListConstIteratorSafe< Val >(*this) += i;
  }

References ListConstIteratorSafe().

Here is the call graph for this function:

◆ operator++()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator++ ( )

noexcept

Makes the iterator point to the next element in the List.

for (iter = list.begin(); iter != list.end(); ++iter) { }

The above loop is guaranteed to parse the whole List as long as no element is added to or deleted from the List while being in the loop. Runs in constant time.

Returns: Returns this gum::ListConstIteratorSafe.

Definition at line 733 of file list_tpl.h.

                                                                                  {
    // check if we are pointing to something that has been deleted
    if (_null_pointing_) {
      _null_pointing_ = false;
 
      // if we are pointing to an element of the chained list that has been
      // deleted
      // but that has a next element, just point on the latter
      if (_next_current_bucket_ != nullptr) {
        _bucket_ = _next_current_bucket_->_next_;
        return *this;
      }
 
      // here we were pointing on an extremity of the list (either end or rend)
      // if prev_current_bucket is not null, then we are at rend and doing
      // a ++ shall now point to the beginning of the list
      if (_prev_current_bucket_ != nullptr) {
        _bucket_ = _prev_current_bucket_;
        return *this;
      }
 
      // here, we are at the end of the chained list, hence we shall remain at
      // end
      _bucket_ = nullptr;
      return *this;
    } else {
      // if we are pointing to an element of the chained list, just
      // point on the next bucket in this list
      if (_bucket_ != nullptr) { _bucket_ = _bucket_->_next_; }
 
      return *this;
    }
  }

References ListConstIteratorSafe(), _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Referenced by gum::ListIteratorSafe< Val >::operator++().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator+=()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator+= ( difference_type i )

noexcept

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

Parameters

i	The number of steps to move the iterator.

Returns: Returns this gum::ListConstIterator.

Definition at line 843 of file list_tpl.h.

                                                                       {
    if (!i) return *this;
 
    if (i < 0) return _opMinus_(-i);
    else return _opPlus_(i);
  }

References ListConstIteratorSafe(), _opMinus_(), and _opPlus_().

Referenced by gum::ListIteratorSafe< Val >::operator+=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator-()

template<typename Val>

ListConstIteratorSafe< Val > gum::ListConstIteratorSafe< Val >::operator- ( difference_type i )

noexcept

Returns a new iterator pointing to i preceding elements in the gum::List.

Parameters

i	The number of steps to move the iterator.

Returns: Returns a new gum::ListConstIteratorSafe.

Definition at line 906 of file list_tpl.h.

                                                                       {
    return ListConstIteratorSafe< Val >(*this) -= i;
  }

References ListConstIteratorSafe().

Here is the call graph for this function:

◆ operator--()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator-- ( )

noexcept

Makes the iterator point to the preceding element in the List.

for (iter = list.rbegin(); iter != list.rend(); --iter) { }

The above loop is guaranteed to parse the whole List as long as no element is added to or deleted from the List while being in the loop. Runs in constant time.

Returns: Returns this gum::ListConstIteratorSafe.

Definition at line 853 of file list_tpl.h.

                                                                                  {
    // check if we are pointing to something that has been deleted
    if (_null_pointing_) {
      _null_pointing_ = false;
 
      // if we are pointing to an element of the chained list that has been
      // deleted
      // but that has a preceding element, just point on the latter
      if (_prev_current_bucket_ != nullptr) {
        _bucket_ = _prev_current_bucket_->_prev_;
        return *this;
      }
 
      // here we were pointing on an extremity of the list (either end or rend)
      // if next_current_bucket is not null, then we are at end and doing
      // a -- shall now point to the beginning of the list
      if (_next_current_bucket_ != nullptr) {
        _bucket_ = _next_current_bucket_;
        return *this;
      }
 
      // here, we are at the rend of the chained list, hence we shall remain
      // at rend
      _bucket_ = nullptr;
      return *this;
    } else {
      // if we are pointing to an element of the chained list, just
      // point on the preceding bucket in this list
      if (_bucket_ != nullptr) { _bucket_ = _bucket_->_prev_; }
 
      return *this;
    }
  }

References ListConstIteratorSafe(), _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Referenced by gum::ListIteratorSafe< Val >::operator--().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator-=()

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator-= ( difference_type i )

noexcept

Makes the iterator point to i elements befor in the List.

Parameters

i	The number of steps to move the iterator.

Returns: Returns this gum::ListConstIteratorSafe.

Definition at line 889 of file list_tpl.h.

                                                                       {
    if (!i) return *this;
 
    if (i < 0) return _opPlus_(-i);
    else return _opMinus_(i);
  }

References ListConstIteratorSafe(), _opMinus_(), and _opPlus_().

Referenced by gum::ListIteratorSafe< Val >::operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator->()

template<typename Val>

const Val * gum::ListConstIteratorSafe< Val >::operator-> ( ) const

Dereferences the value pointed to by the iterator.

Exceptions

UndefinedIteratorValue Raised if the iterator points to nothing.

Returns: Returns the value pointed to by the iterator.

Definition at line 929 of file list_tpl.h.

                                                            {
    if (_bucket_ != nullptr) return &(_bucket_->_val_);
    else { GUM_ERROR(UndefinedIteratorValue, "Accessing a NULL object") }
  }

References _bucket_, and GUM_ERROR.

Referenced by gum::ListIteratorSafe< Val >::operator->(), and gum::ListIteratorSafe< Val >::operator->().

Here is the caller graph for this function:

◆ operator=() [1/2]

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator= ( const ListConstIteratorSafe< Val > & src )

Copy operator.

The current iterator now points to the same element as iterator from.

Parameters

src	The gum::ListConstIteratorSafe to copy.

Returns: Returns this gum::ListConstIteratorSafe.

Definition at line 606 of file list_tpl.h.

                                                                                   {
    // avoid self assignment
    if (this != &src) {
      // for debugging purposes
      GUM_OP_CPY(ListConstIteratorSafe);
 
      // check if src and this belong to the same list. If this is not
      // the case, we shall remove this from its iterator's list and
      // put it into src's list one.
      if (_list_ && (src._list_ != _list_)) {
        _removeFromSafeList_();
        _list_ = nullptr;
      }
 
      // if necessary, put this into the same list of safe iterators as src
      if (src._list_ && (src._list_ != _list_)) {
        try {
          src._list_->_safe_iterators_.push_back(this);
        } catch (...) {
          _list_          = nullptr;
          _bucket_        = nullptr;
          _null_pointing_ = false;
          throw;
        }
      }
 
      _list_                = src._list_;
      _bucket_              = src._bucket_;
      _prev_current_bucket_ = src._prev_current_bucket_;
      _next_current_bucket_ = src._next_current_bucket_;
      _null_pointing_       = src._null_pointing_;
    }
 
    return *this;
  }

Referenced by gum::ListIteratorSafe< Val >::operator=().

Here is the caller graph for this function:

◆ operator=() [2/2]

template<typename Val>

ListConstIteratorSafe< Val > & gum::ListConstIteratorSafe< Val >::operator= ( ListConstIteratorSafe< Val > && src )

Move operator.

Parameters

src	The gum::ListConstIteratorSafe to move.

Returns: Returns this gum::ListConstIteratorSafe.

Definition at line 645 of file list_tpl.h.

                                                                              {
    // avoid self assignment
    if (this != &src) {
      // for debugging purposes
      GUM_OP_MOV(ListConstIteratorSafe);
 
      // if the two iterators do not point to the same list, remove
      // the current iterator from its safe iterators list
      if ((_list_ != nullptr) && (src._list_ != _list_)) {
        _removeFromSafeList_();
        _list_ = nullptr;
      }
 
      // now if src points to a list, put this at its location
      if ((src._list_ != nullptr)) {
        std::vector< ListConstIteratorSafe< Val >* >& vect      = src._list_->_safe_iterators_;
        Idx                                           index_src = Size(vect.size()) - 1;
 
        for (;; --index_src) {
          if (vect[index_src] == &src) { break; }
        }
 
        if (_list_ == nullptr) {
          vect[index_src] = this;
        } else {
          vect.erase(vect.begin() + index_src);
        }
      }
 
      _list_                = src._list_;
      _bucket_              = src._bucket_;
      _prev_current_bucket_ = src._prev_current_bucket_;
      _next_current_bucket_ = src._next_current_bucket_;
      _null_pointing_       = src._null_pointing_;
 
      src._list_          = nullptr;
      src._bucket_        = nullptr;
      src._null_pointing_ = false;
    }
 
    return *this;
  }

References ListConstIteratorSafe(), and _list_.

Here is the call graph for this function:

◆ operator==()

template<typename Val>

bool gum::ListConstIteratorSafe< Val >::operator== ( const ListConstIteratorSafe< Val > & src ) const

Checks whether two iterators point toward the same elements.

Warning: the end and rend iterators are always equal, whatever the list they belong to, i.e., list1.end() == list2.rend().

Parameters

src	The gum::ListConstIteratorSafe to test for equality.

Returns: Returns true if src and this are equal.

Definition at line 921 of file list_tpl.h.

                                                                                           {
    return _null_pointing_ ? (_next_current_bucket_ == src._next_current_bucket_)
                                 && (_prev_current_bucket_ == src._prev_current_bucket_)
                           : (_bucket_ == src._bucket_);
  }

References ListConstIteratorSafe(), _bucket_, _next_current_bucket_, _null_pointing_, and _prev_current_bucket_.

Referenced by gum::ListIteratorSafe< Val >::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setToEnd()

template<typename Val>

void gum::ListConstIteratorSafe< Val >::setToEnd ( )

Positions the iterator to the end of the list.

Definition at line 718 of file list_tpl.h.

                                              {
    clear();
  }

References clear().

Here is the call graph for this function:

◆ List< Val >

template<typename Val>

friend class List< Val >

friend

class List must be a friend because it uses the getBucket method to speed up some processes.

Definition at line 2216 of file list.h.

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), gum::ListIteratorSafe< Val >::ListIteratorSafe(), and gum::ListIteratorSafe< Val >::ListIteratorSafe().

◆ ListConstIterator< Val >

template<typename Val>

friend class ListConstIterator< Val >

friend

class List must be a friend because it uses the getBucket method to speed up some processes.

Definition at line 2216 of file list.h.

Member Data Documentation

◆ _bucket_

template<typename Val>

ListBucket< Val >* gum::ListConstIteratorSafe< Val >::_bucket_ {nullptr}

private

The bucket in the chained list pointed to by the iterator.

Definition at line 2232 of file list.h.

2232{nullptr};

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), ListConstIteratorSafe(), _opPlus_(), clear(), isEnd(), operator!=(), operator*(), operator++(), operator--(), operator->(), and operator==().

◆ _list_

template<typename Val>

const List< Val >* gum::ListConstIteratorSafe< Val >::_list_ {nullptr}

private

The list the iterator is pointing to.

Definition at line 2229 of file list.h.

2229{nullptr};

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), ListConstIteratorSafe(), ListConstIteratorSafe(), ~ListConstIteratorSafe(), _removeFromSafeList_(), clear(), gum::List< gum::Instantiation * >::crend(), gum::List< Val >::insert(), gum::List< Val >::insert(), operator=(), and gum::List< gum::Instantiation * >::rend().

◆ _next_current_bucket_

template<typename Val>

ListBucket< Val >* gum::ListConstIteratorSafe< Val >::_next_current_bucket_ {nullptr}

private

The bucket we should start from when we are pointing on a deleted bucket and we decide to do a ++.

Definition at line 2236 of file list.h.

2236{nullptr};

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), gum::List< Val >::_insert_(), _opPlus_(), isEnd(), operator!=(), operator++(), operator--(), and operator==().

◆ _null_pointing_

template<typename Val>

bool gum::ListConstIteratorSafe< Val >::_null_pointing_ {false}

private

Indicates whether the bucket the iterator points to has been deleted.

Definition at line 2243 of file list.h.

2243{false};

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), gum::List< Val >::_insert_(), _opMinus_(), _opPlus_(), clear(), isEnd(), operator!=(), operator++(), operator--(), and operator==().

◆ _prev_current_bucket_

template<typename Val>

ListBucket< Val >* gum::ListConstIteratorSafe< Val >::_prev_current_bucket_ {nullptr}

private

The bucket we should start from when we are pointing on a deleted bucket and we decide to do a –.

Definition at line 2240 of file list.h.

2240{nullptr};

Referenced by ListConstIteratorSafe(), ListConstIteratorSafe(), gum::List< Val >::_insert_(), _opPlus_(), isEnd(), operator!=(), operator++(), operator--(), and operator==().

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

agrum/base/core/list.h
agrum/base/core/list_tpl.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_pointer

◆ const_reference

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ ListConstIteratorSafe() [1/5]

◆ ListConstIteratorSafe() [2/5]

◆ ListConstIteratorSafe() [3/5]

◆ ListConstIteratorSafe() [4/5]

◆ ListConstIteratorSafe() [5/5]

◆ ~ListConstIteratorSafe()

Member Function Documentation

◆ _getBucket_()

◆ _opMinus_()

◆ _opPlus_()

◆ _removeFromSafeList_()

◆ clear()

◆ isEnd()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++()

◆ operator+=()

◆ operator-()

◆ operator--()

◆ operator-=()

◆ operator->()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setToEnd()

Friends And Related Symbol Documentation

◆ List< Val >

◆ ListConstIterator< Val >

Member Data Documentation

◆ _bucket_

◆ _list_

◆ _next_current_bucket_

◆ _null_pointing_

◆ _prev_current_bucket_