HashTableBase< TAllocator, TValueDescriptor, THash, TEqual, THashCaching, TRecycling >::TIterator< 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 >::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 232 of file hashtablebase.inl.

Public Method Index:
	TIterator ()=default
	Default constructor. Keeps everything uninitialized.
	TIterator (const TIterator &other)=default
TMutable	TIterator (const TMutable &mutableIt)
const TKey &	Key () const
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 Field Index:
uinteger	bucketIdx
	The actual bucket index.
Element *	element
	The pointer to the actual element.
THashtable *	table
	The pointer to the hash table.

Protected Method Index:
	TIterator (THashtable *pTable, uinteger pBbucketIx)
	TIterator (THashtable *pTable, uinteger pBbucketIx, Element *pElement)
void	repair ()
	Moves an iterator with a nulled element pointer to the next 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	THashtable
	Const or mutable version of HashTableBase.
using	value_type = TMapped
	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 244 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 242 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 245 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 246 of file hashtablebase.inl.

THashtable

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

template<typename TConstOrMutable >

using THashtable

private

Initial value:

 ATMP_IF_T_F( !ATMP_IS_CONST(TConstOrMutable),       HashTableBase,
                                                                         const HashTableBase  )

Const or mutable version of HashTableBase.

Definition at line 240 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 = TMapped

private

Implementation of std::iterator_traits.

Definition at line 243 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 actual bucket index.

Definition at line 253 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 256 of file hashtablebase.inl.

table

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

template<typename TConstOrMutable >

THashtable* table

protected

The pointer to the hash table.

Definition at line 250 of file hashtablebase.inl.

Constructor(s) / Destructor Details:

TIterator() [1/4]

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

template<typename TConstOrMutable >

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

TIterator() [2/4]

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

template<typename TConstOrMutable >

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

TIterator() [3/4]

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

template<typename TConstOrMutable >

TIterator ( const TIterator< TConstOrMutable > & other )

default

Copy constructor (default).

Parameters

other

The iterator to assign from.

TIterator() [4/4]

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

template<typename TConstOrMutable >

TMutable 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.

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 418 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 mapped-portion of 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 427 of file hashtablebase.inl.

operator!=()

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

template<typename TConstOrMutable >

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

operator++() [1/2]

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

template<typename TConstOrMutable >

TIterator & operator++ ( )

inline

Prefix increment operator.

Returns

A reference to this object.

Definition at line 340 of file hashtablebase.inl.

operator++() [2/2]

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

template<typename TConstOrMutable >

TIterator operator++ ( int )

inline

Postfix increment operator.

Returns

An iterator value that is not increased, yet.

Definition at line 365 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 402 of file hashtablebase.inl.

operator=()

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

template<typename TConstOrMutable >

TIterator & operator= ( const TIterator< 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== ( 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 376 of file hashtablebase.inl.

repair()

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

template<typename TConstOrMutable >

void repair ( )

inlineprotected

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

Definition at line 293 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 410 of file hashtablebase.inl.

---

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

• hashtablebase.inl