HashTableBase< T, TStored, TKey, TIfMapped, THash, TEqual, TAccess, THashCaching, TRecycling >::TIterator< TConstOrMutable > Class Template Reference

Class Description

template<typename T, typename TStored, typename TKey, typename TIfMapped, typename THash, typename TEqual, typename TAccess, Caching THashCaching, typename TRecycling>
template<typename TConstOrMutable>
class aworx::lib::monomem::detail::HashTableBase< T, TStored, TKey, TIfMapped, THash, TEqual, TAccess, THashCaching, TRecycling >::TIterator< TConstOrMutable >

---

Templated implementation of std::iterator_traits. Will be exposed by derived class's definitions Iterator and ConstIterator.

As the name of the class indicates, this iterator satisfies the C++ standard library concept ForwardIterator .

Template Parameters

TConstOrMutable

A constant or mutable version of the parent's template type TMapped.

Definition at line 335 of file hashtablebase.inl.

Public Methods
	TIterator ()=default
	TIterator (const TIterator &other)=default
	TIterator (const TMutable &mutableIt)
const TKey &	Key () const
template<typename TEnableIf = TMapped>
	Mapped () const
bool	operator!= (TIterator other) const
TConstOrMutable &	operator* () const
TIterator &	operator++ ()
TIterator	operator++ (int)
TConstOrMutable *	operator-> () const
TIterator &	operator= (const TIterator &other)=default
bool	operator== (TIterator other) const
TConstOrMutable &	Value () const

Protected Fields
uinteger	bucketIdx
Element *	element
THashtable *	table

Protected Methods
	TIterator (THashtable *pTable, uinteger pBbucketIx)
	TIterator (THashtable *pTable, uinteger pBbucketIx, Element *pElement)
void	repair ()

Private Types
using	difference_type = integer
	Implementation of std::iterator_traits.
using	iterator_category = std::forward_iterator_tag
	Implementation of std::iterator_traits.
using	pointer = TConstOrMutable *
	Implementation of std::iterator_traits.
using	reference = TConstOrMutable &
	Implementation of std::iterator_traits.
using	THashtable = ATMP_IF_T_F(!ATMP_IS_CONST(TConstOrMutable), HashTableBase, const HashTableBase)
using	value_type = TMapped
	Implementation of std::iterator_traits.

Member Typedef Documentation

THashtable

using THashtable = ATMP_IF_T_F( !ATMP_IS_CONST(TConstOrMutable), HashTableBase, const HashTableBase )

private

Const or mutable version of HashTableBase.

Definition at line 344 of file hashtablebase.inl.

Constructor & Destructor Documentation

TIterator() [1/5]

TIterator ( THashtable *  pTable, uinteger  pBbucketIx  )

inlineprotected

Internal constructor. Searches the first element, starting with given bucket number.

Parameters

pTable	Pointer to the hash table.
pBbucketIx	The bucket index.

Definition at line 367 of file hashtablebase.inl.

TIterator() [2/5]

TIterator ( THashtable *  pTable, uinteger  pBbucketIx, Element *  pElement  )

inlineprotected

Internal constructor creating a specific iterator.

Parameters

pTable	Pointer to the hash table.
pBbucketIx	The bucket index.
pElement	Pointer to the current element.

Definition at line 391 of file hashtablebase.inl.

TIterator() [3/5]

TIterator ( )

default

Default constructor. Keeps everything uninitialized.

TIterator() [4/5]

TIterator ( const TIterator< TConstOrMutable > &  other )

default

Copy constructor (default).

Parameters

other

The iterator to assign from.

TIterator() [5/5]

TIterator

(

const TMutable &

mutableIt

)

Copy constructor accepting a mutable iterator. Available only for the constant version of this iterator.

Template Parameters

TMutable

The type of this constructor's argument.

Parameters

mutableIt

Mutable iterator to copy from.

Member Function Documentation

Key()

const TKey& Key ( ) const

inline

Retrieves the key-portion of the stored object that this iterator references.

Returns

A reference to the key-portion of the stored object.

Definition at line 524 of file hashtablebase.inl.

Here is the call graph for this function:

Mapped()

Mapped ( ) const

inline

Retrieves the mapped-portion of the stored object that this iterator references. This method is an alias to operator*

Availability

This method is only available with hash map mode.

Returns

A reference to the mapped-portion of the stored object.

Definition at line 540 of file hashtablebase.inl.

Here is the call graph for this function:

operator!=()

bool operator!= ( TIterator< TConstOrMutable >  other ) const

inline

Comparison operator.

Parameters

other

The iterator to compare ourselves to.

Returns

true if this and given iterator are not equal, false otherwise.

Definition at line 490 of file hashtablebase.inl.

operator*()

TConstOrMutable& operator* ( ) const

inline

Retrieves the stored object that this iterator references.

Returns

A reference to the stored object.

Definition at line 500 of file hashtablebase.inl.

operator++() [1/2]

TIterator& operator++ ( )

inline

Prefix increment operator.

Returns

A reference to this object.

Definition at line 446 of file hashtablebase.inl.

operator++() [2/2]

TIterator operator++ ( int  )

inline

Postfix increment operator.

Returns

An iterator value that is not increased, yet.

Definition at line 471 of file hashtablebase.inl.

Here is the call graph for this function:

operator->()

TConstOrMutable* operator-> ( ) const

inline

Retrieves a pointer to the stored object that this iterator references.

Returns

A pointer to the stored object.

Definition at line 508 of file hashtablebase.inl.

operator=()

TIterator& operator= ( const TIterator< TConstOrMutable > &  other )

default

Copy assignment (default).

Parameters

other

The iterator to assign from.

Returns

A reference to this object.

operator==()

bool operator== ( TIterator< TConstOrMutable >  other ) const

inline

Comparison operator.

Parameters

other

The iterator to compare ourselves to.

Returns

true if this and the given iterator are pointing to the same element, false otherwise.

Definition at line 482 of file hashtablebase.inl.

repair()

void repair ( )

inlineprotected

Moves an iterator with a nulled element pointer to the next element.

Definition at line 398 of file hashtablebase.inl.

Value()

TConstOrMutable& Value ( ) const

inline

Retrieves the stored object that this iterator references.

Returns

A reference to the stored object.

Definition at line 516 of file hashtablebase.inl.

Member Data Documentation

bucketIdx

uinteger bucketIdx

protected

The actual bucket index.

Definition at line 356 of file hashtablebase.inl.

element

Element* element

protected

The pointer to the actual element.

Definition at line 359 of file hashtablebase.inl.

table

THashtable* table

protected

The pointer to the hash table.

Definition at line 353 of file hashtablebase.inl.

---

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

• hashtablebase.inl