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

Random‐access const iterator over a `PackedIntArray`.

== Synopsis

Declared in `<bdlc_packedintarray.h>`

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

== Description

This unconstrained (value‐semantic) class represents a random access iterator providing non‐modifiable access to the elements of a `PackedIntArray`. This class provides all functionality of a random access iterator, as defined by the standard, but is _not_ compatible with most standard methods requiring a bidirectional const_iterator.

This class does not perform any bounds checking. The returned iterator, `it`, referencing an element within a `PackedIntArray`, `array`, remains valid while `0 <= it ‐ array.begin() < array.length()`.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/difference_type.adoc[`difference_type`] 
| Iterator difference type.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/pointer.adoc[`pointer`] 
| Iterator pointer type.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/reference.adoc[`reference`] 
| Iterator reference type.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/size_type.adoc[`size_type`] 
| Iterator size type.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/value_type.adoc[`value_type`] 
| Iterator value type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/2constructor-00.adoc[`PackedIntArrayConstIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_assign.adoc[`operator=`] 
| Assign to this iterator the value of the specified `rhs` iterator.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_star.adoc[`operator*`] 
| Return the element value referenced by this iterator.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_plus.adoc[`operator+`] 
| Return an iterator at the specified `offset` from this iterator.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_inc.adoc[`operator++`] 
| Advance this iterator to the next element and return `*this`.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_plus_eq.adoc[`operator+=`] 
| Advance this iterator by the specified `offset`.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_minus.adoc[`operator‐`] 
| Return an iterator at the negated specified `offset` from this iterator.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_dec.adoc[`operator‐‐`] 
| Decrement this iterator to the previous element and return `*this`.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_minus_eq.adoc[`operator‐=`] 
| Decrement this iterator by the specified `offset`.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_ptr.adoc[`operator‐>`] 
| Return the element value referenced by this iterator.
| xref:BloombergLP/bdlc/PackedIntArrayConstIterator/operator_subs.adoc[`operator[]`] 
| Return the element at the specified `offset` from this iterator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlc/operator_ge-0e.adoc[BloombergLP::bdlc::operator>=<>]`
| Return whether the left iterator follows or equals the right (see free `operator>=`).
| `xref:BloombergLP/bdlc/operator_gt-0d.adoc[BloombergLP::bdlc::operator><>]`
| Return whether the left iterator follows the right (see free `operator>`).
| `xref:BloombergLP/bdlc/operator_le-08.adoc[BloombergLP::bdlc::operator<=<>]`
| Return whether the left iterator precedes or equals the right (see free `operator<=`).
| `xref:BloombergLP/bdlc/operator_lt-02b.adoc[BloombergLP::bdlc::operator<<>]`
| Return whether the left iterator precedes the right (see free `operator<`).
| `xref:BloombergLP/bdlc/operator_minus-05.adoc[BloombergLP::bdlc::operator‐<>]`
| Return the signed distance between two iterators (see free `operator‐`).
| `xref:BloombergLP/bdlc/operator_not_eq-0a.adoc[BloombergLP::bdlc::operator!=<>]`
| Return whether the iterators refer to different positions (see free `operator!=`).
| `xref:BloombergLP/bdlc/operator_eq-06.adoc[BloombergLP::bdlc::operator==<>]`
| Return whether the iterators refer to the same position (see free `operator==`).
| `xref:BloombergLP/bdlc/operator_dec-0b.adoc[BloombergLP::bdlc::operator‐‐<>]`
| Decrement `iter` and return its prior value (see free `operator‐‐`).
| `xref:BloombergLP/bdlc/operator_inc-06.adoc[BloombergLP::bdlc::operator++<>]`
| Advance `iter` and return its prior value (see free `operator++`).
| `xref:BloombergLP/bdlc/PackedIntArray-0b.adoc[BloombergLP::bdlc::PackedIntArray]`
| Space‐efficient value‐semantic array of packed `TYPE` integers.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlc/operator_not_eq-02.adoc[`operator!=`]
| Return `true` if `lhs` and `rhs` refer to different positions.
| xref:BloombergLP/bdlc/operator_inc-01.adoc[`operator++`]
| Advance `iter` and return its prior value.
| xref:BloombergLP/bdlc/operator_minus-09.adoc[`operator‐`]
| Return the number of elements between `lhs` and `rhs`.
| xref:BloombergLP/bdlc/operator_dec-06.adoc[`operator‐‐`]
| Post‐decrement the specified iterator `iter`.
| xref:BloombergLP/bdlc/operator_lt-02e.adoc[`operator<`]
| Return true if `lhs` precedes `rhs` in the referenced array.
| xref:BloombergLP/bdlc/operator_le-06.adoc[`operator<=`]
| Return `true` if `lhs` precedes or equals `rhs`.
| xref:BloombergLP/bdlc/operator_eq-0a.adoc[`operator==`]
| Return `true` if `lhs` and `rhs` refer to the same position.
| xref:BloombergLP/bdlc/operator_gt-08.adoc[`operator>`]
| Return true if `lhs` follows `rhs` in the referenced array.
| xref:BloombergLP/bdlc/operator_ge-00.adoc[`operator>=`]
| Return `true` if `lhs` follows or equals `rhs`.
|===


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