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

Unsafe Iterators for hashtablesHashTableIterator provides a fast but unsafe way to parse HashTables. More...

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

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

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

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

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

Detailed Description

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

Unsafe Iterators for hashtables

HashTableIterator 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>::iterator instead of HashTableIterator<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 iter = table.begin ();
       iter != table.end (); ++iter) {
  // display the values
  cerr << "at " << iter.key() << " value = " << iter.val () << endl;
  HashTable<int,string>::value_type& elt = *iter;
  std::pair<const int, string>& xelt = *iter;
}

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

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

Template Parameters

Key	The gum::HashTable key.
Val	The gum::HashTable Value.

Definition at line 2723 of file hashTable.h.

Member Typedef Documentation

const_pointer

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2734 of file hashTable.h.

const_reference

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2732 of file hashTable.h.

difference_type

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2735 of file hashTable.h.

iterator_category

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2727 of file hashTable.h.

key_type

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2728 of file hashTable.h.

mapped_type

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2729 of file hashTable.h.

pointer

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2733 of file hashTable.h.

reference

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2731 of file hashTable.h.

value_type

template<typename Key, typename Val>

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

types for STL compliance

Definition at line 2730 of file hashTable.h.

Constructor & Destructor Documentation

HashTableIterator() [1/7]

template<typename Key , typename Val >

INLINE gum::HashTableIterator< Key, Val >::HashTableIterator ( )

noexcept

Basic constructor: creates an iterator pointing to nothing.

Definition at line 2108 of file hashTable_tpl.h.

                                                                   :
      HashTableConstIterator< Key, Val >() {
    GUM_CONSTRUCTOR(HashTableIterator);
  }

HashTableIterator() [2/7]

template<typename Key, typename Val>

template<typename Alloc >

gum::HashTableIterator< Key, Val >::HashTableIterator ( const HashTable< Key, Val, Alloc > &  tab )

noexcept

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

Template Parameters

Alloc

The gum::HashTable allocator.

Parameters

tab	The gum::HashTable to iterate over.

HashTableIterator() [3/7]

template<typename Key, typename Val>

template<typename Alloc >

