[#BloombergLP-bslstl-HashTableIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::HashTableIterator
:relfileprefix: ../../
:mrdocs:

STL‐conforming forward iterator over hash‐table node lists.

== Synopsis

Declared in `<bslstl_hashtableiterator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class VALUE_TYPE,
    class DIFFERENCE_TYPE>
class HashTableIterator;
----

== Description

This class template implements an in‐core value‐semantic type that is an standard‐conforming forward iterator (see section 24.2.5 [forward.iterators]of the C++11 standard) over a list of `bslalg::BidirectionalLink` objects. A `HashTableIterator` object provides access to values of the (template parameter) `VALUE_TYPE`, stored in a hash table composed of `bslalg::BidirectionalLink` nodes. The (template parameter) `DIFFERENCE_TYPE` determines the standard mandated `difference_type` of the iterator, without requiring access to the allocator‐traits for the node.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/HashTableIterator/difference_type.adoc[`difference_type`] 
| Iterator difference type.
| xref:BloombergLP/bslstl/HashTableIterator/iterator_category.adoc[`iterator_category`] 
| Standard iterator defined types [24.4.2].
| xref:BloombergLP/bslstl/HashTableIterator/pointer.adoc[`pointer`] 
| This `typedef` is an alias to `VALUE_TYPE *`.
| xref:BloombergLP/bslstl/HashTableIterator/reference.adoc[`reference`] 
| This `typedef` is an alias to `VALUE_TYPE&`.
| xref:BloombergLP/bslstl/HashTableIterator/value_type.adoc[`value_type`] 
| This `typedef` is an alias to the non‐`const` form of `VALUE_TYPE`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/HashTableIterator/2constructor-0e.adoc[`HashTableIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslstl/HashTableIterator/2destructor.adoc[`~HashTableIterator`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bslstl/HashTableIterator/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object.
| xref:BloombergLP/bslstl/HashTableIterator/node.adoc[`node`] 
| Return the address of the node at this iterator's position.
| xref:BloombergLP/bslstl/HashTableIterator/operator_star.adoc[`operator*`] 
| Return a reference to the value at this iterator's position.
| xref:BloombergLP/bslstl/HashTableIterator/operator_inc.adoc[`operator++`] 
| Advance this iterator to the next node in the list.
| xref:BloombergLP/bslstl/HashTableIterator/operator_ptr.adoc[`operator‐>`] 
| Return the address of the value at this iterator's position.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/operator_not_eq-02.adoc[`operator!=`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_not_eq-062ee.adoc[`operator!=`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_not_eq-067.adoc[`operator!=`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_not_eq-0a6.adoc[`operator!=`]
| Return `true` if `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bslstl/operator_inc-0d3.adoc[`operator++`]
| Advance `iter` to the next node and return its previous value.
| xref:BloombergLP/bslstl/operator_eq-03.adoc[`operator==`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_eq-06e.adoc[`operator==`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_eq-07.adoc[`operator==`]
| Same as the preceding overload.
| xref:BloombergLP/bslstl/operator_eq-09.adoc[`operator==`]
| Return `true` if `lhs` and `rhs` have the same value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#