gum::HashTableConstIteratorSafe< Key, Val > Class Template Reference

Safe Const Iterators for hashtables. More...

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

Inheritance diagram for gum::HashTableConstIteratorSafe< Key, Val >:

Collaboration diagram for gum::HashTableConstIteratorSafe< Key, Val >:

Public Member Functions
template<typename Alloc >
INLINE	HashTableConstIteratorSafe (const HashTable< Key, Val, Alloc > &tab)
Constructors / Destructors
	HashTableConstIteratorSafe ()
	Basic constructor: creates an iterator pointing to nothing. More...
template<typename Alloc >
	HashTableConstIteratorSafe (const HashTable< Key, Val, Alloc > &tab)
	Constructor for an iterator pointing to the first element of a hashtable. More...
template<typename Alloc >
	HashTableConstIteratorSafe (const HashTable< Key, Val, Alloc > &tab, Size ind_elt)
	Constructor for an iterator pointing to the nth element of a hashtable. More...
	HashTableConstIteratorSafe (const HashTableConstIteratorSafe< Key, Val > &from)
	Copy constructor. More...
	HashTableConstIteratorSafe (const HashTableConstIterator< Key, Val > &from)
	Copy constructor. More...
	HashTableConstIteratorSafe (HashTableConstIteratorSafe< Key, Val > &&from)
	Move constructor. More...
	~HashTableConstIteratorSafe () noexcept
	Destructor. More...
Accessors / Modifiers
const key_type &	key () const
	Returns the key pointed to by the iterator. More...
const mapped_type &	val () const
	Returns the mapped value pointed to by the iterator. More...
void	clear () noexcept
	Makes the iterator point toward nothing (in particular, it is not related anymore to its current hash table). More...
Operators
HashTableConstIteratorSafe< Key, Val > &	operator= (const HashTableConstIteratorSafe< Key, Val > &from)
	Copy operator. More...
HashTableConstIteratorSafe< Key, Val > &	operator= (const HashTableConstIterator< Key, Val > &from)
	Copy operator. More...
HashTableConstIteratorSafe< Key, Val > &	operator= (HashTableConstIteratorSafe< Key, Val > &&from) noexcept
	Move operator. More...
HashTableConstIteratorSafe< Key, Val > &	operator++ () noexcept
	Makes the iterator point to the next element in the hash table. More...
HashTableConstIteratorSafe< Key, Val > &	operator+= (Size i) noexcept
	Makes the iterator point to i elements further in the hashtable. More...
HashTableConstIteratorSafe< Key, Val >	operator+ (Size i) const
	Returns a new iterator poiting to i elements further in the hashtable. More...
bool	operator!= (const HashTableConstIteratorSafe< Key, Val > &from) const noexcept
	Checks whether two iterators are not equal. More...
bool	operator== (const HashTableConstIteratorSafe< Key, Val > &from) const noexcept
	Checks whether two iterators are equal. More...
const value_type &	operator* () const
	Returns the element pointed to by the iterator. More...

Public Types
using	iterator_category = std::forward_iterator_tag
	Types for STL compliance. More...
using	key_type = Key
	Types for STL compliance. More...
using	mapped_type = Val
	Types for STL compliance. More...
using	value_type = std::pair< const Key, Val >
	Types for STL compliance. More...
using	reference = value_type &
	Types for STL compliance. More...
using	const_reference = const value_type &
	Types for STL compliance. More...
using	pointer = value_type *
	Types for STL compliance. More...
using	const_pointer = const value_type *
	Types for STL compliance. More...
using	difference_type = std::ptrdiff_t
	Types for STL compliance. More...

Protected Attributes
const HashTable< Key, Val > *	table__ {nullptr}
	The hash table the iterator is pointing to. More...
Size	index__ {Size(0)}
	the index of the chained list pointed to by the iterator in the array nodes__ of the hash table. More...
HashTableBucket< Key, Val > *	bucket__ {nullptr}
	The bucket in the chained list pointed to by the iterator. More...
HashTableBucket< Key, Val > *	next_bucket__ {nullptr}
	the bucket we should start from when we decide to do a ++. More...

Protected Member Functions
HashTableBucket< Key, Val > *	getBucket__ () const noexcept
	Returns the current iterator's bucket. More...
Size	getIndex__ () const noexcept
	Returns the index in the hashtable's node vector pointed to by the iterator. More...
