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

This class provides a container to store values of the (template parameter) type `VALUE`, and also provides the iterators to access the values. The iterators are designed to conform to a standard input iterator, and report any misuse of the iterator.

== Synopsis

Declared in `<bsltf_testvaluesarray.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class VALUE,
    class ALLOCATOR = xref:bsl/allocator-0df.adoc[bsl::allocator<VALUE>],
    class CONVERTER = xref:BloombergLP/bsltf/TestValuesArray_DefaultConverter.adoc[TestValuesArray_DefaultConverter<VALUE, ALLOCATOR>],
    bool USE_SENTINEL = false>
class TestValuesArray;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/TestValuesArray/ConstEndReturnType.adoc[`ConstEndReturnType`] 
| Alias for the type returned by `end() const`; either `const_sentinel` or `const_iterator` depending on `USE_SENTINEL`.
| xref:BloombergLP/bsltf/TestValuesArray/EndReturnType.adoc[`EndReturnType`] 
| Alias for the type returned by `end()`; either `sentinel` or `iterator` depending on `USE_SENTINEL`.
| xref:BloombergLP/bsltf/TestValuesArray/const_iterator.adoc[`const_iterator`] 
| Alias for the const input iterator over this container.
| xref:BloombergLP/bsltf/TestValuesArray/const_sentinel.adoc[`const_sentinel`] 
| Alias for the const end sentinel for this container.
| xref:BloombergLP/bsltf/TestValuesArray/iterator.adoc[`iterator`] 
| Alias for the mutable input iterator over this container.
| xref:BloombergLP/bsltf/TestValuesArray/sentinel.adoc[`sentinel`] 
| Alias for the mutable end sentinel for this container.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/TestValuesArray/2constructor-02.adoc[`TestValuesArray`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bsltf/TestValuesArray/2destructor.adoc[`~TestValuesArray`] [.small]#[destructor]#
| Destroy this container and all contained elements.
| xref:BloombergLP/bsltf/TestValuesArray/begin-011.adoc[`begin`] 
| Return an iterator providing non‐modifiable access to the first `VALUE` object in the sequence of `VALUE` objects maintained by this container, or the `end` iterator if this container is empty.
| xref:BloombergLP/bsltf/TestValuesArray/data.adoc[`data`] 
| Return the address of the non‐modifiable first element in this container.
| xref:BloombergLP/bsltf/TestValuesArray/end-00.adoc[`end`] 
| `end` overloads
| xref:BloombergLP/bsltf/TestValuesArray/index.adoc[`index`] 
| Return an iterator to the element at the specified `position`. The behavior is undefined unless `position <= size()`.
| xref:BloombergLP/bsltf/TestValuesArray/operator_subs.adoc[`operator[]`] 
| Return a reference providing non‐modifiable access to the element at the specified `index`. The behavior is undefined unless `0 < size() && index < size()`.
| xref:BloombergLP/bsltf/TestValuesArray/privateEnd-0d.adoc[`privateEnd`] 
| `privateEnd` overloads
| xref:BloombergLP/bsltf/TestValuesArray/resetIterators.adoc[`resetIterators`] 
| Make all iterators dereferenceable and comparable again.
| xref:BloombergLP/bsltf/TestValuesArray/size.adoc[`size`] 
| Return number of elements in this container.
|===



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