Fw/DataStructures/docs/SetConstIterator.md
SetConstIterator is a class for performing immutable iteration over a set.
The iteration order is not specified.
SetConstIterator has the following template parameters:
| Kind | Name | Purpose |
|---|---|---|
typename | T | The type of an element in the set |
SetConstIterator provides the following constructors and destructors:
One constructor for each set implementation. The set implementations use these constructors to provide iterators.
A copy constructor.
A destructor.
SetConstIterator provides the following member functions.
Defined as = default.
bool operator==(const SetConstIterator& it)
Compare two SetConstIterator instances for equality.
If the implementations differ, then return false.
Otherwise check whether the implementations have equal values.
bool operator!=(const SetConstIterator& it)
Return the negation of operator=.
SetConstIterator& operator++()
SetConstIterator& operator++(int)
Increment the iterator.
bool isInRange() const
Check whether the iterator is in range.
It is a runtime error to attempt to access a set element through an iterator
for which isInRange evaluates to false.
In this case an assertion failure will occur.
const EntryBase& operator*() const
Return a const reference to the T element
pointed to by the iterator.
If the iterator is not in range for the map, an assertion failure will occur.
It is not recommended to use this operation
after updating the set that the iterator points to.
const EntryBase* operator->() const
Return a pointer to the const T element
pointed to by the iterator.
If the iterator is not in range for the map, an assertion failure will occur.
It is not recommended to use this operation
after updating the set that the iterator points to.