std::map<Key,T,Compare,Allocator>::value_compare

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

std::map

Member functions

map::map map::~map               map::operator= map::get_allocator

Element access map::at map::operator[] Iterators map::beginmap::cbegin (C++11) map::endmap::cend (C++11) map::rbeginmap::crbegin (C++11)      map::rendmap::crend (C++11) Capacity map::size map::max_size map::empty Observers map::key_comp map::value_comp Modifiers map::clear map::insert map::erase map::swap map::extract (C++17) map::merge (C++17) map::insert_range (C++23) map::insert_or_assign (C++17) map::emplace (C++11) map::emplace_hint (C++11) map::try_emplace (C++17) Lookup map::count map::find map::contains (C++20) map::equal_range map::lower_bound map::upper_bound

Non-member functions

operator==operator<=> (C++20) std::swap(std::map) erase_if(std::map) (C++20)   operator!=operator<operator>operator<=operator>= (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)

Deduction guides (C++17)

 

class value_compare;

std::map::value_compare is a function object that compares objects of type std::map::value_type (key-value pairs) by comparing of the first components of the pairs.

Member types

Type	Definition
result_type (deprecated in C++17)(removed in C++20)	bool
first_argument_type (deprecated in C++17)(removed in C++20)	value_type
second_argument_type (deprecated in C++17)(removed in C++20)	value_type

These member types are obtained via publicly inheriting std::binary_function<value_type, value_type, bool>.

(until C++11)

Protected member objects

Compare comp

the stored comparator (protected member object)

Member functions

(constructor)	constructs a new value_compare object (protected member function)
operator()	compares two values of type value_type (public member function)

std::map<Key,T,Compare,Alloc>::value_compare::value_compare

protected: value_compare( Compare c );

Initializes the internal instance of the comparator to c.

Parameters

c

-

comparator to assign

std::map<Key,T,Compare,Alloc>::value_compare::operator()

bool operator()( const value_type& lhs, const value_type& rhs ) const;

Compares lhs.first and rhs.first by calling the stored comparator.

Parameters

lhs, rhs

-

values to compare

Return value

comp(lhs.first, rhs.first)

Exceptions

May throw implementation-defined exceptions.