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

Container of test values exposing misuse&hyphen;detecting input iterators&period;

== Synopsis

Declared in `&lt;bsltf&lowbar;testvaluesarray&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class VALUE,
    class ALLOCATOR = xref:bsl/allocator-0df.adoc[bsl::allocator&lt;VALUE&gt;],
    class CONVERTER = xref:BloombergLP/bsltf/TestValuesArray_DefaultConverter.adoc[TestValuesArray&lowbar;DefaultConverter&lt;VALUE, ALLOCATOR&gt;],
    bool USE&lowbar;SENTINEL = false&gt;
class TestValuesArray;
----

== Description

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

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/TestValuesArray/2constructor-02.adoc[`TestValuesArray`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bsltf/TestValuesArray/2destructor.adoc[`&#126;TestValuesArray`] [.small]#[destructor]#
| Destroy this container and all contained elements&period;
| xref:BloombergLP/bsltf/TestValuesArray/begin-011.adoc[`begin`] 
| Return an iterator to the first element, or `end` if empty&period;
| xref:BloombergLP/bsltf/TestValuesArray/data.adoc[`data`] 
| Return the address of the non&hyphen;modifiable first element in this container&period;
| 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`&period; The behavior is undefined unless `position &lt;&equals; size()`&period;
| xref:BloombergLP/bsltf/TestValuesArray/operator_subs.adoc[`operator&lsqb;&rsqb;`] 
| Return a reference providing non&hyphen;modifiable access to the element at the specified `index`&period; The behavior is undefined unless `0 &lt; size() &amp;&amp; index &lt; size()`&period;
| xref:BloombergLP/bsltf/TestValuesArray/privateEnd-0d.adoc[`privateEnd`] 
| `privateEnd` overloads
| xref:BloombergLP/bsltf/TestValuesArray/resetIterators.adoc[`resetIterators`] 
| Make all iterators dereferenceable and comparable again&period;
| xref:BloombergLP/bsltf/TestValuesArray/size.adoc[`size`] 
| Return number of elements in this container&period;
|===



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