Description:

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>
template<typename TConstOrMutable>
class alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, 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 template parameter T.

Definition at line 428 of file hashtablebase.inl.

Public Method Index:
	TLocalIterator ()
	Default constructor.

	TLocalIterator (const TLocalIterator &other)=default

template<typename TMutable> requires std::same_as<TMutable, TLocalIterator<T>>
	TLocalIterator (const TMutable &mutableIt)

	TLocalIterator (uinteger pBucketIdx, Element *pElement)

const TKey &	Key () const

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

Protected Field Index:
uinteger	bucketIdx
	The index of the bucket that this iterator works on.

Element *	element
	The pointer to the actual element.

Private Type Index:
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	value_type = TConstOrMutable
	Implementation of `std::iterator_traits`.

Type Definition Details:

◆ difference_type

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

using alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::difference_type = integer

private

Implementation of std::iterator_traits.

Definition at line 437 of file hashtablebase.inl.

◆ iterator_category

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

using alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::iterator_category = std::forward_iterator_tag

private

Implementation of std::iterator_traits.

Definition at line 435 of file hashtablebase.inl.

◆ pointer

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

using alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::pointer = TConstOrMutable*

private

Implementation of std::iterator_traits.

Definition at line 438 of file hashtablebase.inl.

◆ reference

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

using alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::reference = TConstOrMutable&

private

Implementation of std::iterator_traits.

Definition at line 439 of file hashtablebase.inl.

◆ value_type

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

using alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::value_type = TConstOrMutable

private

Implementation of std::iterator_traits.

Definition at line 436 of file hashtablebase.inl.

Field Details:

◆ bucketIdx

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

uinteger alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::bucketIdx

protected

The index of the bucket that this iterator works on.

Definition at line 446 of file hashtablebase.inl.

◆ element

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

Element* alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::element

protected

The pointer to the actual element.

Definition at line 443 of file hashtablebase.inl.

Constructor(s) / Destructor Details:

◆ TLocalIterator() [1/4]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::TLocalIterator ( )

inline

Default constructor.

Definition at line 450 of file hashtablebase.inl.

◆ TLocalIterator() [2/4]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::TLocalIterator ( const TLocalIterator< TConstOrMutable > & other )

default

Copy constructor (default).

Parameters

other The iterator to assign from.

Here is the call graph for this function:

◆ TLocalIterator() [3/4]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

template<typename TMutable>
requires std::same_as<TMutable, TLocalIterator<T>>

alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::TLocalIterator ( const TMutable & mutableIt )

inline

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.

Definition at line 463 of file hashtablebase.inl.

◆ TLocalIterator() [4/4]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< 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 470 of file hashtablebase.inl.

Method Details:

◆ Key()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

const TKey & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::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 546 of file hashtablebase.inl.

◆ Mapped()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TMapped & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::Mapped ( ) const

inline

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

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

Definition at line 555 of file hashtablebase.inl.

◆ operator!=()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

bool alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::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 513 of file hashtablebase.inl.

Here is the call graph for this function:

◆ operator*()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TConstOrMutable & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::operator* ( ) const

inline

Retrieves the stored object that this iterator references.

Returns: A reference to the stored object.

Definition at line 522 of file hashtablebase.inl.

◆ operator++() [1/2]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TLocalIterator & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::operator++ ( )

inline

Prefix increment operator.

Returns: A reference to this object.

Definition at line 484 of file hashtablebase.inl.

Here is the call graph for this function:

◆ operator++() [2/2]

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TLocalIterator alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::operator++ ( int )

inline

Postfix increment operator.

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

Definition at line 493 of file hashtablebase.inl.

Here is the call graph for this function:

◆ operator->()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TConstOrMutable * alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< 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 530 of file hashtablebase.inl.

◆ operator=()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TLocalIterator & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::operator= ( const TLocalIterator< TConstOrMutable > & other )

default

Copy assignment (default).

Parameters

other The iterator to assign from.

Returns: A reference to this object.

Here is the call graph for this function:

◆ operator==()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

bool alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::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 504 of file hashtablebase.inl.

Here is the call graph for this function:

◆ Value()

template<typename TAllocator, typename TValueDescriptor, typename THash, typename TEqual, lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable>

TConstOrMutable & alib::containers::detail::HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable >::Value ( ) const

inline

Retrieves the stored object that this iterator references.

Returns: A reference to the stored object.

Definition at line 538 of file hashtablebase.inl.

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

hashtablebase.inl

Description:

Public Method Index:

Protected Field Index:

Private Type 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()