[#BloombergLP-bdlc-IndexClerkIter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlc.adoc[bdlc]::IndexClerkIter
:relfileprefix: ../../
:mrdocs:

In‐core value‐semantic iterator over decommissioned indices of an `IndexClerk`.

== Synopsis

Declared in `<bdlc_indexclerk.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class IndexClerkIter;
----

== Description

This class defines an in‐core value‐semantic iterator providing sequential read‐only access to the decommissioned indices of a `IndexClerk`. The order of iteration is implementation dependent.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlc/IndexClerkIter/2constructor-0b1.adoc[`IndexClerkIter`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlc/IndexClerkIter/operator_assign.adoc[`operator=`] 
| Assign to this iterator the value of the specified `rhs` iterator.
| xref:BloombergLP/bdlc/IndexClerkIter/operator_star.adoc[`operator*`] 
| Return the decommissioned index to which this iterator refers.
| xref:BloombergLP/bdlc/IndexClerkIter/operator_inc.adoc[`operator++`] 
| Increment this iterator to the next decommissioned index.
| xref:BloombergLP/bdlc/IndexClerkIter/operator_dec.adoc[`operator‐‐`] 
| Decrement this iterator to the previous decommissioned index.
| xref:BloombergLP/bdlc/IndexClerkIter/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<IndexClerkIter, IsBitwiseCopyable>`] 
| Declare that this type is bitwise copyable.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlc/operator_not_eq-09.adoc[BloombergLP::bdlc::operator!=]`
| Return `true` if `lhs` and `rhs` do not have the same value, and `false` otherwise.
| `xref:BloombergLP/bdlc/operator_eq-05.adoc[BloombergLP::bdlc::operator==]`
| Return `true` if `lhs` and `rhs` have the same value, and `false` otherwise.
|===


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