HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TLocalIterator< TConstOrMutable > Class Template Reference

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

Public Method Index:
	TLocalIterator ()
	Default constructor.
	TLocalIterator (const TLocalIterator &other)=default
TMutable	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 difference_type = integer

private

Implementation of std::iterator_traits.

Definition at line 457 of file hashtablebase.inl.

iterator_category

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

template<typename TConstOrMutable >

using iterator_category = std::forward_iterator_tag

private

Implementation of std::iterator_traits.

Definition at line 455 of file hashtablebase.inl.

pointer

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

template<typename TConstOrMutable >

using pointer = TConstOrMutable*

private

Implementation of std::iterator_traits.

Definition at line 458 of file hashtablebase.inl.

reference

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

template<typename TConstOrMutable >

using reference = TConstOrMutable&

private

Implementation of std::iterator_traits.

Definition at line 459 of file hashtablebase.inl.

value_type

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

template<typename TConstOrMutable >

using value_type = TConstOrMutable

private

Implementation of std::iterator_traits.

Definition at line 456 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 bucketIdx

protected

The index of the bucket that this iterator works on.

Definition at line 466 of file hashtablebase.inl.

element

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

template<typename TConstOrMutable >

Element* element

protected

The pointer to the actual element.

Definition at line 463 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 >

TLocalIterator ( )

inline

Default constructor.

Definition at line 470 of file hashtablebase.inl.

TLocalIterator() [2/4]

template<typename TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling TRecycling>

template<typename TConstOrMutable >

TMutable 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 TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 494 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 & 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 570 of file hashtablebase.inl.

Mapped()

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

template<typename TConstOrMutable >

TMapped & 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 579 of file hashtablebase.inl.

operator!=()

template<typename TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 537 of file hashtablebase.inl.

operator*()

template<typename TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 546 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 & operator++ ( )

inline

Prefix increment operator.

Returns

A reference to this object.

Definition at line 508 of file hashtablebase.inl.

operator++() [2/2]

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

template<typename TConstOrMutable >

TLocalIterator operator++ ( int )

inline

Postfix increment operator.

Returns

An iterator value that is not increased, yet.

Definition at line 517 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 * operator-> ( ) const

inline

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

Returns

A pointer to the stored object.

Definition at line 554 of file hashtablebase.inl.

operator=()

template<typename TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 528 of file hashtablebase.inl.

Value()

template<typename TAllocator , typename TValueDescriptor , typename THash , typename TEqual , lang::Caching THashCaching, Recycling 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 562 of file hashtablebase.inl.

---

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

• hashtablebase.inl