![]() |
aGrUM
0.16.0
|
Unsafe Const Iterators for hashtablesHashTableConstIterator provides a fast but unsafe way to parse HashTables. More...
#include <agrum/core/hashTable.h>
Public Member Functions | |
template<typename Alloc > | |
INLINE | HashTableConstIterator (const HashTable< Key, Val, Alloc > &tab) noexcept |
Constructors / Destructors | |
HashTableConstIterator () noexcept | |
Basic constructor: creates an iterator pointing to nothing. More... | |
template<typename Alloc > | |
HashTableConstIterator (const HashTable< Key, Val, Alloc > &tab) noexcept | |
Constructor for an iterator pointing to the first element of a hashtable. More... | |
template<typename Alloc > | |
HashTableConstIterator (const HashTable< Key, Val, Alloc > &tab, Size ind_elt) | |
Constructor for an iterator pointing to the nth element of a hashtable. More... | |
HashTableConstIterator (const HashTableConstIterator< Key, Val > &from) noexcept | |
Copy constructor. More... | |
HashTableConstIterator (HashTableConstIterator< Key, Val > &&from) noexcept | |
Move constructor. More... | |
~HashTableConstIterator () noexcept | |
Class destructor. More... | |
Accessors / Modifiers | |
const key_type & | key () const |
Returns the key corresponding to the element 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 | |
HashTableConstIterator< Key, Val > & | operator= (const HashTableConstIterator< Key, Val > &from) noexcept |
Copy operator. More... | |
HashTableConstIterator< Key, Val > & | operator= (HashTableConstIterator< Key, Val > &&from) noexcept |
Move operator. More... | |
HashTableConstIterator< Key, Val > & | operator++ () noexcept |
Makes the iterator point to the next element in the hash table. More... | |
HashTableConstIterator< Key, Val > & | operator+= (Size i) noexcept |
Makes the iterator point to i elements further in the hashtable. More... | |
HashTableConstIterator< Key, Val > | operator+ (Size i) const noexcept |
Returns a new iterator pointing to i elements further in the hashtable. More... | |
bool | operator!= (const HashTableConstIterator< Key, Val > &from) const noexcept |
Checks whether two iterators are pointing toward different elements. More... | |
bool | operator== (const HashTableConstIterator< Key, Val > &from) const noexcept |
Checks whether two iterators are pointing toward equal elements. More... | |
const value_type & | operator* () const |
Returns the value 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 by the iterator in the array of nodes of the hash table. More... | |
HashTable< Key, Val >::Bucket * | __bucket {nullptr} |
The bucket in the chained list pointed to by the iterator. More... | |
Protected Member Functions | |
HashTable< Key, Val >::Bucket * | __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... | |
Friends | |
template<typename K , typename V , typename A > | |
class | HashTable |
Class HashTable must be a friend because it stores iterator end and this one can be properly initialized only when the hashtable has been fully allocated. More... | |
class | HashTableConstIteratorSafe< Key, Val > |
For the safe copy constructor and operator. More... | |
Unsafe Const Iterators for hashtables
HashTableConstIterator provides a fast but unsafe way to parse HashTables.
They should only be used when parsing hashtables in which no element is removed from the hashtable. Removing an element where the iterator points to will mess the iterator as it will most certainly point to an unallocated memory. So, this kind of iterator should only be used when parsing "(key) constant" hash tables, e.g., when we wish to display the content of a hash table or when we wish to update the mapped values of some elements of the hash table without ever modifying their keys.
Developers may consider using HashTable<x,y>::const_iterator instead of HashTableConstIterator<x,y>.
Key | The gum::HashTable key. |
Val | The gum::HashTable Value. |
Definition at line 2465 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::const_pointer = const value_type* |
Types for STL compliance.
Definition at line 2476 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::const_reference = const value_type& |
Types for STL compliance.
Definition at line 2474 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::difference_type = std::ptrdiff_t |
Types for STL compliance.
Definition at line 2477 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::iterator_category = std::forward_iterator_tag |
Types for STL compliance.
Definition at line 2469 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::key_type = Key |
Types for STL compliance.
Definition at line 2470 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::mapped_type = Val |
Types for STL compliance.
Definition at line 2471 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::pointer = value_type* |
Types for STL compliance.
Definition at line 2475 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::reference = value_type& |
Types for STL compliance.
Definition at line 2473 of file hashTable.h.
using gum::HashTableConstIterator< Key, Val >::value_type = std::pair< const Key, Val > |
Types for STL compliance.
Definition at line 2472 of file hashTable.h.
|
noexcept |
Basic constructor: creates an iterator pointing to nothing.
Definition at line 1876 of file hashTable_tpl.h.
|
noexcept |
Constructor for an iterator pointing to the first element of a hashtable.
tab | The gum::HashTable to iterate over. |
Alloc | The gum::HashTable allocator. |
gum::HashTableConstIterator< Key, Val >::HashTableConstIterator | ( | 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). |
UndefinedIteratorValue | Raised if the element cannot be found. |
Definition at line 1909 of file hashTable_tpl.h.
|
noexcept |
Copy constructor.
from | The gum::HashTableConstIterator to copy. |
Definition at line 1968 of file hashTable_tpl.h.
|
noexcept |
Move constructor.
from | The gum::HashTableConstIterator to move. |
Definition at line 1976 of file hashTable_tpl.h.
|
noexcept |
Class destructor.
Definition at line 1984 of file hashTable_tpl.h.
|
noexcept |
Definition at line 1882 of file hashTable_tpl.h.
|
protectednoexcept |
Returns the current iterator's bucket.
Definition at line 2154 of file hashTable_tpl.h.
|
protectednoexcept |
Returns the index in the hashtable's node vector pointed to by the iterator.
Definition at line 2159 of file hashTable_tpl.h.
|
noexcept |
Makes the iterator point toward nothing (in particular, it is not related anymore to its current hash table).
Definition at line 2036 of file hashTable_tpl.h.
Referenced by gum::SetIterator< Key >::clear().
INLINE const HashTableConstIterator< Key, Val >::key_type & gum::HashTableConstIterator< Key, Val >::key | ( | ) | const |
Returns the key corresponding to the element pointed to by the iterator.
Definition at line 2017 of file hashTable_tpl.h.
Referenced by gum::SetIterator< Key >::operator*(), and gum::SetIterator< Key >::operator->().
|
noexcept |
Checks whether two iterators are pointing toward different elements.
from | The gum::HashTableConstIterator to test for inequality. |
Definition at line 2132 of file hashTable_tpl.h.
INLINE const HashTableConstIterator< Key, Val >::value_type & gum::HashTableConstIterator< Key, Val >::operator* | ( | ) | const |
Returns the value pointed to by the iterator.
Definition at line 2144 of file hashTable_tpl.h.
|
noexcept |
Returns a new iterator pointing to i elements further in the hashtable.
i | The number of increments. |
Definition at line 2126 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.
Definition at line 2044 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 2092 of file hashTable_tpl.h.
|
noexcept |
Copy operator.
from | The gum::HashTableConstIterator to copy. |
Definition at line 1991 of file hashTable_tpl.h.
|
noexcept |
Move operator.
from | The gum::HashTableConstIterator to move. |
Definition at line 2004 of file hashTable_tpl.h.
|
noexcept |
Checks whether two iterators are pointing toward equal elements.
from | The gum::HashTableConstIterator to test for equality. |
Definition at line 2138 of file hashTable_tpl.h.
INLINE const HashTableConstIterator< Key, Val >::mapped_type & gum::HashTableConstIterator< Key, Val >::val | ( | ) | const |
Returns the mapped value pointed to by the iterator.
Definition at line 2027 of file hashTable_tpl.h.
Referenced by gum::HashTableConstIterator< Key, bool >::val().
|
friend |
Class HashTable must be a friend because it stores iterator end and this one 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.
K | The gum::HashTable keys type. |
V | The gum::HashTable values type. |
A | The gum::HashTable allocator. |
Definition at line 2666 of file hashTable.h.
|
friend |
For the safe copy constructor and operator.
Definition at line 2669 of file hashTable.h.
|
protected |
The bucket in the chained list pointed to by the iterator.
Definition at line 2681 of file hashTable.h.
Referenced by gum::HashTableConstIteratorSafe< const gum::DiscreteVariable *, Idx >::operator=().
|
protected |
The index of the chained list pointed by the iterator in the array of nodes of the hash table.
Definition at line 2678 of file hashTable.h.
Referenced by gum::HashTableConstIteratorSafe< const gum::DiscreteVariable *, Idx >::operator=().
|
protected |
The hash table the iterator is pointing to.
Definition at line 2672 of file hashTable.h.
Referenced by gum::HashTableConstIterator< Key, bool >::HashTableConstIterator(), gum::HashTableConstIteratorSafe< const gum::DiscreteVariable *, Idx >::HashTableConstIteratorSafe(), gum::HashTableConstIteratorSafe< const gum::DiscreteVariable *, Idx >::operator=(), and gum::HashTableConstIterator< Key, bool >::operator=().