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

== Synopsis

Declared in `&lt;bsltf&lowbar;inputiterator&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class TYPE&gt;
class InputIterator;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/InputIterator/difference_type.adoc[`difference&lowbar;type`] 
| Alias for `std&colon;&colon;ptrdiff&lowbar;t`&period;
| xref:BloombergLP/bsltf/InputIterator/iterator_category.adoc[`iterator&lowbar;category`] 
| Alias for `std&colon;&colon;input&lowbar;iterator&lowbar;tag`&period;
| xref:BloombergLP/bsltf/InputIterator/pointer.adoc[`pointer`] 
| Alias for a pointer to `TYPE`&period;
| xref:BloombergLP/bsltf/InputIterator/reference.adoc[`reference`] 
| Alias for a reference to `TYPE`&period;
| xref:BloombergLP/bsltf/InputIterator/value_type.adoc[`value&lowbar;type`] 
| Alias for the iterated `TYPE`&period;
|===


== 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&ast;`] 
| Return a const reference to the `TYPE` object referred to by this iterator&period; The behavior is undefined if this iterator is empty&period;
| xref:BloombergLP/bsltf/InputIterator/operator_inc-00b.adoc[`operator&plus;&plus;`] 
| Increment operators
| xref:BloombergLP/bsltf/InputIterator/operator_ptr.adoc[`operator&hyphen;&gt;`] 
| Return a pointer to the `TYPE` object referred to by this iterator&period; The behavior is undefined if this iterator is empty&period;
|===


== Friends

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

== Non-Member Functions

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


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