aGrUM  0.20.2
a C++ library for (probabilistic) graphical models
gum::HashTableIteratorSafe< Key, Val > Class Template Reference

Safe Iterators for hashtables. More...

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

+ Inheritance diagram for gum::HashTableIteratorSafe< Key, Val >:
+ Collaboration diagram for gum::HashTableIteratorSafe< Key, Val >:

Public Member Functions

mapped_typeval ()
 Returns the mapped value pointed to by the iterator. More...
 
template<typename Alloc >
INLINE HashTableIteratorSafe (const HashTable< Key, Val, Alloc > &tab)
 
template<typename Alloc >
INLINE HashTableIteratorSafe (const HashTable< Key, Val, Alloc > &tab, Size ind_elt)
 
Constructors / Destructors
 HashTableIteratorSafe ()
 Basic constructor: creates an iterator pointing to nothing. More...
 
template<typename Alloc >
 HashTableIteratorSafe (const HashTable< Key, Val, Alloc > &tab)
 Constructor for an iterator pointing to the first element of a hashtable. More...
 
template<typename Alloc >
 HashTableIteratorSafe (const HashTable< Key, Val, Alloc > &tab, Size ind_elt)
 Constructor for an iterator pointing to the nth element of a hashtable. More...
 
 HashTableIteratorSafe (const HashTableIteratorSafe< Key, Val > &from)
 Copy constructor. More...
 
 HashTableIteratorSafe (const HashTableIterator< Key, Val > &from)
 Copy constructor. More...
 
 HashTableIteratorSafe (HashTableIteratorSafe< Key, Val > &&from) noexcept
 Move constructor. More...
 
 ~HashTableIteratorSafe () noexcept
 Class destructor. More...
 
Operators
HashTableIteratorSafe< Key, Val > & operator= (const HashTableIteratorSafe< Key, Val > &from)
 Copy operator. More...
 
HashTableIteratorSafe< Key, Val > & operator= (const HashTableIterator< Key, Val > &from)
 Copy operator. More...
 
HashTableIteratorSafe< Key, Val > & operator= (HashTableIteratorSafe< Key, Val > &&from) noexcept
 Move operator. More...
 
HashTableIteratorSafe< Key, Val > & operator++ () noexcept
 Makes the iterator point to the next element in the hash table. More...
 
HashTableIteratorSafe< Key, Val > & operator+= (Size i) noexcept
 Makes the iterator point to i elements further in the hashtable. More...
 
HashTableIteratorSafe< Key, Val > operator+ (Size i) const
 Returns a new iterator pointing to i elements further in the hashtable. More...
 
bool operator!= (const HashTableIteratorSafe< Key, Val > &from) const noexcept
 Checks whether two iterators are pointing toward different elements. More...
 
bool operator== (const HashTableIteratorSafe< Key, Val > &from) const noexcept
 Checks whether two iterators are pointing toward equal elements. More...
 
value_typeoperator* ()
 Returns the value pointed to by the iterator. More...
 
const value_typeoperator* () const
 Returns the value pointed to by the iterator. More...
 
Accessors / Modifiers
const key_typekey () const
 Returns the key pointed to by the iterator. More...
 
const mapped_typeval () 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
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...
 

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...
 

Detailed Description

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

Safe Iterators for hashtables.

HashTableIteratorSafe 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 HashTableIteratorSafe, using the latter to access this element will never crash the application. Instead it will properly throw an UndefinedIteratorValue exception.

Developers may consider using HashTable<x,y>::iterator_safe instead of HashTableIteratorSafe<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>::iterator_safe iter = table.beginSafe ();
iter != table.endSafe (); ++iter) {
// display the values
cerr << "at " << iter.key() << " value = " << iter.val () << endl;
std::pair<const int, string>& xelt = *iter;
}
// check whether two iterators point toward the same element
HashTable<int,string>::iterator_safe iter1 = table1.beginSafe ();
HashTable<int,string>::iterator_safe iter2 = table1.endSafe ();
if (iter1 != iter) {
cerr << "iter1 and iter2 point toward different elements";
}
// make iter1 point toward nothing
iter1.clear ();
Template Parameters
KeyThe gum::HashTable key.
ValThe gum::HashTable Value.