gum::HashTableIterator< Key, Val >::HashTableIterator	(	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.

HashTableIterator() [4/7]

template<typename Key, typename Val>

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

noexcept

Copy constructor.

Parameters

from	The gum::HashTableIterator to copy.

Definition at line 2130 of file hashTable_tpl.h.

                                                         :
      HashTableConstIterator< Key, Val >(from) {
    GUM_CONS_CPY(HashTableIterator);
  }

HashTableIterator() [5/7]

template<typename Key, typename Val>

INLINE gum::HashTableIterator< Key, Val >::HashTableIterator ( HashTableIterator< Key, Val > &&  from )

noexcept

Move constructor.

Parameters

from	The gum::HashTableIterator to move.

Definition at line 2138 of file hashTable_tpl.h.

      :
      HashTableConstIterator< Key, Val >(std::move(from)) {
    GUM_CONS_MOV(HashTableIterator);
  }

~HashTableIterator()

template<typename Key , typename Val >

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

noexcept

Class destructor.

Definition at line 2145 of file hashTable_tpl.h.

                                                                    {
    GUM_DESTRUCTOR(HashTableIterator);
  }

HashTableIterator() [6/7]

template<typename Key, typename Val>

template<typename Alloc >

INLINE gum::HashTableIterator< Key, Val >::HashTableIterator ( const HashTable< Key, Val, Alloc > &  tab )

noexcept

Definition at line 2115 of file hashTable_tpl.h.

                                                       :
      HashTableConstIterator< Key, Val >(tab) {
    GUM_CONSTRUCTOR(HashTableIterator);
  }

HashTableIterator() [7/7]

template<typename Key, typename Val>

template<typename Alloc >

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

Definition at line 2123 of file hashTable_tpl.h.

                                                                        :
      HashTableConstIterator< Key, Val >(tab, ind_elt) {
    GUM_CONSTRUCTOR(HashTableIterator);
  }

Member Function Documentation

_getBucket_()

template<typename Key , typename Val >

INLINE HashTable< Key, Val >::Bucket * gum::HashTableConstIterator< Key, Val >::_getBucket_ ( ) const

protectednoexceptinherited

Returns the current iterator's bucket.

Returns

Returns the current iterator's bucket.

Definition at line 2094 of file hashTable_tpl.h.

                                                                    {
    return _bucket_;
  }

_getIndex_()

template<typename Key , typename Val >

INLINE Size gum::HashTableConstIterator< 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 2099 of file hashTable_tpl.h.

                                                                            {
    return _index_;
  }

clear()

template<typename Key , typename Val >

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

noexceptinherited

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

Definition at line 1979 of file hashTable_tpl.h.

                                                                 {
    _table_  = nullptr;
    _bucket_ = nullptr;
    _index_  = 0;
  }

key()

template<typename Key , typename Val >

INLINE const HashTableConstIterator< Key, Val >::key_type & gum::HashTableConstIterator< Key, Val >::key ( ) const

inherited

Returns the key corresponding to the element pointed to by the iterator.

Warning

Using this method on an iterator that points to an element that has been deleted will most certainly result in a segfault. If unsure, use a safe iterator instead of an unsafe one.

Returns

Returns the key corresponding to the element pointed to by the iterator.

Definition at line 1960 of file hashTable_tpl.h.

                                                   {
    if (_bucket_)
      return _bucket_->pair.first;
    else {
      GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object")
    }
  }

operator!=() [1/2]

template<typename Key, typename Val>

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

noexceptinherited

Checks whether two iterators are pointing toward different elements.

Parameters

from	The gum::HashTableConstIterator to test for inequality.

Returns

Returns true if this and from are not equal.

Definition at line 2071 of file hashTable_tpl.h.

                                                                    {
    return (_bucket_ != from._bucket_);
  }

operator!=() [2/2]

template<typename Key, typename Val>

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

noexcept

Checks whether two iterators are pointing toward different elements.

Parameters

from	The gum::HashTableIterator to test for inequality.

Returns

Returns true if this and from are not equal.

Definition at line 2194 of file hashTable_tpl.h.

                                                               {
    return HashTableConstIterator< Key, Val >::operator!=(from);
  }

operator*() [1/2]

template<typename Key , typename Val >

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

(

)

Returns the value pointed to by the iterator.

Warning

using this method on an iterator that points to an element that has been deleted will most certainly result in a segfault. If unsure, use a safe iterator instead of an unsafe one.

Returns

Returns the value pointed to by the iterator.

Definition at line 2207 of file hashTable_tpl.h.

                                              {
    return const_cast< value_type& >(HashTableConstIterator< Key, Val >::operator*());
  }

operator*() [2/2]

template<typename Key , typename Val >

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

(

)

const

Returns the value pointed to by the iterator.

Warning

using this method on an iterator that points to an element that has been deleted will most certainly result in a segfault. If unsure, use a safe iterator instead of an unsafe one.

Returns

Returns the value pointed to by the iterator.

Definition at line 2213 of file hashTable_tpl.h.

                                                    {
    return HashTableConstIterator< Key, Val >::operator*();
  }

operator+()

template<typename Key , typename Val >

INLINE HashTableIterator< Key, Val > gum::HashTableIterator< Key, Val >::operator+ ( Size  i ) const

noexcept

Returns a new iterator.

Parameters

i	The number of increments.

Returns

Returns this gum::HashTableIterator.

Definition at line 2187 of file hashTable_tpl.h.

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

operator++()

template<typename Key , typename Val >

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

noexcept

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

for (iter = begin(); iter != end(); ++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.

Warning

performing a ++ on an iterator that points to an element that has been deleted will most certainly result in a segfault.

Returns

Returns this gum::HashTableIterator.

Definition at line 2173 of file hashTable_tpl.h.

                                                                                           {
    HashTableConstIterator< Key, Val >::operator++();
    return *this;
  }

operator+=()

template<typename Key , typename Val >

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

noexcept

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

Parameters

i	The number of increments.

Returns

Returns this gum::HashTableIterator.

Definition at line 2180 of file hashTable_tpl.h.

                                                               {
    HashTableConstIterator< Key, Val >::operator+=(nb);
    return *this;
  }

operator=() [1/2]

template<typename Key, typename Val>

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

noexcept

Copy operator.

Parameters

from	The gum::HashTableIterator to copy.

Returns

Returns this gum::HashTableIterator.

Definition at line 2160 of file hashTable_tpl.h.

                                                                                                {
    HashTableConstIterator< Key, Val >::operator=(from);
    return *this;
  }

operator=() [2/2]

template<typename Key, typename Val>

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

noexcept

Move operator.

Parameters

from	The gum::HashTableIterator to move.

Returns

Returns this gum::HashTableIterator.

Definition at line 2167 of file hashTable_tpl.h.

                                                                                           {
    HashTableConstIterator< Key, Val >::operator=(std::move(from));
    return *this;
  }

operator==() [1/2]

template<typename Key, typename Val>

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

noexceptinherited

Checks whether two iterators are pointing toward equal elements.

Parameters

from	The gum::HashTableConstIterator to test for equality.

Returns

Returns true if this and from are equal.

Definition at line 2077 of file hashTable_tpl.h.

                                                                    {
    return (_bucket_ == from._bucket_);
  }

operator==() [2/2]

template<typename Key, typename Val>

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

noexcept

Checks whether two iterators are pointing toward equal elements.

Parameters

from	The gum::HashTableIterator to test for equality.

Returns

Returns true if this and from are equal.

Definition at line 2200 of file hashTable_tpl.h.

                                                               {
    return HashTableConstIterator< Key, Val >::operator==(from);
  }

val() [1/2]

template<typename Key , typename Val >

INLINE const HashTableConstIterator< Key, Val >::mapped_type & gum::HashTableConstIterator< Key, Val >::val ( ) const

inherited

Returns the mapped value pointed to by the iterator.

Warning

Using this method on an iterator that points to an element that has been deleted will most certainly result in a segfault. If unsure, use a safe iterator instead of an unsafe one.

Returns

Returns the mapped value pointed to by the iterator.

Definition at line 1970 of file hashTable_tpl.h.

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

val() [2/2]

template<typename Key , typename Val >

INLINE HashTableIterator< Key, Val >::mapped_type & gum::HashTableIterator< Key, Val >::val

(

)

Returns the mapped value pointed to by the iterator.

Warning

using this method on an iterator that points to an element that has been deleted will most certainly result in a segfault. If unsure, use a safe iterator instead of an unsafe one.

Returns

Returns the mapped value pointed to by the iterator.

Definition at line 2150 of file hashTable_tpl.h.

                                                                                               {
    if (this->_bucket_)
      return this->_bucket_->val();
    else {
      GUM_ERROR(UndefinedIteratorValue, "Accessing a nullptr object")
    }
  }

Member Data Documentation

_bucket_

template<typename Key, typename Val>

HashTable< Key, Val >::Bucket* gum::HashTableConstIterator< Key, Val >::_bucket_ {nullptr}

protectedinherited

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

Definition at line 2654 of file hashTable.h.

_index_

template<typename Key, typename Val>

Size gum::HashTableConstIterator< Key, Val >::_index_ {Size(0)}

protectedinherited

The index of the chained list pointed by the iterator in the array of nodes of the hash table.

Definition at line 2651 of file hashTable.h.

_table_

template<typename Key, typename Val>

const HashTable< Key, Val >* gum::HashTableConstIterator< Key, Val >::_table_ {nullptr}

protectedinherited

The hash table the iterator is pointing to.

Definition at line 2645 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