gum::SetIterator< Key > Class Template Reference

Unsafe iterators for the Set class. More...

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

Collaboration diagram for gum::SetIterator< Key >:

Public Member Functions
template<typename Alloc >
INLINE	SetIterator (const Set< Key, Alloc > &set, Position pos)
Constructors / Destructors
	SetIterator () noexcept
	Default constructor: the iterator points toward nothing. More...
template<typename Alloc >
	SetIterator (const Set< Key, Alloc > &from, Position pos=BEGIN)
	Creates an iterator for a given set. More...
	SetIterator (const SetIterator< Key > &from) noexcept
	Copy constructor. More...
	SetIterator (SetIterator< Key > &&from) noexcept
	Move constructor. More...
	~SetIterator () noexcept
	Class destructor. More...
Operators
SetIterator< Key > &	operator= (const SetIterator< Key > &from) noexcept
	Assignment operator. More...
SetIterator< Key > &	operator= (SetIterator< Key > &&from) noexcept
	Assignment operator. More...
SetIterator< Key > &	operator++ () noexcept
	Increments the iterator. More...
SetIterator< Key > &	operator+= (Size i) noexcept
	Makes the iterator point to i elements further in the set. More...
SetIterator< Key >	operator+ (Size i) const noexcept
	Returns a new iterator. More...
bool	operator!= (const SetIterator< Key > &from) const noexcept
	Indicates whether two iterators point to different elements or sets. More...
bool	operator== (const SetIterator< Key > &from) const noexcept
	Indicates whether two iterators point toward the same element of a same set. More...
const Key &	operator* () const
	Returns the element pointed to by the iterator. More...
const Key *	operator-> () const
	Returns a pointer to the element pointed to by the iterator. More...
Accessors / Modifiers
void	clear () noexcept
	makes the iterator point toward nothing (in particular, it is not related anymore to its current set). More...

Public Types
enum	Position { BEGIN, END }
	An enumeration to position the iterator at the beginning or the end of the set. More...
using	iterator_category = std::forward_iterator_tag
	Types for STL compliance. More...
using	value_type = Key
	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...

Friends
template<typename K , typename A >
class	Set
	For efficiency, Set should be able to modify the hash table iterator. More...
class	SetIteratorSafe< Key >

Detailed Description

template<typename Key>
class gum::SetIterator< Key >

Unsafe iterators for the Set class.

Developers may consider using Set<x>::iterator instead of SetIterator<x>.

Warning

Use SetIterator only if you are sure that the iterator will never point to a deleted element. Pointing to a deleted element will most probably result in a segfault. If you are unsure, prefer using the safe iterators Set<>::iterator_safe.

Usage example:

// creation of a set with 10 elements
Set<int> set;
for (int i = 0; i< 10; ++i)
  set<<i;

// parse the set
for (const auto iter = table.begin (); iter != table.end (); *++iter) {
  // display the values
  cerr <<  *iter << endl;
}

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

Template Parameters

Key	The elements type.

Definition at line 1025 of file set.h.

Member Typedef Documentation

const_pointer

template<typename Key>

using gum::SetIterator< Key >::const_pointer = const value_type*

Types for STL compliance.

Definition at line 1034 of file set.h.

const_reference

template<typename Key>

using gum::SetIterator< Key >::const_reference = const value_type&

Types for STL compliance.

Definition at line 1032 of file set.h.

difference_type

template<typename Key>

using gum::SetIterator< Key >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 1035 of file set.h.

iterator_category

template<typename Key>

using gum::SetIterator< Key >::iterator_category = std::forward_iterator_tag

Types for STL compliance.

Definition at line 1029 of file set.h.

pointer

template<typename Key>

using gum::SetIterator< Key >::pointer = value_type*

Types for STL compliance.

Definition at line 1033 of file set.h.

reference

template<typename Key>

using gum::SetIterator< Key >::reference = value_type&

Types for STL compliance.

Definition at line 1031 of file set.h.

value_type

template<typename Key>

using gum::SetIterator< Key >::value_type = Key

Types for STL compliance.

Definition at line 1030 of file set.h.

