![]() |
aGrUM
0.20.3
a C++ library for (probabilistic) graphical models
|
Safe Iterators for hashtables. More...
#include <agrum/tools/core/hashTable.h>
Public Member Functions | |
mapped_type & | val () |
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_type & | operator* () |
Returns the value pointed to by the iterator. More... | |
const value_type & | operator* () const |
Returns the value pointed to by the iterator. 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 | |
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... | |
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>.
Key | The gum::HashTable key. |
Val | The gum::HashTable Value. |
Definition at line 2197 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::const_pointer = const value_type* |
Types for STL compliance.
Definition at line 2208 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::const_reference = const value_type& |
Types for STL compliance.
Definition at line 2206 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::difference_type = std::ptrdiff_t |
Types for STL compliance.
Definition at line 2209 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::iterator_category = std::forward_iterator_tag |
Types for STL compliance.
Definition at line 2201 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::key_type = Key |
Types for STL compliance.
Definition at line 2202 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::mapped_type = Val |
Types for STL compliance.
Definition at line 2203 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::pointer = value_type* |
Types for STL compliance.
Definition at line 2207 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::reference = value_type& |
Types for STL compliance.
Definition at line 2205 of file hashTable.h.
using gum::HashTableIteratorSafe< Key, Val >::value_type = std::pair< const Key, Val > |
Types for STL compliance.
Definition at line 2204 of file hashTable.h.
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe | ( | ) |
Basic constructor: creates an iterator pointing to nothing.
Definition at line 1692 of file hashTable_tpl.h.
gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe | ( | const HashTable< Key, Val, Alloc > & | tab | ) |
Constructor for an iterator pointing to the first element of a hashtable.
Alloc | The gum::HashTable allocator. |
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.
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). |
Alloc | The gum::HashTable allocator. |
UndefinedIteratorValue | Raised if the element cannot be found |
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe | ( | const HashTableIteratorSafe< Key, Val > & | from | ) |
Copy constructor.
from | the gum::HashTableIteratorSafe to copy. |
Definition at line 1715 of file hashTable_tpl.h.
|
explicit |
Copy constructor.
from | the gum::HashTableIterator to copy. |
Definition at line 1722 of file hashTable_tpl.h.
|
noexcept |
Move constructor.
from | The gum::HashTableIteratorSafe to move. |
Definition at line 1729 of file hashTable_tpl.h.
|
noexcept |
Class destructor.
Definition at line 1736 of file hashTable_tpl.h.
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe | ( | const HashTable< Key, Val, Alloc > & | tab | ) |
Definition at line 1699 of file hashTable_tpl.h.
INLINE gum::HashTableIteratorSafe< Key, Val >::HashTableIteratorSafe | ( | const HashTable< Key, Val, Alloc > & | tab, |
Size | ind_elt | ||
) |
Definition at line 1707 of file hashTable_tpl.h.
|
protectednoexceptinherited |
Returns the current iterator's bucket.
Definition at line 1678 of file hashTable_tpl.h.
|
protectednoexceptinherited |
Returns the index in the hashtable's node vector pointed to by the iterator.
Definition at line 1683 of file hashTable_tpl.h.
|
protectedinherited |
Insert the iterator into the hashtable's list of safe iterators.
Definition at line 1243 of file hashTable_tpl.h.
|
protectedinherited |
Removes the iterator from its hashtable' safe iterators list.
Definition at line 1249 of file hashTable_tpl.h.
|
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.
|
inherited |
Returns the key pointed to by the iterator.
UndefinedIteratorValue | Raised when the iterator does not point to a valid hash table element |
Definition at line 1511 of file hashTable_tpl.h.
|
noexceptinherited |
Checks whether two iterators are not equal.
from | from The iterator to test for inequality. |
Definition at line 1655 of file hashTable_tpl.h.
|
noexcept |
Checks whether two iterators are pointing toward different elements.
from | The gum::HashTableIteratorSafe to test for inequality. |
Definition at line 1792 of file hashTable_tpl.h.
INLINE HashTableIteratorSafe< Key, Val >::value_type & gum::HashTableIteratorSafe< Key, Val >::operator* | ( | ) |
Returns the value pointed to by the iterator.
UndefinedIteratorValue | Raised when the iterator does not point to a valid hash table element |
Definition at line 1805 of file hashTable_tpl.h.
INLINE const HashTableIteratorSafe< Key, Val >::value_type & gum::HashTableIteratorSafe< Key, Val >::operator* | ( | ) | const |
Returns the value pointed to by the iterator.
UndefinedIteratorValue | Raised when the iterator does not point to a valid hash table element. |
Definition at line 1811 of file hashTable_tpl.h.
INLINE HashTableIteratorSafe< Key, Val > gum::HashTableIteratorSafe< Key, Val >::operator+ | ( | Size | i | ) | const |
Returns a new iterator pointing to i elements further in the hashtable.
i | The number of increments. |
Definition at line 1785 of file hashTable_tpl.h.
|
noexcept |
Makes the iterator point to the next element in the hash table.
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.
Definition at line 1771 of file hashTable_tpl.h.
|
noexcept |
Makes the iterator point to i elements further in the hashtable.
i | The number of increments. |
Definition at line 1778 of file hashTable_tpl.h.
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator= | ( | const HashTableIteratorSafe< Key, Val > & | from | ) |
Copy operator.
from | The gum::HashTableIteratorSafe to copy. |
Definition at line 1748 of file hashTable_tpl.h.
INLINE HashTableIteratorSafe< Key, Val > & gum::HashTableIteratorSafe< Key, Val >::operator= | ( | const HashTableIterator< Key, Val > & | from | ) |
Copy operator.
from | The gum::HashTableIterator to copy. |
Definition at line 1756 of file hashTable_tpl.h.
|
noexcept |
Move operator.
from | The gum::HashTableIteratorSafe to move. |
Definition at line 1763 of file hashTable_tpl.h.
|
noexceptinherited |
Checks whether two iterators are equal.
from | from The iterator to test for equality. |
Definition at line 1661 of file hashTable_tpl.h.
|
noexcept |
Checks whether two iterators are pointing toward equal elements.
from | The gum::HashTableIteratorSafe to test for equality. |
Definition at line 1798 of file hashTable_tpl.h.
|
inherited |
Returns the mapped value pointed to by the iterator.
UndefinedIteratorValue | Raised when the iterator does not point to a valid hash table element. |
Definition at line 1521 of file hashTable_tpl.h.
INLINE HashTableIteratorSafe< Key, Val >::mapped_type & gum::HashTableIteratorSafe< Key, Val >::val | ( | ) |
Returns the mapped value pointed to by the iterator.
UndefinedIteratorValue | Raised when the iterator does not point to a valid hash table element. |
Definition at line 1742 of file hashTable_tpl.h.
|
protectedinherited |
The bucket in the chained list pointed to by the iterator.
Definition at line 2112 of file hashTable.h.
|
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.
|
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.
|
protectedinherited |
The hash table the iterator is pointing to.
Definition at line 2103 of file hashTable.h.