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

== Synopsis

Declared in `<bslstl_hashtableiterator.h>`

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

== 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, and a return a reference providing modifiable access to this object.
| xref:BloombergLP/bslstl/HashTableIterator/node.adoc[`node`] 
| Return the address of the node at which this iterator is positioned in the list, or 0 if this iterator is positioned after the end of a list. Note that this method is an implementation detail and is not part of the C++ standard.
| xref:BloombergLP/bslstl/HashTableIterator/operator_star.adoc[`operator*`] 
| Return a reference providing modifiable access to the value (of the template parameter `VALUE_TYPE`) of the node at which this iterator is positioned. The behavior is undefined unless the iterator refers to a valid (not yet erased) node the list.
| xref:BloombergLP/bslstl/HashTableIterator/operator_inc.adoc[`operator++`] 
| Move this iterator to the next node in the list and return a reference providing modifiable access to this iterator. The behavior is undefined unless the iterator refers to a valid (not yet erased) node in the list.
| xref:BloombergLP/bslstl/HashTableIterator/operator_ptr.adoc[`operator‐>`] 
| Return the address of the value (of the template parameter `VALUE_TYPE`) of the element at which this iterator is positioned. The behavior is undefined unless the iterator refers to a valid (not yet erased) node the list.
|===


== 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 the specified `lhs` and the specified `rhs` iterators do not have the same value and `false` otherwise. Two iterators do not have the same value if they refer to the different nodes in the same list, or if either (but not both) of the iterators are at the past‐the‐end position of the tree.
| xref:BloombergLP/bslstl/operator_inc-0d3.adoc[`operator++`]
| Move the specified `iter` to the next node in the list and return value of `iter` prior to this call. The behavior is undefined unless `iter` refers to a valid (not yet erased) node a the list.
| 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 the specified `lhs` and the specified `rhs` iterators have the same value and `false` otherwise. Two iterators have the same value if they refer to the same node in the same list, or if both iterators are at the past‐the‐end position of the tree.
|===


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