Member Enumeration Documentation

Position

template<typename Key>

enum gum::SetIterator::Position

An enumeration to position the iterator at the beginning or the end of the set.

Enumerator
BEGIN
END

Definition at line 1042 of file set.h.

{ BEGIN, END };

Constructor & Destructor Documentation

SetIterator() [1/5]

template<typename Key >

INLINE gum::SetIterator< Key >::SetIterator ( )

noexcept

Default constructor: the iterator points toward nothing.

Definition at line 176 of file set_tpl.h.

                                                  {
    GUM_CONSTRUCTOR(SetIterator);
  }

SetIterator() [2/5]

template<typename Key>

template<typename Alloc >

gum::SetIterator< Key >::SetIterator	(	const Set< Key, Alloc > &	from,
		Position	pos = BEGIN
	)

Creates an iterator for a given set.

By default, the iterator points to the beginning of the set, but, using optional argument pos, you can make it point to end().

Template Parameters

Alloc

The gum::Set allocator.

Parameters

from	The gum::Set to iterator over.
pos	Where to start iterating.

SetIterator() [3/5]

template<typename Key >

INLINE gum::SetIterator< Key >::SetIterator ( const SetIterator< Key > &  from )

noexcept

Copy constructor.

Parameters

from	The iterator to copy.

Definition at line 192 of file set_tpl.h.

                                                                                :
      __ht_iter{iter.__ht_iter} {
    GUM_CONS_CPY(SetIterator);
  }

SetIterator() [4/5]

template<typename Key >

INLINE gum::SetIterator< Key >::SetIterator ( SetIterator< Key > &&  from )

noexcept

Move constructor.

Parameters

from	The iterator to move.

Definition at line 199 of file set_tpl.h.

                                                                           :
      __ht_iter{std::move(from.__ht_iter)} {
    GUM_CONS_MOV(SetIterator);
  }

~SetIterator()

template<typename Key >

INLINE gum::SetIterator< Key >::~SetIterator ( )

noexcept

Class destructor.

Definition at line 206 of file set_tpl.h.

                                                   {
    GUM_DESTRUCTOR(SetIterator);
  }

SetIterator() [5/5]

template<typename Key>

template<typename Alloc >

INLINE gum::SetIterator< Key >::SetIterator	(	const Set< Key, Alloc > &	set,
		Position	pos
	)

Definition at line 183 of file set_tpl.h.

                                                                       :
      __ht_iter{pos == SetIterator< Key >::END ? set.__inside.cend()
                                               : set.__inside.cbegin()} {
    GUM_CONSTRUCTOR(SetIterator);
  }

Member Function Documentation

clear()

template<typename Key >

INLINE void gum::SetIterator< Key >::clear ( )

noexcept

makes the iterator point toward nothing (in particular, it is not related anymore to its current set).

Definition at line 283 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter, and gum::HashTableConstIterator< Key, Val >::clear().

                                                 {
    __ht_iter.clear();
  }

Here is the call graph for this function:

operator!=()

template<typename Key >

INLINE bool gum::SetIterator< Key >::operator!= ( const SetIterator< Key > &  from ) const

noexcept

Indicates whether two iterators point to different elements or sets.

Parameters

from	The iterator to test for inequality.

Returns

Returns true if both iterator are not equal.

Definition at line 251 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

              {
    return __ht_iter != from.__ht_iter;
  }

operator*()

template<typename Key >

INLINE const Key & gum::SetIterator< Key >::operator*

(

)

const

Returns the element pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised if the iterator does not point to an element of the set (for instance if the set or the element previously pointed to by the iterator have been deleted).

Returns

Returns the element pointed to by the iterator.

Definition at line 266 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter, and gum::HashTableConstIterator< Key, Val >::key().

                                                        {
    // note that, if the hashtable's iterator points toward nothing, it will
    // raise an UndefinedIteratorValue exception
    return __ht_iter.key();
  }

Here is the call graph for this function:

operator+()

template<typename Key >

INLINE SetIterator< Key > gum::SetIterator< Key >::operator+ ( Size  i ) const

noexcept

Returns a new iterator.

