[#BloombergLP-bslalg-DequeIterator-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslalg.adoc[bslalg]::xref:BloombergLP/bslalg/DequeIterator-0d.adoc[DequeIterator]<VALUE_TYPE, 1>
:relfileprefix: ../../
:mrdocs:

`DequeIterator` specialization for a single element per block.

== Synopsis

Declared in `<bslalg_dequeiterator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class VALUE_TYPE>
class xref:BloombergLP/bslalg/DequeIterator-0d.adoc[DequeIterator]<VALUE_TYPE, 1>;
----

== Description

This partial specialization of `DequeIterator` for the case when there is a single element per block uses simpler storage and a simpler implementation. The contract for all functions is the same, and so not repeated.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslalg/DequeIterator-01/2constructor-0f.adoc[`DequeIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslalg/DequeIterator-01/blockBegin.adoc[`blockBegin`] 
| Return the address of the first element in the block pointed to by this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/blockEnd.adoc[`blockEnd`] 
| Return the address of (one‐past) the last element in the block pointed to by this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/blockPtr.adoc[`blockPtr`] 
| Return the address of the block pointer for this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/nextBlock.adoc[`nextBlock`] 
| Set this iterator to point to the first element of the next block.
| xref:BloombergLP/bslalg/DequeIterator-01/offsetInBlock.adoc[`offsetInBlock`] 
| Return the offset of the element pointed to by this iterator, from the beginning of the block containing it.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_star.adoc[`operator*`] 
| Return a reference to the element pointed to by this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_plus.adoc[`operator+`] 
| Return an iterator pointing the element at the specified `offset` after this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_inc.adoc[`operator++`] 
| Increment this iterator to the next element in the deque.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_plus_eq.adoc[`operator+=`] 
| Advance this iterator by the specified `offset`.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_minus-0e.adoc[`operator‐`] 
| Subtraction operators
| xref:BloombergLP/bslalg/DequeIterator-01/operator_dec.adoc[`operator‐‐`] 
| Decrement this iterator to the previous element in the deque.
| xref:BloombergLP/bslalg/DequeIterator-01/operator_minus_eq.adoc[`operator‐=`] 
| Move this iterator backward by the specified `offset`.
| xref:BloombergLP/bslalg/DequeIterator-01/previousBlock.adoc[`previousBlock`] 
| Set this iterator to point to the first (not the last) element of the previous block.
| xref:BloombergLP/bslalg/DequeIterator-01/remainingInBlock.adoc[`remainingInBlock`] 
| Return how many elements remain in this block from the current position.
| xref:BloombergLP/bslalg/DequeIterator-01/setBlock.adoc[`setBlock`] 
| Set this iterator to point to the first element of the block pointed to by the specified `blockPtrPtr`.
| xref:BloombergLP/bslalg/DequeIterator-01/valuePtr.adoc[`valuePtr`] 
| Return the address of the parameterized `VALUE_TYPE` object pointed to by this iterator.
| xref:BloombergLP/bslalg/DequeIterator-01/valuePtrDecrement.adoc[`valuePtrDecrement`] 
| Decrement the value pointer within the current block.
| xref:BloombergLP/bslalg/DequeIterator-01/valuePtrIncrement.adoc[`valuePtrIncrement`] 
| Increment the value pointer within the current block.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslalg/operator_3way-0a1.adoc[BloombergLP::bslalg::operator<=>]`
| Return the result of comparing the block pointers of the specified `lhs` and `rhs` iterators.
| `xref:BloombergLP/bslalg/operator_eq-0c.adoc[BloombergLP::bslalg::operator==]`
| Return `true` if `lhs` and `rhs` point to the same element.
|===


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