void	removeFromSafeList__ () const
	Removes the iterator from its hashtable' safe iterators list. More...
void	insertIntoSafeList__ () const
	Insert the iterator into the hashtable's list of safe iterators. More...

Friends
template<typename K , typename V , typename A >
class	HashTable
	Class HashTable must be a friend because it stores iterator end and this can be properly initialized only when the hashtable has been fully allocated. More...

Detailed Description

template<typename Key, typename Val>
class gum::HashTableConstIteratorSafe< Key, Val >

Safe Const Iterators for hashtables.

HashTableConstIteratorSafe provides a safe way to parse HashTables. They are safe because they are kept informed by the hashtable they belong to of the elements deleted by the user. Hence, even if the user removes an element pointed to by a HashTableConstIteratorSafe, using the latter to access this element will never crash the application. Instead it will properly throw a UndefinedIteratorValue exception.

Developers may consider using HashTable<x,y>::const_iterator_safe instead of HashTableConstIteratorSafe<x,y>.

Usage example:

// creation of a hash table with 10 elements
HashTable<int,string> table;
for (int i = 0; i< 10; ++i)
  table.insert (i,"xxx" + string (i,'x'));

// parse the hash table
for (HashTable<int,string>::const_iterator_safe iter = table.cbeginSafe ();
       iter != table.cendSafe (); ++iter) {
  // display the values
  cerr << "at " << iter.key () << " value = " << iter.val () << endl;
  const HashTable<int,string>::value_type& elt = *iter;
  const std::pair<const int, string>& xelt = *iter;
}

// check whether two iterators point toward the same element
HashTable<int,string>::const_iterator_safe iter1 = table1.cbeginSafe ();
HashTable<int,string>::const_iterator_safe iter2 = table1.cendSafe ();
if (iter1 != iter) {
  cerr << "iter1 and iter2 point toward different elements";
}

// make iter1 point toward nothing
iter1.clear ();

Definition at line 1922 of file hashTable.h.

Member Typedef Documentation

const_pointer

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::const_pointer = const value_type*

Types for STL compliance.

Definition at line 1933 of file hashTable.h.

const_reference

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::const_reference = const value_type&

Types for STL compliance.

Definition at line 1931 of file hashTable.h.

difference_type

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 1934 of file hashTable.h.

iterator_category

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::iterator_category = std::forward_iterator_tag

Types for STL compliance.

Definition at line 1926 of file hashTable.h.

key_type

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::key_type = Key

Types for STL compliance.

Definition at line 1927 of file hashTable.h.

mapped_type

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::mapped_type = Val

Types for STL compliance.

Definition at line 1928 of file hashTable.h.

pointer

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::pointer = value_type*

Types for STL compliance.

Definition at line 1932 of file hashTable.h.

reference

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::reference = value_type&

Types for STL compliance.

Definition at line 1930 of file hashTable.h.

value_type

template<typename Key, typename Val>

using gum::HashTableConstIteratorSafe< Key, Val >::value_type = std::pair< const Key, Val >

Types for STL compliance.

Definition at line 1929 of file hashTable.h.

Constructor & Destructor Documentation

HashTableConstIteratorSafe() [1/7]

template<typename Key , typename Val >

INLINE gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe

(

)

Basic constructor: creates an iterator pointing to nothing.

Definition at line 1322 of file hashTable_tpl.h.

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

HashTableConstIteratorSafe() [2/7]

template<typename Key, typename Val>

template<typename Alloc >

gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe

(

const HashTable< Key, Val, Alloc > &

tab

)

Constructor for an iterator pointing to the first element of a hashtable.

Template Parameters

Alloc

The gum::HashTable allocator.

Parameters

tab	A gum::HashTable to iterate over.

HashTableConstIteratorSafe() [3/7]

template<typename Key, typename Val>

template<typename Alloc >

gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe	(	const HashTable< Key, Val, Alloc > &	tab,
		Size	ind_elt
	)

Constructor for an iterator pointing to the nth element of a hashtable.

The method runs in time linear to ind_elt.

Template Parameters

Alloc

The gum::HashTable allocator.

Parameters

tab	the hash table to which the so-called element belongs
ind_elt	the position of the element in the hash table (0 means the first element).

Exceptions

UndefinedIteratorValue

Raised if the element cannot be found.

