[#bsl-multimap-0ae-value_compare]
= xref:bsl.adoc[bsl]::xref:bsl/multimap-0ae.adoc[multimap]::value_compare
:relfileprefix: ../../
:mrdocs:

This nested class defines a mechanism for comparing two objects of `value_type` by adapting an object of (template parameter) type `COMPARATOR`, which compares two objects of (template parameter) type `KEY` . Note that this class exactly matches its definition in the C++11 standard [23.4.4.1]; otherwise, we would have implemented it as a separate component‐local class.

== Synopsis

Declared in `<bslstl_multimap.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/multimap-0ae/value_compare/first_argument_type.adoc[`first_argument_type`] 
| This `typedef` is an alias for the type of the first parameter of the overload of `operator()` (the comparison function) provided by a `multimap::value_compare` object.
| xref:bsl/multimap-0ae/value_compare/result_type.adoc[`result_type`] 
| This `typedef` is an alias for the result type of a call to the overload of `operator()` (the comparison function) provided by a `multimap::value_compare` object.
| xref:bsl/multimap-0ae/value_compare/second_argument_type.adoc[`second_argument_type`] 
| This `typedef` is an alias for the type of the second parameter of the overload of `operator()` (the comparison function) provided by a `multimap::value_compare` object.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/multimap-0ae/value_compare/operator_call.adoc[`operator()`] 
| Return `true` if the specified `x` object is ordered before the specified `y` object, as determined by the comparator supplied at construction, and `false` otherwise.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/multimap-0ae/value_compare/2constructor.adoc[`value_compare`]         [.small]#[constructor]#
| Create a `value_compare` object that uses the specified `comparator`.
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:bsl/multimap-0ae/value_compare/comp.adoc[`comp`] 
| Key comparator stored in each node.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/multimap-0ae.adoc[bsl::multimap]`
| This class template implements a value‐semantic container type holding an ordered sequence of key‐value pairs having possibly duplicate keys that provide a mapping from keys (of the template parameter type, `KEY`) to their associated values (of another template parameter type, `VALUE`).
|===


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