Definition at line 2224 of file hashTable.h.

Member Typedef Documentation

◆ const_pointer

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::const_pointer = const value_type*

Types for STL compliance.

Definition at line 2235 of file hashTable.h.

◆ const_reference

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::const_reference = const value_type&

Types for STL compliance.

Definition at line 2233 of file hashTable.h.

◆ difference_type

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 2236 of file hashTable.h.

◆ iterator_category

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::iterator_category = std::forward_iterator_tag

Types for STL compliance.

Definition at line 2228 of file hashTable.h.

◆ key_type

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::key_type = Key

Types for STL compliance.

Definition at line 2229 of file hashTable.h.

◆ mapped_type

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::mapped_type = Val

Types for STL compliance.

Definition at line 2230 of file hashTable.h.

◆ pointer

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::pointer = value_type*

Types for STL compliance.

Definition at line 2234 of file hashTable.h.

◆ reference

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::reference = value_type&

Types for STL compliance.

Definition at line 2232 of file hashTable.h.

◆ value_type

template<typename Key, typename Val>
using gum::HashTableIteratorSafe< Key, Val >::value_type = std::pair< const Key, Val >

Types for STL compliance.

Definition at line 2231 of file hashTable.h.

Constructor & Destructor Documentation

◆ HashTableIteratorSafe() [1/8]

template<typename Key , typename Val >
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( )

Basic constructor: creates an iterator pointing to nothing.

Definition at line 1761 of file hashTable_tpl.h.

