[#BloombergLP-bdld-DatumIntMapRef]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdld.adoc[bdld]::DatumIntMapRef
:relfileprefix: ../../
:mrdocs:

Read&hyphen;only view of a map of `Datum` values keyed by integers&period;

== Synopsis

Declared in `&lt;bdld&lowbar;datum&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DatumIntMapRef;
----

== Description

This class provides a read&hyphen;only view to a map of datums (an array of `DatumIntMapEntry` objects)&period; It holds the array by a `const` pointer and an integral size value&period; It acts as return value for accessors inside the `Datum` class that return a map of `Datum` objects&period; Note that zero&hyphen;size maps are valid&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumIntMapRef/SizeType.adoc[`SizeType`] 
| Unsigned integral type for capacities, key sizes, and string lengths&period;
| xref:BloombergLP/bdld/DatumIntMapRef/const_iterator.adoc[`const&lowbar;iterator`] 
| Const iterator for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/const_pointer.adoc[`const&lowbar;pointer`] 
| Const pointer to an element&period;
| xref:BloombergLP/bdld/DatumIntMapRef/const_reference.adoc[`const&lowbar;reference`] 
| Const reference to an element&period;
| xref:BloombergLP/bdld/DatumIntMapRef/const_reverse_iterator.adoc[`const&lowbar;reverse&lowbar;iterator`] 
| Const reverse iterator for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/difference_type.adoc[`difference&lowbar;type`] 
| Iterator difference type for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/element_type.adoc[`element&lowbar;type`] 
| Element type for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/iterator.adoc[`iterator`] 
| Iterator for this array reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/pointer.adoc[`pointer`] 
| Pointer to a map entry&period;
| xref:BloombergLP/bdld/DatumIntMapRef/reference.adoc[`reference`] 
| Reference to an element&period;
| xref:BloombergLP/bdld/DatumIntMapRef/reverse_iterator.adoc[`reverse&lowbar;iterator`] 
| Reverse iterator for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/size_type.adoc[`size&lowbar;type`] 
| Size type for this integer map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/value_type.adoc[`value&lowbar;type`] 
| Value type for this integer map reference&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumIntMapRef/2constructor.adoc[`DatumIntMapRef`]         [.small]#[constructor]#
| Create an integer&hyphen;map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/back.adoc[`back`] 
| Return a reference to the last entry of this map&period;
| xref:BloombergLP/bdld/DatumIntMapRef/begin.adoc[`begin`] 
| Return an iterator to the first map entry&period;
| xref:BloombergLP/bdld/DatumIntMapRef/cbegin.adoc[`cbegin`] 
| Return an iterator to the first entry of this map&period;
| xref:BloombergLP/bdld/DatumIntMapRef/cend.adoc[`cend`] 
| Return an iterator providing non&hyphen;modifiable access pointing past&hyphen;the&hyphen;end of the array this reference object represents&period;
| xref:BloombergLP/bdld/DatumIntMapRef/crbegin.adoc[`crbegin`] 
| Return a reverse iterator to the last entry of this map&period;
| xref:BloombergLP/bdld/DatumIntMapRef/crend.adoc[`crend`] 
| Return a reverse iterator providing non&hyphen;modifiable access pointing past&hyphen;the&hyphen;end of the array this reference object represents&period;
| xref:BloombergLP/bdld/DatumIntMapRef/data.adoc[`data`] 
| Return a pointer to the first entry of this map&period;
| xref:BloombergLP/bdld/DatumIntMapRef/empty.adoc[`empty`] 
| Return `size() &equals;&equals; 0`&period;
| xref:BloombergLP/bdld/DatumIntMapRef/end.adoc[`end`] 
| Return a past&hyphen;the&hyphen;end iterator for this map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/find.adoc[`find`] 
| Return a pointer to the datum with the specified `key`, or null&period;
| xref:BloombergLP/bdld/DatumIntMapRef/front.adoc[`front`] 
| Return a reference to the first entry of this map&period;
| xref:BloombergLP/bdld/DatumIntMapRef/isSorted.adoc[`isSorted`] 
| Return `true` if underlying map is sorted and `false` otherwise&period;
| xref:BloombergLP/bdld/DatumIntMapRef/operator_subs.adoc[`operator&lsqb;&rsqb;`] 
| Return a reference to the map entry at the specified `position`&period;
| xref:BloombergLP/bdld/DatumIntMapRef/print.adoc[`print`] 
| Format this object to the specified output stream&period;
| xref:BloombergLP/bdld/DatumIntMapRef/rbegin.adoc[`rbegin`] 
| Return a reverse iterator to the last map entry&period;
| xref:BloombergLP/bdld/DatumIntMapRef/rend.adoc[`rend`] 
| Return a past&hyphen;the&hyphen;end reverse iterator for this map reference&period;
| xref:BloombergLP/bdld/DatumIntMapRef/size.adoc[`size`] 
| Return a const&hyphen;pointer to the number of elements of the array this reference object represents&period;
| xref:BloombergLP/bdld/DatumIntMapRef/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration&lt;DatumIntMapRef, HasPrintMethod&gt;`] 
| `DatumIntMapRef` is trivially copyable&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/operator_not_eq-04.adoc[`operator!&equals;`]
| Return whether `lhs` and `rhs` have different values&period;
| xref:BloombergLP/bdld/operator_eq-0c.adoc[`operator&equals;&equals;`]
| Return whether `lhs` and `rhs` have the same value&period;
|===


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