[#BloombergLP-bsltf-InputIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsltf.adoc[bsltf]::InputIterator
:relfileprefix: ../../
:mrdocs:

== Synopsis

Declared in `<bsltf_inputiterator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
class InputIterator;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/InputIterator/difference_type.adoc[`difference_type`] 
| Alias for `std::ptrdiff_t`.
| xref:BloombergLP/bsltf/InputIterator/iterator_category.adoc[`iterator_category`] 
| Alias for `std::input_iterator_tag`.
| xref:BloombergLP/bsltf/InputIterator/pointer.adoc[`pointer`] 
| Alias for a pointer to `TYPE`.
| xref:BloombergLP/bsltf/InputIterator/reference.adoc[`reference`] 
| Alias for a reference to `TYPE`.
| xref:BloombergLP/bsltf/InputIterator/value_type.adoc[`value_type`] 
| Alias for the iterated `TYPE`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/InputIterator/2constructor-02.adoc[`InputIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bsltf/InputIterator/operator_star.adoc[`operator*`] 
| Return a const reference to the `TYPE` object referred to by this iterator. The behavior is undefined if this iterator is empty.
| xref:BloombergLP/bsltf/InputIterator/operator_inc-00b.adoc[`operator++`] 
| Increment operators
| xref:BloombergLP/bsltf/InputIterator/operator_ptr.adoc[`operator‐>`] 
| Return a pointer to the `TYPE` object referred to by this iterator. The behavior is undefined if this iterator is empty.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bsltf/operator_not_eq-060.adoc[BloombergLP::bsltf::operator!=]`
| Return `true` if the specified iterators do not refer to the same underlying position, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_eq-05b.adoc[BloombergLP::bsltf::operator==]`
| Return `true` if the specified iterators refer to the same underlying position, and `false` otherwise.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/operator_not_eq-0bdd.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not refer to the same `TYPE` object and `false` othersise.
| xref:BloombergLP/bsltf/operator_eq-0cb.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` refer to the same `TYPE` object and `false` othersise.
|===


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