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

This class provide a STL‐conforming input iterator over values used for testing (see section [24.2.3 input.iterators]of the C++11 standard. A `TestValuesArrayIterator` provide access to elements of parameterized type `VALUE`. An iterator is considered dereferenceable all of the following are satisfied: 1. The iterator refers to a valid element (not `end`). 2. The iterator has not been dereferenced. 3. The iterator is not a copy of another iterator of which `operator++` have been invoked. An iterator is comparable if the iterator is not a copy of another iterator of which `operator++` have been invoked.

== Synopsis

Declared in `<bsltf_testvaluesarray.h>`

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

== Description

This class is _not_ thread‐safe: different iterator objects manipulate shared state without synchronization. This is rarely a concern for the test scenarios supported by this component.

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/TestValuesArrayIterator/2constructor-05.adoc[`TestValuesArrayIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bsltf/TestValuesArrayIterator/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `other` object. The behavior is undefined unless `other` is valid.
| xref:BloombergLP/bsltf/TestValuesArrayIterator/address.adoc[`address`] 
| Return the position (address) referenced by this iterator.
| xref:BloombergLP/bsltf/TestValuesArrayIterator/operator_star.adoc[`operator*`] 
| Return the value referred to by this object. This object is no longer dereferenceable after a call to this function. The behavior is undefined unless this iterator is dereferenceable.
| xref:BloombergLP/bsltf/TestValuesArrayIterator/operator_inc-0a.adoc[`operator++`] 
| Increment operators
| xref:BloombergLP/bsltf/TestValuesArrayIterator/operator_ptr.adoc[`operator‐>`] 
| Return the address of the element (of the template parameter `VALUE`) at which this iterator is positioned. The behavior is undefined unless this iterator is dereferenceable.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bsltf/operator_not_eq-051.adoc[BloombergLP::bsltf::operator!=]`
| Return `true` if the specified sentinel and iterator do _not_ refer to the same element, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_not_eq-069.adoc[BloombergLP::bsltf::operator!=]`
| Return `true` if the specified iterator and sentinel do _not_ refer to the same element, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_eq-0f3.adoc[BloombergLP::bsltf::operator==]`
| Return `true` if the specified sentinel and iterator refer to the same element, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_eq-0849.adoc[BloombergLP::bsltf::operator==]`
| Return `true` if the specified iterator and sentinel refer to the same element, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_not_eq-028.adoc[BloombergLP::bsltf::operator!=]`
| Return `true` if the specified iterators do _not_ refer to the same element, and `false` otherwise.
| `xref:BloombergLP/bsltf/operator_eq-0a5.adoc[BloombergLP::bsltf::operator==]`
| Return `true` if the specified iterators refer to the same element, and `false` otherwise.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/operator_not_eq-014.adoc[`operator!=`]
| Return `true` if the specified `lhs` and the specified `rhs` do _not_ refer to the same element, and `false` otherwise. The behavior is undefined unless `lhs` and `rhs` are comparable.
| xref:BloombergLP/bsltf/operator_not_eq-0b0.adoc[`operator!=`]
| Return `true` if the specified `lhs` and the specified `rhs` do _not_ refer to the same element, and `false` otherwise. The behavior is undefined unless `lhs` and `rhs` are comparable.
| xref:BloombergLP/bsltf/operator_eq-05f.adoc[`operator==`]
| Return `true` if the specified `lhs` and the specified `rhs` refer to the same element, and `false` otherwise. The behavior is undefined unless `lhs` and `rhs` are comparable.
| xref:BloombergLP/bsltf/operator_eq-08b.adoc[`operator==`]
| Return `true` if the specified `lhs` and the specified `rhs` refer to the same element, and `false` otherwise. The behavior is undefined unless `lhs` and `rhs` are comparable.
|===


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