Description:

template<typename T, typename TStored, typename TKey, typename TIfMapped, typename THash, typename TEqual, typename TAccess, lang::Caching THashCaching, typename TRecycling>
template<typename TConstOrMutable>
class alib::monomem::detail::HashTableBase< T, TStored, TKey, TIfMapped, THash, TEqual, TAccess, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >

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

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 HashTableBase::TMapped .

Definition at line 561 of file hashtablebase.inl.

Public Method Index:
	TLocalIterator ()

	TLocalIterator (const TLocalIterator &other)=default

	TLocalIterator (const TMutable &mutableIt)

	TLocalIterator (uinteger pBucketIdx, Element *pElement)

const TKey &	Key () const

template<typename TEnableIf = TMapped>
	Mapped () const

bool	operator!= (TLocalIterator other) const

TConstOrMutable &	operator* () const

TLocalIterator &	operator++ ()

TLocalIterator	operator++ (int)

TConstOrMutable *	operator-> () const

TLocalIterator &	operator= (const TLocalIterator &other)=default

bool	operator== (TLocalIterator other) const

TConstOrMutable &	Value () const

Type Definition Details:

◆ difference_type

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

using difference_type = integer

private

Implementation of std::iterator_traits.

Definition at line 570 of file hashtablebase.inl.

◆ iterator_category

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

using iterator_category = std::forward_iterator_tag

private

Implementation of std::iterator_traits.

Definition at line 568 of file hashtablebase.inl.

◆ pointer

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

using pointer = TConstOrMutable*

private

Implementation of std::iterator_traits.

Definition at line 571 of file hashtablebase.inl.

◆ reference

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

using reference = TConstOrMutable&

private

Implementation of std::iterator_traits.

Definition at line 572 of file hashtablebase.inl.

◆ value_type

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

using value_type = TConstOrMutable

private

Implementation of std::iterator_traits.

Definition at line 569 of file hashtablebase.inl.

Field Details:

◆ bucketIdx

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

uinteger bucketIdx

protected

The index of the bucket that this iterator works on.

Definition at line 579 of file hashtablebase.inl.

◆ element

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

Element* element

protected

The pointer to the actual element.

Definition at line 576 of file hashtablebase.inl.

Constructor(s) / Destructor Details::

◆ TLocalIterator() [1/4]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TLocalIterator ( )

inline

Default constructor.

Definition at line 583 of file hashtablebase.inl.

◆ TLocalIterator() [2/4]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TLocalIterator ( const TLocalIterator< TConstOrMutable > & other )

default

Copy constructor (default).

Parameters

other The iterator to assign from.

◆ TLocalIterator() [3/4]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

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

◆ TLocalIterator() [4/4]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TLocalIterator	(	uinteger	pBucketIdx,
		Element *	pElement )

inlineexplicit

Constructor.

Parameters

pBucketIdx	Index of the bucket this iterator works on.
pElement	Pointer to current element.

Definition at line 609 of file hashtablebase.inl.

Method Details:

◆ Key()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

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 685 of file hashtablebase.inl.

Here is the call graph for this function:

◆ Mapped()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

template<typename TEnableIf = TMapped>

Mapped ( ) const

inline

Retrieves 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 701 of file hashtablebase.inl.

Here is the call graph for this function:

◆ operator!=()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

bool operator!= ( TLocalIterator< 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 652 of file hashtablebase.inl.

◆ operator*()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TConstOrMutable & operator* ( ) const

inline

Retrieves the stored object that this iterator references.

Returns: A reference to the stored object.

Definition at line 661 of file hashtablebase.inl.

◆ operator++() [1/2]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TLocalIterator & operator++ ( )

inline

Prefix increment operator.

Returns: A reference to this object.

Definition at line 623 of file hashtablebase.inl.

◆ operator++() [2/2]

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TLocalIterator operator++ ( int )

inline

Postfix increment operator.

Returns: An iterator value that is not increased, yet.

Definition at line 632 of file hashtablebase.inl.

Here is the call graph for this function:

◆ operator->()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

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 669 of file hashtablebase.inl.

◆ operator=()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

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

default

Copy assignment (default).

Parameters

other The iterator to assign from.

Returns: A reference to this object.

◆ operator==()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

bool operator== ( TLocalIterator< 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 643 of file hashtablebase.inl.

◆ Value()

template<typename T , typename TStored , typename TKey , typename TIfMapped , typename THash , typename TEqual , typename TAccess , lang::Caching THashCaching, typename TRecycling >

template<typename TConstOrMutable >

TConstOrMutable & Value ( ) const

inline

Retrieves the stored object that this iterator references.

Returns: A reference to the stored object.

Definition at line 677 of file hashtablebase.inl.

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

hashtablebase.inl

Description:

Public Method Index:

Type Definition Details:

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Field Details:

◆ bucketIdx

◆ element

Constructor(s) / Destructor Details::

◆ TLocalIterator() [1/4]

◆ TLocalIterator() [2/4]

◆ TLocalIterator() [3/4]

◆ TLocalIterator() [4/4]

Method Details:

◆ Key()

◆ Mapped()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->()

◆ operator=()

◆ operator==()

◆ Value()