Definition at line 1359 of file hashTable_tpl.h.

                                                  :
      table__{reinterpret_cast< const HashTable< Key, Val >* >(&tab)} {
    Size i;

    // check if we are looking for a begin() and we know for sure its index
    if ((ind_elt == Size(0))
        && (table__->begin_index__ != std::numeric_limits< Size >::max())) {
      index__  = table__->begin_index__;
      bucket__ = table__->nodes__[index__].end_list__;
    } else {
      // check if it is faster to find the ind_eltth element from the start or
      // from the end of the hashtable
      if (ind_elt < (table__->nb_elements__ >> 1)) {
        // find the element we shall point to from the start of the hashtable
        for (i = table__->size__ - 1;; --i) {   // no test on i since
          // ind_elt < table_->nb_elements__
          if (table__->nodes__[i].nb_elements__) {
            if (ind_elt >= table__->nodes__[i].nb_elements__)
              ind_elt -= table__->nodes__[i].nb_elements__;
            else {
              for (bucket__ = table__->nodes__[i].end_list__; ind_elt;
                   --ind_elt, bucket__ = bucket__->prev) {}

              index__ = i;
              break;
            }
          }
        }
      } else {
        // ind_elt = the index of the element we should point to
        // check if the index passed as parameter is valid
        if (ind_elt >= table__->nb_elements__) {
          GUM_ERROR(UndefinedIteratorValue,
                    "Not enough elements in the hashtable");
        }

        // find the element we shall point to from the end of the hashtable
        for (i = 0, ind_elt = table__->nb_elements__ - ind_elt - 1;; ++i) {
          if (table__->nodes__[i].nb_elements__) {
            if (ind_elt >= table__->nodes__[i].nb_elements__)
              ind_elt -= table__->nodes__[i].nb_elements__;
            else {
              for (bucket__ = table__->nodes__[i].deb_list__; ind_elt;
                   --ind_elt, bucket__ = bucket__->next) {}

              index__ = i;
              break;
            }
          }
        }
      }
    }

    // for debugging purposes
    GUM_CONSTRUCTOR(HashTableConstIteratorSafe);

    // make the hashtable keep track of this iterator
    insertIntoSafeList__();
  }

HashTableConstIteratorSafe() [4/7]

template<typename Key, typename Val>

INLINE gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe

(

const HashTableConstIteratorSafe< Key, Val > &

from

)

Copy constructor.

Parameters

from	The gum::HashTableConstIteratorSafe to copy.

Definition at line 1422 of file hashTable_tpl.h.

                                                         :
      table__{from.table__},
      index__{from.index__}, bucket__{from.bucket__}, next_bucket__{
                                                         from.next_bucket__} {
    // make the hashtable keep track of this iterator
    if (table__ != nullptr) { insertIntoSafeList__(); }

    // for debugging purposes
    GUM_CONS_CPY(HashTableConstIteratorSafe);
  }

HashTableConstIteratorSafe() [5/7]

template<typename Key, typename Val>

INLINE gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe ( const HashTableConstIterator< Key, Val > &  from )

explicit

Copy constructor.

Parameters

from	The gum::HashTableConstIterator to copy.

Definition at line 1435 of file hashTable_tpl.h.

                                                     :
      table__{from.table__},
      index__{from.index__}, bucket__{from.bucket__} {
    // make the hashtable keep track of this iterator
    if (table__ != nullptr) { insertIntoSafeList__(); }

    // for debugging purposes
    GUM_CONS_CPY(HashTableConstIteratorSafe);
  }

HashTableConstIteratorSafe() [6/7]

template<typename Key, typename Val>

INLINE gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe

(

HashTableConstIteratorSafe< Key, Val > &&

from

)

Move constructor.

Parameters

from	The gum::HashTableConstIteratorSafe to move.

Definition at line 1447 of file hashTable_tpl.h.

                                                    :
      table__{from.table__},
      index__{from.index__}, bucket__{from.bucket__}, next_bucket__{
                                                         from.next_bucket__} {
    GUM_CONS_MOV(HashTableConstIteratorSafe);

    // find "from" in the hashtable's list of safe iterators and substitute
    // it by this
    if (table__ != nullptr) {
      std::vector< HashTableConstIteratorSafe< Key, Val >* >& vect
         = table__->safe_iterators__;

      for (auto ptr = vect.rbegin(); ptr != vect.rend(); ++ptr) {
        if (*ptr == &from) {
          *ptr         = this;
          from.table__ = nullptr;
          break;
        }
      }
    }
  }