1761  :
1762  HashTableConstIteratorSafe< Key, Val >() {
1763  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1764  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ HashTableIteratorSafe() [2/8]

template<typename Key, typename Val>
template<typename Alloc >
gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( const HashTable< Key, Val, Alloc > &  tab)

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

Template Parameters
AllocThe gum::HashTable allocator.

◆ HashTableIteratorSafe() [3/8]

template<typename Key, typename Val>
template<typename Alloc >
gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( 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.

Parameters
tabthe hash table to which the so-called element belongs
ind_eltthe position of the element in the hash table (0 means the first element).
Template Parameters
AllocThe gum::HashTable allocator.
Exceptions
UndefinedIteratorValueRaised if the element cannot be found

◆ HashTableIteratorSafe() [4/8]

template<typename Key, typename Val>
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( const HashTableIteratorSafe< Key, Val > &  from)

Copy constructor.

Parameters
fromthe gum::HashTableIteratorSafe to copy.
Returns
This gum::HashTableIteratorSafe.

Definition at line 1784 of file hashTable_tpl.h.

1785  :
1786  HashTableConstIteratorSafe< Key, Val >(from) {
1787  GUM_CONS_CPY(HashTableIteratorSafe);
1788  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ HashTableIteratorSafe() [5/8]

template<typename Key, typename Val>
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( const HashTableIterator< Key, Val > &  from)
explicit

Copy constructor.

Parameters
fromthe gum::HashTableIterator to copy.
Returns
This gum::HashTableIteratorSafe.

Definition at line 1791 of file hashTable_tpl.h.

1792  :
1793  HashTableConstIteratorSafe< Key, Val >(from) {
1794  GUM_CONS_CPY(HashTableIteratorSafe);
1795  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ HashTableIteratorSafe() [6/8]

template<typename Key, typename Val>
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( HashTableIteratorSafe< Key, Val > &&  from)
noexcept

Move constructor.

Parameters
fromThe gum::HashTableIteratorSafe to move.
Returns
Returns this gum::HashTableIteratorSafe.

Definition at line 1798 of file hashTable_tpl.h.

1799  :
1800  HashTableConstIteratorSafe< Key, Val >(std::move(from)) {
1801  GUM_CONS_MOV(HashTableIteratorSafe);
1802  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ ~HashTableIteratorSafe()

template<typename Key , typename Val >
INLINE gum::HashTableIteratorSafe< Key, Val >::~HashTableIteratorSafe ( )
noexcept

Class destructor.

Definition at line 1805 of file hashTable_tpl.h.

1805  {
1806  GUM_DESTRUCTOR(HashTableIteratorSafe);
1807  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ HashTableIteratorSafe() [7/8]

template<typename Key, typename Val>
template<typename Alloc >
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( const HashTable< Key, Val, Alloc > &  tab)

Definition at line 1768 of file hashTable_tpl.h.

1769  :
1770  HashTableConstIteratorSafe< Key, Val >(tab) {
1771  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1772  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ HashTableIteratorSafe() [8/8]

template<typename Key, typename Val>
template<typename Alloc >
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe ( const HashTable< Key, Val, Alloc > &  tab,
Size  ind_elt 
)

Definition at line 1776 of file hashTable_tpl.h.

1778  :
1779  HashTableConstIteratorSafe< Key, Val >(tab, ind_elt) {
1780  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1781  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

Member Function Documentation

◆ clear()

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

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.

1597  {
1598  // remove the iterator from the table's iterator list
1600 
1601  // set its table as well as the element it points to to 0
1602  table__ = nullptr;
1603  bucket__ = nullptr;
1604  next_bucket__ = nullptr;
1605  index__ = Size(0);
1606  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139
HashTableBucket< Key, Val > * next_bucket__
the bucket we should start from when we decide to do a ++.
Definition: hashTable.h:2149
Size index__
the index of the chained list pointed to by the iterator in the array nodes__ of the hash table...
Definition: hashTable.h:2136
void removeFromSafeList__() const
Removes the iterator from its hashtable&#39; safe iterators list.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
const HashTable< Key, Val > * table__
The hash table the iterator is pointing to.
Definition: hashTable.h:2130

◆ getBucket__()

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

Returns the current iterator's bucket.

Definition at line 1747 of file hashTable_tpl.h.

1747  {
1748  return bucket__;
1749  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139

◆ getIndex__()

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

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.

1752  {
1753  return index__;
1754  }
Size index__
the index of the chained list pointed to by the iterator in the array nodes__ of the hash table...
Definition: hashTable.h:2136

◆ insertIntoSafeList__()

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

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

Definition at line 1298 of file hashTable_tpl.h.

1298  {
1299  table__->safe_iterators__.push_back(
1300  const_cast< HashTableConstIteratorSafe< Key, Val >* >(this));
1301  }
std::vector< HashTableConstIteratorSafe< Key, Val > *> safe_iterators__
The list of safe iterators pointing to the hash table.
Definition: hashTable.h:1757
const HashTable< Key, Val > * table__
The hash table the iterator is pointing to.
Definition: hashTable.h:2130

◆ key()

template<typename Key , typename Val >
INLINE const HashTableConstIteratorSafe< Key, Val >::key_type & gum::HashTableConstIteratorSafe< Key, Val >::key ( ) const
inherited

Returns the key pointed to by the iterator.

Returns
Returns the key pointed to by the iterator.
Exceptions
UndefinedIteratorValueRaised when the iterator does not point to a valid hash table element

Definition at line 1578 of file hashTable_tpl.h.

1578  {
1579  if (bucket__ != nullptr)
1580  return bucket__->key();
1581  else {
1582  GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object");
1583  }
1584  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139
#define GUM_ERROR(type, msg)
Definition: exceptions.h:54

◆ operator!=() [1/2]

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

Checks whether two iterators are not equal.

Parameters
fromfrom 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.

1725  {
1726  return ((bucket__ != from.bucket__) || (index__ != from.index__));
1727  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139
Size index__
the index of the chained list pointed to by the iterator in the array nodes__ of the hash table...
Definition: hashTable.h:2136

◆ operator!=() [2/2]

template<typename Key, typename Val>
INLINE bool gum::HashTableIteratorSafe< Key, Val >::operator!= ( const HashTableIteratorSafe< Key, Val > &  from) const
noexcept

Checks whether two iterators are pointing toward different elements.

Parameters
fromThe gum::HashTableIteratorSafe to test for inequality.
Returns
Returns true if this and from are not equal.

Definition at line 1864 of file hashTable_tpl.h.

1865  {
1867  }
bool operator!=(const HashTableConstIteratorSafe< Key, Val > &from) const noexcept
Checks whether two iterators are not equal.

◆ operator*() [1/2]

template<typename Key , typename Val >
INLINE HashTableIteratorSafe< Key, Val >::value_type & gum::HashTableIteratorSafe< Key, Val >::operator* ( )

Returns the value pointed to by the iterator.

Returns
Returns the value pointed to by the iterator.
Exceptions
UndefinedIteratorValueRaised when the iterator does not point to a valid hash table element

Definition at line 1877 of file hashTable_tpl.h.

1877  {
1878  return const_cast< Val& >(HashTableConstIteratorSafe< Key, Val >::operator*());
1879  }
const value_type & operator*() const
Returns the element pointed to by the iterator.

◆ operator*() [2/2]

template<typename Key , typename Val >
INLINE const HashTableIteratorSafe< Key, Val >::value_type & gum::HashTableIteratorSafe< Key, Val >::operator* ( ) const

Returns the value pointed to by the iterator.

Returns
Returns the value pointed to by the iterator.
Exceptions
UndefinedIteratorValueRaised when the iterator does not point to a valid hash table element.

Definition at line 1883 of file hashTable_tpl.h.

1883  {
1885  }
const value_type & operator*() const
Returns the element pointed to by the iterator.

◆ operator+()

template<typename Key , typename Val >
INLINE HashTableIteratorSafe< Key, Val > gum::HashTableIteratorSafe< Key, Val >::operator+ ( Size  i) const

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

Parameters
iThe number of increments.
Returns
Returns this gum::HashTableIteratorSafe.

Definition at line 1857 of file hashTable_tpl.h.

1857  {
1858  HashTableIteratorSafe< Key, Val > iter{*this};
1859  iter += nb;
1860  return iter;
1861  }

◆ operator++()

template<typename Key , typename Val >
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< 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
This gum::HashTableIteratorSafe.

Definition at line 1843 of file hashTable_tpl.h.

1843  {
1845  return *this;
1846  }
HashTableConstIteratorSafe< Key, Val > & operator++() noexcept
Makes the iterator point to the next element in the hash table.

◆ operator+=()

template<typename Key , typename Val >
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator+= ( Size  i)
noexcept

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

Parameters
iThe number of increments.
Returns
Return this gum::HashTableIteratorSafe.

Definition at line 1850 of file hashTable_tpl.h.

1850  {
1852  return *this;
1853  }
HashTableConstIteratorSafe< Key, Val > & operator+=(Size i) noexcept
Makes the iterator point to i elements further in the hashtable.

◆ operator=() [1/3]

template<typename Key, typename Val>
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator= ( const HashTableIteratorSafe< Key, Val > &  from)

Copy operator.

Parameters
fromThe gum::HashTableIteratorSafe to copy.
Returns
Returns this gum::HashTableIterator.

Definition at line 1817 of file hashTable_tpl.h.

1818  {
1819  GUM_OP_CPY(HashTableIteratorSafe);
1821  return *this;
1822  }
HashTableConstIteratorSafe< Key, Val > & operator=(const HashTableConstIteratorSafe< Key, Val > &from)
Copy operator.
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ operator=() [2/3]

template<typename Key, typename Val>
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator= ( const HashTableIterator< Key, Val > &  from)

Copy operator.

Parameters
fromThe gum::HashTableIterator to copy.
Returns
Returns this gum::HashTableIterator.

Definition at line 1826 of file hashTable_tpl.h.

1827  {
1828  GUM_OP_CPY(HashTableIteratorSafe);
1830  return *this;
1831  }
HashTableConstIteratorSafe< Key, Val > & operator=(const HashTableConstIteratorSafe< Key, Val > &from)
Copy operator.
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

◆ operator=() [3/3]

template<typename Key, typename Val>
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator= ( HashTableIteratorSafe< Key, Val > &&  from)
noexcept

Move operator.

Parameters
fromThe gum::HashTableIteratorSafe to move.
Returns
Returns this gum::HashTableIterator.

Definition at line 1835 of file hashTable_tpl.h.

1836  {
1838  return *this;
1839  }
HashTableConstIteratorSafe< Key, Val > & operator=(const HashTableConstIteratorSafe< Key, Val > &from)
Copy operator.

◆ operator==() [1/2]

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

Checks whether two iterators are equal.

Parameters
fromfrom 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.

1731  {
1732  return ((bucket__ == from.bucket__) && (index__ == from.index__));
1733  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139
Size index__
the index of the chained list pointed to by the iterator in the array nodes__ of the hash table...
Definition: hashTable.h:2136

◆ operator==() [2/2]

template<typename Key, typename Val>
INLINE bool gum::HashTableIteratorSafe< Key, Val >::operator== ( const HashTableIteratorSafe< Key, Val > &  from) const
noexcept

Checks whether two iterators are pointing toward equal elements.

Parameters
fromThe gum::HashTableIteratorSafe to test for equality.
Returns
Returns true if this and from are equal.

Definition at line 1870 of file hashTable_tpl.h.

1871  {
1873  }
bool operator==(const HashTableConstIteratorSafe< Key, Val > &from) const noexcept
Checks whether two iterators are equal.

◆ removeFromSafeList__()

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

Removes the iterator from its hashtable' safe iterators list.

Definition at line 1305 of file hashTable_tpl.h.

1305  {
1306  if (table__ == nullptr) return;
1307 
1308  // find where the iterator is
1309  std::vector< HashTableConstIteratorSafe< Key, Val >* >& iter_vect
1311 
1312  auto len = iter_vect.size();
1313  for (Size i = Size(0); i < len; ++i) {
1314  if (iter_vect[i] == this) {
1315  iter_vect.erase(iter_vect.begin() + i);
1316  break;
1317  }
1318  }
1319  }
std::vector< HashTableConstIteratorSafe< Key, Val > *> safe_iterators__
The list of safe iterators pointing to the hash table.
Definition: hashTable.h:1757
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
const HashTable< Key, Val > * table__
The hash table the iterator is pointing to.
Definition: hashTable.h:2130

◆ val() [1/2]

template<typename Key , typename Val >
INLINE const HashTableConstIteratorSafe< Key, Val >::mapped_type & gum::HashTableConstIteratorSafe< Key, Val >::val ( ) const
inherited

Returns the mapped value pointed to by the iterator.

Returns
Returns the mapped value pointed to by the iterator.
Exceptions
UndefinedIteratorValueRaised when the iterator does not point to a valid hash table element.

Definition at line 1588 of file hashTable_tpl.h.

1588  {
1589  if (bucket__ != nullptr)
1590  return bucket__->val();
1591  else {
1592  GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object");
1593  }
1594  }
HashTableBucket< Key, Val > * bucket__
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2139
#define GUM_ERROR(type, msg)
Definition: exceptions.h:54

◆ val() [2/2]

template<typename Key , typename Val >
INLINE HashTableIteratorSafe< Key, Val >::mapped_type & gum::HashTableIteratorSafe< Key, Val >::val ( )

Returns the mapped value pointed to by the iterator.

Returns
Returns the mapped value pointed to by the iterator.
Exceptions
UndefinedIteratorValueRaised when the iterator does not point to a valid hash table element.

Definition at line 1811 of file hashTable_tpl.h.

1811  {
1812  return const_cast< Val& >(HashTableConstIteratorSafe< Key, Val >::val());
1813  }
const mapped_type & val() const
Returns the mapped value pointed to by the iterator.

Member Data Documentation

◆ bucket__

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

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)}
protectedinherited

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}
protectedinherited

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}
protectedinherited

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: