std::pair

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

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)

Atomic operations library (C++11)

Thread support library (C++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI, type traits)      Library feature-test macros (C++20) Dynamic memory management Program utilities Error handling Coroutine support (C++20) Variadic functions launder (C++17) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects bitset Formatting library (C++20) hash (C++11) integer_sequence (C++14) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (C++17) Stacktrace stacktrace_entry (C++23) basic_stacktrace (C++23)

 

std::pair

Member functions

pair::pair

pair::operator=

pair::swap

Non-member functions

make_pair

operator==operator!=operator<operator<=operator>operator>=operator<=> (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)

std::swap

get (C++11)

Deduction guides(C++17)

Helper classes

tuple_size (C++11)

tuple_element (C++11)

 

Defined in header <utility>
template<     class T1,     class T2 > struct pair;

std::pair is a class template that provides a way to store two heterogeneous objects as a single unit. A pair is a specific case of a std::tuple with two elements.

If neither T1 nor T2 is a possibly cv-qualified class type with non-trivial destructor, or array thereof, the destructor of pair is trivial.

Template parameters

T1, T2

-

the types of the elements that the pair stores.

Member types

Member type	Definition
first_type	T1
second_type	T2

Member objects

Member name	Type
first	T1
second	T2

Member functions

(constructor)	constructs new pair (public member function)
operator=	assigns the contents (public member function)
swap (C++11)	swaps the contents (public member function)

Non-member functions

make_pair	creates a pair object of type, defined by the argument types (function template)
operator==operator!=operator<operator<=operator>operator>=operator<=> (removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(C++20)	lexicographically compares the values in the pair (function template)
std::swap(std::pair) (C++11)	specializes the std::swap algorithm (function template)
std::get(std::pair) (C++11)	accesses an element of a pair (function template)

Helper classes

std::tuple_size<std::pair> (C++11)	obtains the size of a pair (class template specialization)
std::tuple_element<std::pair> (C++11)	obtains the type of the elements of pair (class template specialization)

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 2796	C++98	triviality of the destructor of pair was unspecified	specified

See also

tuple (C++11)	implements fixed size container, which holds elements of possibly different types (class template)
tie (C++11)	creates a tuple of lvalue references or unpacks a tuple into individual objects (function template)