~HashTableConstIteratorSafe()

template<typename Key , typename Val >

INLINE gum::HashTableConstIteratorSafe< Key, Val >::~HashTableConstIteratorSafe ( )

noexcept

Destructor.

Definition at line 1473 of file hashTable_tpl.h.

                                                                             {
    // for debugging purposes
    GUM_DESTRUCTOR(HashTableConstIteratorSafe);

    // remove the iterator from the table's iterator list
    removeFromSafeList__();
  }

HashTableConstIteratorSafe() [7/7]

template<typename Key, typename Val>

template<typename Alloc >

INLINE gum::HashTableConstIteratorSafe< Key, Val >::HashTableConstIteratorSafe

(

const HashTable< Key, Val, Alloc > &

tab

)

Definition at line 1329 of file hashTable_tpl.h.

                                              :
      table__{reinterpret_cast< const HashTable< Key, Val >* >(&tab)} {
    // for debugging purposes
    GUM_CONSTRUCTOR(HashTableConstIteratorSafe);

    // make the hashtable keep track of this iterator
    insertIntoSafeList__();

    if (table__->nb_elements__) {
      if (table__->begin_index__ != std::numeric_limits< Size >::max()) {
        index__  = table__->begin_index__;
        bucket__ = table__->nodes__[index__].end_list__;
      } else {
        // find the element we shall point to from the start of the hashtable
        for (Size i = table__->size__ - Size(1);; --i) {   // no test on i since
                                                           // nb_elements__ != 0
          if (table__->nodes__[i].nb_elements__) {
            index__                = i;
            bucket__               = table__->nodes__[index__].end_list__;
            table__->begin_index__ = index__;
            break;
          }
        }
      }
    }
  }

Member Function Documentation

clear()

template<typename Key , typename Val >

INLINE void gum::HashTableConstIteratorSafe< Key, Val >::clear ( )

noexcept

Makes the iterator point toward nothing (in particular, it is not related anymore to its current hash table).

It is mainly used by the hashtable when the latter is deleted while the iterator is still alive.

Definition at line 1597 of file hashTable_tpl.h.

                                                                     {
    // remove the iterator from the table's iterator list
    removeFromSafeList__();

    // set its table as well as the element it points to to 0
    table__       = nullptr;
    bucket__      = nullptr;
    next_bucket__ = nullptr;
    index__       = Size(0);
  }

getBucket__()

template<typename Key , typename Val >

INLINE HashTableBucket< Key, Val > * gum::HashTableConstIteratorSafe< Key, Val >::getBucket__ ( ) const

protectednoexcept

Returns the current iterator's bucket.

Definition at line 1747 of file hashTable_tpl.h.

                                                                            {
    return bucket__;
  }

getIndex__()

template<typename Key , typename Val >

INLINE Size gum::HashTableConstIteratorSafe< Key, Val >::getIndex__ ( ) const

protectednoexcept

Returns the index in the hashtable's node vector pointed to by the iterator.

Returns

Returns the index in the hashtable's node vector pointed to by the iterator.

Definition at line 1752 of file hashTable_tpl.h.

                                                                                {
    return index__;
  }

insertIntoSafeList__()

template<typename Key , typename Val >

INLINE void gum::HashTableConstIteratorSafe< Key, Val >::insertIntoSafeList__ ( ) const

protected

Insert the iterator into the hashtable's list of safe iterators.

Definition at line 1298 of file hashTable_tpl.h.

                                                                        {
    table__->safe_iterators__.push_back(
       const_cast< HashTableConstIteratorSafe< Key, Val >* >(this));
  }

key()

template<typename Key , typename Val >

INLINE const HashTableConstIteratorSafe< Key, Val >::key_type & gum::HashTableConstIteratorSafe< Key, Val >::key

(

)

const

Returns the key pointed to by the iterator.

Returns

Returns the key pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised when the iterator does not point to a valid hash table element

Definition at line 1578 of file hashTable_tpl.h.

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

operator!=()

template<typename Key, typename Val>

INLINE bool gum::HashTableConstIteratorSafe< Key, Val >::operator!= ( const HashTableConstIteratorSafe< Key, Val > &  from ) const