Parameters

i	The number of increments.

Returns

Returns a new iterator.

Definition at line 245 of file set_tpl.h.

                                                                                {
    return SetIterator< Key >{*this} += nb;
  }

operator++()

template<typename Key >

INLINE SetIterator< Key > & gum::SetIterator< Key >::operator++ ( )

noexcept

Increments the iterator.

Returns

This iterator.

Definition at line 228 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

                                                                     {
    // note that, if the hashtable's iterator points toward nothing, the
    // hashtable's iterator incrementation will do nothing. In particular, it
    // will not segfault.
    ++__ht_iter;
    return *this;
  }

operator+=()

template<typename Key >

INLINE SetIterator< Key > & gum::SetIterator< Key >::operator+= ( Size  i )

noexcept

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

Parameters

i	The number of increments.

Returns

Returns this iterator.

Definition at line 238 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

                                                                            {
    __ht_iter += nb;
    return *this;
  }

operator->()

template<typename Key >

INLINE const Key * gum::SetIterator< Key >::operator->

(

)

const

Returns a pointer to the element pointed to by the iterator.

Exceptions

UndefinedIteratorValue

Raised if the iterator does not point to an element of the set (for instance if the set or the element previously pointed to by the iterator have been deleted).

Returns

Returns a pointer to the element pointed to by the iterator.

Definition at line 274 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter, and gum::HashTableConstIterator< Key, Val >::key().

                                                         {
    // note that, if the hashtable's iterator points toward nothing, it will
    // raise an UndefinedIteratorValue exception
    return &(__ht_iter.key());
  }

Here is the call graph for this function:

operator=() [1/2]

template<typename Key >

INLINE SetIterator< Key > & gum::SetIterator< Key >::operator= ( const SetIterator< Key > &  from )

noexcept

Assignment operator.

Parameters

from	The iterator to copy.

Returns

Returns this iterator.

Definition at line 213 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

                                                                          {
    __ht_iter = from.__ht_iter;
    return *this;
  }

operator=() [2/2]

template<typename Key >

INLINE SetIterator< Key > & gum::SetIterator< Key >::operator= ( SetIterator< Key > &&  from )

noexcept

Assignment operator.

Parameters

from	The iterator to copy.

Returns

Returns this iterator.

Definition at line 221 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

                                                                     {
    __ht_iter = std::move(from.__ht_iter);
    return *this;
  }

operator==()

template<typename Key >

INLINE bool gum::SetIterator< Key >::operator== ( const SetIterator< Key > &  from ) const

noexcept

Indicates whether two iterators point toward the same element of a same set.

Parameters

from	The iterator to test for equality.

Returns

Returns true if both iterator are equal.

Definition at line 259 of file set_tpl.h.

References gum::SetIterator< Key >::__ht_iter.

              {
    return __ht_iter == from.__ht_iter;
  }

Friends And Related Function Documentation

Set

template<typename Key>

template<typename K , typename A >

friend class Set

friend

For efficiency, Set should be able to modify the hash table iterator.

Definition at line 1179 of file set.h.

SetIteratorSafe< Key >

template<typename Key>

friend class SetIteratorSafe< Key >

friend

Definition at line 1180 of file set.h.

Member Data Documentation

__ht_iter

template<typename Key>

HashTableConstIterator< Key, bool > gum::SetIterator< Key >::__ht_iter

private

The underlying iterator for the set's hash table containing the data.

Definition at line 1183 of file set.h.

Referenced by gum::SetIterator< Key >::clear(), gum::SetIterator< Key >::operator!=(), gum::SetIterator< Key >::operator*(), gum::SetIterator< Key >::operator++(), gum::SetIterator< Key >::operator+=(), gum::SetIterator< Key >::operator->(), gum::SetIteratorSafe< const gum::DiscreteVariable * >::operator=(), gum::SetIterator< Key >::operator=(), gum::SetIterator< Key >::operator==(), and gum::SetIteratorSafe< const gum::DiscreteVariable * >::SetIteratorSafe().

---

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

• agrum/tools/core/set.h
• agrum/tools/core/set_tpl.h