aGrUM  0.20.3
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 2197 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 2208 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 2206 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 2209 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 2201 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 2202 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 2203 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 2207 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 2205 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 2204 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 1692 of file hashTable_tpl.h.

1692  :
1693  HashTableConstIteratorSafe< Key, Val >() {
1694  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1695  }
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 1715 of file hashTable_tpl.h.

1716  :
1717  HashTableConstIteratorSafe< Key, Val >(from) {
1718  GUM_CONS_CPY(HashTableIteratorSafe);
1719  }
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 1722 of file hashTable_tpl.h.

1723  :
1724  HashTableConstIteratorSafe< Key, Val >(from) {
1725  GUM_CONS_CPY(HashTableIteratorSafe);
1726  }
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 1729 of file hashTable_tpl.h.

1730  :
1731  HashTableConstIteratorSafe< Key, Val >(std::move(from)) {
1732  GUM_CONS_MOV(HashTableIteratorSafe);
1733  }
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 1736 of file hashTable_tpl.h.

1736  {
1737  GUM_DESTRUCTOR(HashTableIteratorSafe);
1738  }
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 1699 of file hashTable_tpl.h.

1700  :
1701  HashTableConstIteratorSafe< Key, Val >(tab) {
1702  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1703  }
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 1707 of file hashTable_tpl.h.

1709  :
1710  HashTableConstIteratorSafe< Key, Val >(tab, ind_elt) {
1711  GUM_CONSTRUCTOR(HashTableIteratorSafe);
1712  }
HashTableIteratorSafe()
Basic constructor: creates an iterator pointing to nothing.

Member Function Documentation

◆ _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 1678 of file hashTable_tpl.h.

1678  {
1679  return _bucket_;
1680  }
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112

◆ _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 1683 of file hashTable_tpl.h.

1683  {
1684  return _index_;
1685  }
Size _index_
the index of the chained list pointed to by the iterator in the array nodes of the hash table...
Definition: hashTable.h:2109

◆ _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 1243 of file hashTable_tpl.h.

1243  {
1244  _table_->_safe_iterators_.push_back(
1245  const_cast< HashTableConstIteratorSafe< Key, Val >* >(this));
1246  }
std::vector< HashTableConstIteratorSafe< Key, Val > *> _safe_iterators_
The list of safe iterators pointing to the hash table.
Definition: hashTable.h:1734
const HashTable< Key, Val > * _table_
The hash table the iterator is pointing to.
Definition: hashTable.h:2103

◆ _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 1249 of file hashTable_tpl.h.

1249  {
1250  if (_table_ == nullptr) return;
1251 
1252  // find where the iterator is
1253  std::vector< HashTableConstIteratorSafe< Key, Val >* >& iter_vect = _table_->_safe_iterators_;
1254 
1255  auto len = iter_vect.size();
1256  for (Size i = Size(0); i < len; ++i) {
1257  if (iter_vect[i] == this) {
1258  iter_vect.erase(iter_vect.begin() + i);
1259  break;
1260  }
1261  }
1262  }
std::vector< HashTableConstIteratorSafe< Key, Val > *> _safe_iterators_
The list of safe iterators pointing to the hash table.
Definition: hashTable.h:1734
const HashTable< Key, Val > * _table_
The hash table the iterator is pointing to.
Definition: hashTable.h:2103
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47

◆ 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 1530 of file hashTable_tpl.h.

1530  {
1531  // remove the iterator from the table's iterator list
1533 
1534  // set its table as well as the element it points to to 0
1535  _table_ = nullptr;
1536  _bucket_ = nullptr;
1537  _next_bucket_ = nullptr;
1538  _index_ = Size(0);
1539  }
Size _index_
the index of the chained list pointed to by the iterator in the array nodes of the hash table...
Definition: hashTable.h:2109
void _removeFromSafeList_() const
Removes the iterator from its hashtable&#39; safe iterators list.
HashTableBucket< Key, Val > * _next_bucket_
the bucket we should start from when we decide to do a ++.
Definition: hashTable.h:2122
const HashTable< Key, Val > * _table_
The hash table the iterator is pointing to.
Definition: hashTable.h:2103
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112

◆ 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 1511 of file hashTable_tpl.h.

1511  {
1512  if (_bucket_ != nullptr)
1513  return _bucket_->key();
1514  else {
1515  GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object")
1516  }
1517  }
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51

◆ 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 1655 of file hashTable_tpl.h.

1656  {
1657  return ((_bucket_ != from._bucket_) || (_index_ != from._index_));
1658  }
Size _index_
the index of the chained list pointed to by the iterator in the array nodes of the hash table...
Definition: hashTable.h:2109
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112

◆ 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 1792 of file hashTable_tpl.h.

1793  {
1795  }
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 1805 of file hashTable_tpl.h.

1805  {
1806  return const_cast< Val& >(HashTableConstIteratorSafe< Key, Val >::operator*());
1807  }
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 1811 of file hashTable_tpl.h.

1811  {
1813  }
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 1785 of file hashTable_tpl.h.

1785  {
1786  HashTableIteratorSafe< Key, Val > iter{*this};
1787  iter += nb;
1788  return iter;
1789  }

◆ 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 1771 of file hashTable_tpl.h.

1771  {
1773  return *this;
1774  }
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 1778 of file hashTable_tpl.h.

1778  {
1780  return *this;
1781  }
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 1748 of file hashTable_tpl.h.

1748  {
1749  GUM_OP_CPY(HashTableIteratorSafe);
1751  return *this;
1752  }
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 1756 of file hashTable_tpl.h.

1756  {
1757  GUM_OP_CPY(HashTableIteratorSafe);
1759  return *this;
1760  }
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 1763 of file hashTable_tpl.h.

1764  {
1766  return *this;
1767  }
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 1661 of file hashTable_tpl.h.

1662  {
1663  return ((_bucket_ == from._bucket_) && (_index_ == from._index_));
1664  }
Size _index_
the index of the chained list pointed to by the iterator in the array nodes of the hash table...
Definition: hashTable.h:2109
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112

◆ 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 1798 of file hashTable_tpl.h.

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

◆ 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 1521 of file hashTable_tpl.h.

1521  {
1522  if (_bucket_ != nullptr)
1523  return _bucket_->val();
1524  else {
1525  GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object")
1526  }
1527  }
HashTableBucket< Key, Val > * _bucket_
The bucket in the chained list pointed to by the iterator.
Definition: hashTable.h:2112
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51

◆ 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 1742 of file hashTable_tpl.h.

1742  {
1743  return const_cast< Val& >(HashTableConstIteratorSafe< Key, Val >::val());
1744  }
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 2112 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 2109 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 2122 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 2103 of file hashTable.h.


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