noexcept

Checks whether two iterators are not equal.

Parameters

from	from The iterator to test for inequality.

Returns

Returns true if from and this iterator are inequal.

Definition at line 1724 of file hashTable_tpl.h.

                                                                        {
    return ((bucket__ != from.bucket__) || (index__ != from.index__));
  }

operator*()

template<typename Key , typename Val >

INLINE const HashTableConstIteratorSafe< Key, Val >::value_type & gum::HashTableConstIteratorSafe< Key, Val >::operator*

(

)

const

Returns the element pointed to by the iterator.

Returns

Returns the element pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised when the iterator does not point to a valid hash table element.

Definition at line 1737 of file hashTable_tpl.h.

                                                             {
    if (bucket__)
      return bucket__->elt();
    else {
      GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object");
    }
  }

operator+()

template<typename Key , typename Val >

INLINE HashTableConstIteratorSafe< Key, Val > gum::HashTableConstIteratorSafe< Key, Val >::operator+

(

Size

i

)

const

Returns a new iterator poiting to i elements further in the hashtable.

Parameters

i	The number of steps to increment the gum::HashTableConstIteratorSafe.

Returns

Returns a new gum::HashTableConstIteratorSafe.

Definition at line 1719 of file hashTable_tpl.h.

                                                                    {
    return HashTableConstIteratorSafe< Key, Val >{*this} += nb;
  }

operator++()

template<typename Key , typename Val >

HashTableConstIteratorSafe< Key, Val > & gum::HashTableConstIteratorSafe< Key, Val >::operator++ ( )

noexcept

Makes the iterator point to the next element in the hash table.

for (iter = hash.beginSafe(); iter != hash.endSafe (); ++iter) { }

The above loop is guaranteed to parse the whole hash table as long as no element is added to or deleted from the hash table while being in the loop. Deleting elements during the loop is guaranteed to never produce a segmentation fault.

Returns

Returns this gum::HashTableConstIteratorSafe pointing to the next element in the gum::HashTable it's iterating over.

Definition at line 1612 of file hashTable_tpl.h.

                                                                 {
    // if bucket__ != nullptr then use it, else use next_bucket
    if (bucket__ == nullptr) {
      // note that this case only happens when the iterator pointed to an
      // element
      // that has just been erased. Fortunately, in this case, the Hashtable's
      // erase functions update appropriately the next_bucket__ and index__
      // fields.
      bucket__      = next_bucket__;
      next_bucket__ = nullptr;
    } else {
      // ok, here we can use bucket__ as a starting point

      // if we are not pointing on the first element of the chained list, just
      // point to the preceding bucket in this list
      if (bucket__->prev) {
        bucket__ = bucket__->prev;
        // here, no need to update next_bucket__, which is compulsorily
        // equal to nullptr, nor index__ which has not changed.
      } else {
        // ok, here we are on the beginning of a chained list,
        // so 2 cases can obtain:
        // 1/ index = 0 : then we have reached the end of the hashtable
        // 2/ index != 0 => we must search for a new slot containing elements

        // case 1:
        if (index__ == Size(0)) {
          bucket__ = nullptr;
          // we are thus at the end() of the hashTable
        }
        // case 2:
        else {
          // arrived here, we need to parse the hash table until we find a new
          // bucket because we are pointing on a chained list with no more
          // element
          // to the left of the current element
          if (index__ > Size(0)) {
            for (Size i = index__ - Size(1); i > Size(0); --i) {
              if (table__->nodes__[i].nb_elements__) {
                index__  = i;
                bucket__ = table__->nodes__[i].end_list__;
                return *this;
              }
            }
          }

          if (table__->nodes__[0].nb_elements__)
            bucket__ = table__->nodes__[0].end_list__;
          else
            bucket__ = nullptr;

          index__ = 0;
        }
      }
    }

    return *this;
  }

operator+=()

template<typename Key , typename Val >

HashTableConstIteratorSafe< Key, Val > & gum::HashTableConstIteratorSafe< Key, Val >::operator+= ( Size  i )

noexcept

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

Parameters

i	The number of steps to increment the gum::HashTableConstIteratorSafe.

Returns

Returns this gum::HashTableConstIteratorSafe.

Definition at line 1673 of file hashTable_tpl.h.

                                                                        {
    if ((nb == Size(0)) || (table__ == nullptr)) return *this;

    // if bucket__ != nullptr then use it, else use next_bucket
    if (bucket__ == nullptr) {
      // note that this case only happens when the iterator pointed to an
      // element
      // that has just been erased. Fortunately, in this case, the Hashtable's
      // erase functions update appropriately the next_bucket__ and index__
      // fields.
      bucket__      = next_bucket__;
      next_bucket__ = nullptr;
      --nb;
    }

    // ok, here we can use bucket__ as a starting point: parse all the elements
    // of the current chained list
    for (; nb && bucket__ != nullptr; --nb, bucket__ = bucket__->prev) {}

    if (bucket__ != nullptr) return *this;

    // here, we shall skip all the chained list that have not sufficiently
    // many elements
    --index__;

    for (; index__ < table__->size__
           && nb >= table__->nodes__[index__].nb_elements__;
         nb -= table__->nodes__[index__].nb_elements__, --index__) {}

    // here: either index__ >= table__->size__, which means that we did not find
    // the element we looked for, i.e., we are at the end of the hashtable, or
    // nb < table__->nodes__[index__].nb_elements__, and we should parse the
    // chained list to get the element (which, we know for sure, exists)
    if (index__ >= table__->size__) {
      index__ = Size(0);
      return *this;
    }

    for (bucket__ = table__->nodes__[index__].end_list__; nb;
         --nb, bucket__ = bucket__->prev) {}

    return *this;
  }

operator=() [1/3]

template<typename Key, typename Val>

HashTableConstIteratorSafe< Key, Val > & gum::HashTableConstIteratorSafe< Key, Val >::operator=

(

const HashTableConstIteratorSafe< Key, Val > &

from

)

Copy operator.

Parameters

from	The gum::HashTableConstIteratorSafe to copy.

Returns

Returns this gum::HashTableConstIteratorSafe.

Definition at line 1483 of file hashTable_tpl.h.

                                                            {
    // here, no need to avoid self assignment: this would slow down normal
    // assignments and, in any case, this would not result in an iterator in
    // an incoherent state
    // check if the current hashtable is different from that of "from". In such
    // a case, we shall remove the iterator from its current hashtable
    // iterator's
    // list and add it to the new hashtable iterator's list
    if (table__ != from.table__) {
      // remove the iterator from its hashtable iterator's list'
      removeFromSafeList__();

      table__ = from.table__;

      // add to the new table
      if (table__) { insertIntoSafeList__(); }
    }

    index__       = from.index__;
    bucket__      = from.bucket__;
    next_bucket__ = from.next_bucket__;

    return *this;
  }

operator=() [2/3]

template<typename Key, typename Val>

HashTableConstIteratorSafe< Key, Val > & gum::HashTableConstIteratorSafe< Key, Val >::operator=

(

const HashTableConstIterator< Key, Val > &

from

)

Copy operator.

Parameters

from	The gum::HashTableConstIterator to copy.

Returns

Returns this gum::HashTableConstIteratorSafe.

Definition at line 1511 of file hashTable_tpl.h.

                                                        {
    // here, no need to avoid self assignment: this would slow down normal
    // assignments and, in any case, this would not result in an iterator in
    // an incoherent state
    // check if the current hashtable is different from that of "from". In such
    // a case, we shall remove the iterator from its current hashtable
    // iterator's
    // list and add it to the new hashtable iterator's list
    if (table__ != from.table__) {
      // remove the iterator from its hashtable iterator's list'
      removeFromSafeList__();

      table__ = from.table__;

      // add to the new table
      if (table__) { insertIntoSafeList__(); }
    }

    index__       = from.index__;
    bucket__      = from.bucket__;
    next_bucket__ = nullptr;

    return *this;
  }

operator=() [3/3]

template<typename Key, typename Val>

INLINE HashTableConstIteratorSafe< Key, Val > & gum::HashTableConstIteratorSafe< Key, Val >::operator= ( HashTableConstIteratorSafe< Key, Val > &&  from )

noexcept

Move operator.

Parameters

from	The gum::HashTableConstIteratorSafe to move.

Returns

Returns this gum::HashTableConstIteratorSafe.

Definition at line 1539 of file hashTable_tpl.h.

                                                                {
    // here, no need to avoid self assignment: this would slow down normal
    // assignments and, in any case, this would not result in an iterator in
    // an incoherent state
    // check if the current hashtable is different from that of "from". In such
    // a case, we shall remove the iterator from its current hashtable
    // iterator's
    // list and add it to the new hashtable iterator's list
    if (table__ != from.table__) {
      // remove the iterator from its hashtable iterator's list'
      removeFromSafeList__();

      if (from.table__ != nullptr) {
        // substitute from by this in the list of safe iterators
        std::vector< HashTableConstIteratorSafe< Key, Val >* >& vect
           = from.table__->safe_iterators__;

        for (auto ptr = vect.rbegin(); ptr != vect.rend(); ++ptr) {
          if (*ptr == &from) {
            *ptr = this;
            break;
          }
        }
      }

      table__      = from.table__;
      from.table__ = nullptr;
    }

    index__       = from.index__;
    bucket__      = from.bucket__;
    next_bucket__ = from.next_bucket__;

    return *this;
  }

operator==()

template<typename Key, typename Val>

INLINE bool gum::HashTableConstIteratorSafe< Key, Val >::operator== ( const HashTableConstIteratorSafe< Key, Val > &  from ) const

noexcept

Checks whether two iterators are equal.

Parameters

from	from The iterator to test for equality.

Returns

Returns true if from and this iterator are equal.

Definition at line 1730 of file hashTable_tpl.h.

                                                                        {
    return ((bucket__ == from.bucket__) && (index__ == from.index__));
  }

removeFromSafeList__()

template<typename Key , typename Val >

INLINE void gum::HashTableConstIteratorSafe< Key, Val >::removeFromSafeList__ ( ) const

protected

Removes the iterator from its hashtable' safe iterators list.

Definition at line 1305 of file hashTable_tpl.h.

                                                                        {
    if (table__ == nullptr) return;

    // find where the iterator is
    std::vector< HashTableConstIteratorSafe< Key, Val >* >& iter_vect
       = table__->safe_iterators__;

    auto len = iter_vect.size();
    for (Size i = Size(0); i < len; ++i) {
      if (iter_vect[i] == this) {
        iter_vect.erase(iter_vect.begin() + i);
        break;
      }
    }
  }

val()

template<typename Key , typename Val >

INLINE const HashTableConstIteratorSafe< Key, Val >::mapped_type & gum::HashTableConstIteratorSafe< Key, Val >::val

(

)

const

Returns the mapped value pointed to by the iterator.

Returns

Returns the mapped value pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised when the iterator does not point to a valid hash table element.

Definition at line 1588 of file hashTable_tpl.h.

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

Friends And Related Function Documentation

HashTable

template<typename Key, typename Val>

template<typename K , typename V , typename A >

friend class HashTable

friend

Class HashTable must be a friend because it stores iterator end and this can be properly initialized only when the hashtable has been fully allocated.

Thus, proper initialization can only take place within the constructor's code of the hashtable.

Definition at line 2127 of file hashTable.h.

Member Data Documentation

bucket__

template<typename Key, typename Val>

HashTableBucket< Key, Val >* gum::HashTableConstIteratorSafe< Key, Val >::bucket__ {nullptr}

protected

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

Definition at line 2139 of file hashTable.h.

index__

template<typename Key, typename Val>

Size gum::HashTableConstIteratorSafe< Key, Val >::index__ {Size(0)}

protected

the index of the chained list pointed to by the iterator in the array nodes__ of the hash table.

Definition at line 2136 of file hashTable.h.

next_bucket__

template<typename Key, typename Val>

HashTableBucket< Key, Val >* gum::HashTableConstIteratorSafe< Key, Val >::next_bucket__ {nullptr}

protected

the bucket we should start from when we decide to do a ++.

Usually it should be equal to nullptr. However, if the user has deleted the object pointed to by bucket, this will point to another bucket. When it is equal to nullptr, it means that the bucket reached after a ++ belongs to another slot of the hash table's '__node' vector.

Definition at line 2149 of file hashTable.h.

table__

template<typename Key, typename Val>

const HashTable< Key, Val >* gum::HashTableConstIteratorSafe< Key, Val >::table__ {nullptr}

protected

The hash table the iterator is pointing to.

Definition at line 2130 of file hashTable.h.

---

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

• agrum/tools/core/hashTable.h
• agrum/tools/core/hashTable_tpl.h