.TH "std::sub_match< _BiIter >" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::sub_match< _BiIter >
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBstd::pair< _BiIter, _BiIter >\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef __iter_traits::difference_type \fBdifference_type\fP"
.br
.ti -1c
.RI "typedef _BiIter \fBfirst_type\fP"
.br
.RI "The type of the \fCfirst\fP member\&. "
.ti -1c
.RI "typedef _BiIter \fBiterator\fP"
.br
.ti -1c
.RI "typedef _BiIter \fBsecond_type\fP"
.br
.RI "The type of the \fCsecond\fP member\&. "
.ti -1c
.RI "typedef \fBbasic_string\fP< value_type > \fBstring_type\fP"
.br
.ti -1c
.RI "typedef __iter_traits::value_type \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "int \fBcompare\fP (const \fBsub_match\fP &__s) const"
.br
.RI "Compares this and another matched sequence\&. "
.ti -1c
.RI "difference_type \fBlength\fP () const noexcept"
.br
.RI "Gets the length of the matching sequence\&. "
.ti -1c
.RI "\fBoperator string_type\fP () const"
.br
.RI "Gets the matching sequence as a string\&. "
.ti -1c
.RI "\fBstring_type\fP \fBstr\fP () const"
.br
.RI "Gets the matching sequence as a string\&. "
.ti -1c
.RI "constexpr void \fBswap\fP (\fBpair\fP &__p) noexcept(__and_< __is_nothrow_swappable< _BiIter >, __is_nothrow_swappable< _BiIter >>::value)"
.br
.RI "Swap the first members and then the second members\&. "
.in -1c
.PP
.RI "\fB\fP"
.br

.in +1c
.in +1c
.ti -1c
.RI "int \fBcompare\fP (const \fBstring_type\fP &__s) const"
.br
.RI "Compares this \fCsub_match\fP to a string\&. "
.ti -1c
.RI "int \fBcompare\fP (const value_type *__s) const"
.br
.RI "Compares this \fCsub_match\fP to a string\&. "
.in -1c
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "_BiIter \fBfirst\fP"
.br
.RI "The first member\&. "
.ti -1c
.RI "bool \fBmatched\fP"
.br
.ti -1c
.RI "_BiIter \fBsecond\fP"
.br
.RI "The second member\&. "
.in -1c
.SS "Related Functions"
(Note that these are not member functions\&.) 
.in +1c
.ti -1c
.RI "constexpr \fBpair\fP< typename __decay_and_strip< _BiIter >::__type, typename __decay_and_strip< _BiIter >::__type > \fBmake_pair\fP (_BiIter &&__x, _BiIter &&__y)"
.br
.RI "A convenience wrapper for creating a pair from two objects\&. "
.in -1c
.PP
.RI "\fB\fP"
.br

.in +1c
.in +1c
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator==\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the equivalence of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator!=\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the inequivalence of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator<\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the ordering of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator<=\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the ordering of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator>=\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the ordering of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _BiIter > bool \fBoperator>\fP (const \fBsub_match\fP< _BiIter > &__lhs, const \fBsub_match\fP< _BiIter > &__rhs)"
.br
.RI "Tests the ordering of two regular expression submatches\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator==\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the equivalence of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator!=\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the inequivalence of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator<\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator>\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator>=\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator<=\fP (const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator==\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the equivalence of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator!=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the inequivalence of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator<\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator>\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator>=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter , typename _Ch_traits , typename _Ch_alloc > bool \fBoperator<=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, const __sub_match_string< _Bi_iter, _Ch_traits, _Ch_alloc > &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator==\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the equivalence of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator!=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the inequivalence of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a C string and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator==\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the equivalence of a regular expression submatch and a C string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator!=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the inequivalence of a regular expression submatch and a string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a C string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a C string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a C string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const *__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a C string\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator==\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the equivalence of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator!=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the inequivalence of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<=\fP (typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__lhs, const \fBsub_match\fP< _Bi_iter > &__rhs)"
.br
.RI "Tests the ordering of a character and a regular expression submatch\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator==\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the equivalence of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator!=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the inequivalence of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator>=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Bi_iter > bool \fBoperator<=\fP (const \fBsub_match\fP< _Bi_iter > &__lhs, typename \fBiterator_traits\fP< _Bi_iter >::value_type const &__rhs)"
.br
.RI "Tests the ordering of a regular expression submatch and a character\&. "
.ti -1c
.RI "template<typename _Ch_type , typename _Ch_traits , typename _Bi_iter > \fBbasic_ostream\fP< _Ch_type, _Ch_traits > & \fBoperator<<\fP (\fBbasic_ostream\fP< _Ch_type, _Ch_traits > &__os, const \fBsub_match\fP< _Bi_iter > &__m)"
.br
.RI "Inserts a matched string into an output stream\&. "
.in -1c
.in -1c
.PP
.RI "\fB\fP"
.br

.in +1c
.in +1c
.ti -1c
.RI "constexpr \fBenable_if\fP< __and_< __is_swappable< _BiIter >, __is_swappable< _BiIter > >::value >::type \fBswap\fP (\fBpair\fP< _BiIter, _BiIter > &__x, \fBpair\fP< _BiIter, _BiIter > &__y) noexcept(noexcept(__x\&.swap(__y)))"
.br
.ti -1c
.RI "constexpr bool \fBoperator==\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.ti -1c
.RI "constexpr bool \fBoperator<\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.ti -1c
.RI "constexpr bool \fBoperator!=\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.RI "Uses \fCoperator==\fP to find the result\&. "
.ti -1c
.RI "constexpr bool \fBoperator>\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.RI "Uses \fCoperator<\fP to find the result\&. "
.ti -1c
.RI "constexpr bool \fBoperator<=\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.RI "Uses \fCoperator<\fP to find the result\&. "
.ti -1c
.RI "constexpr bool \fBoperator>=\fP (const \fBpair\fP< _BiIter, _BiIter > &__x, const \fBpair\fP< _BiIter, _BiIter > &__y)"
.br
.RI "Uses \fCoperator<\fP to find the result\&. "
.in -1c
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename _BiIter>
.br
class std::sub_match< _BiIter >"
A sequence of characters matched by a particular marked sub-expression\&.
.PP
An object of this class is essentially a pair of iterators marking a matched subexpression within a regular expression pattern match\&. Such objects can be converted to and compared with std::basic_string objects of a similar base character type as the pattern matched by the regular expression\&.
.PP
The iterators that make up the pair are the usual half-open interval referencing the actual original pattern matched\&. 
.PP
Definition at line 869 of file regex\&.h\&.
.SH "Member Typedef Documentation"
.PP 
.SS "typedef _BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::\fBfirst_type\fP\fC [inherited]\fP"

.PP
The type of the \fCfirst\fP member\&. 
.PP
Definition at line 214 of file stl_pair\&.h\&.
.SS "typedef _BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::\fBsecond_type\fP\fC [inherited]\fP"

.PP
The type of the \fCsecond\fP member\&. 
.PP
Definition at line 215 of file stl_pair\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (const \fBstring_type\fP & __s) const\fC [inline]\fP"

.PP
Compares this \fCsub_match\fP to a string\&. 
.PP
\fBParameters\fP
.RS 4
\fI__s\fP A string to compare to this \fCsub_match\fP\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fInegative\fP This matched sequence will collate before \fC__s\fP\&. 
.br
\fIzero\fP This matched sequence is equivalent to \fC__s\fP\&. 
.br
\fIpositive\fP This matched sequence will collate after \fC__s\fP\&. 
.RE
.PP

.PP
Definition at line 938 of file regex\&.h\&.
.SS "template<typename _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (const \fBsub_match\fP< _BiIter > & __s) const\fC [inline]\fP"

.PP
Compares this and another matched sequence\&. 
.PP
\fBParameters\fP
.RS 4
\fI__s\fP Another matched sequence to compare to this one\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fInegative\fP This matched sequence will collate before \fC__s\fP\&. 
.br
\fIzero\fP This matched sequence is equivalent to \fC__s\fP\&. 
.br
\fIpositive\fP This matched sequence will collate after \fC__s\fP\&. 
.RE
.PP

.PP
Definition at line 924 of file regex\&.h\&.
.PP
Referenced by std::sub_match< _BiIter >::operator!=(), std::sub_match< _BiIter >::operator<(), std::sub_match< _BiIter >::operator<=(), std::sub_match< _BiIter >::operator==(), std::sub_match< _BiIter >::operator>(), and std::sub_match< _BiIter >::operator>=()\&.
.SS "template<typename _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (const value_type * __s) const\fC [inline]\fP"

.PP
Compares this \fCsub_match\fP to a string\&. 
.PP
\fBParameters\fP
.RS 4
\fI__s\fP A string to compare to this \fCsub_match\fP\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fInegative\fP This matched sequence will collate before \fC__s\fP\&. 
.br
\fIzero\fP This matched sequence is equivalent to \fC__s\fP\&. 
.br
\fIpositive\fP This matched sequence will collate after \fC__s\fP\&. 
.RE
.PP

.PP
Definition at line 942 of file regex\&.h\&.
.SS "template<typename _BiIter > difference_type \fBstd::sub_match\fP< _BiIter >::length () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Gets the length of the matching sequence\&. 
.PP
Definition at line 885 of file regex\&.h\&.
.PP
References std::pair< _BiIter, _BiIter >::first, and std::pair< _BiIter, _BiIter >::second\&.
.SS "template<typename _BiIter > \fBstd::sub_match\fP< _BiIter >::operator \fBstring_type\fP () const\fC [inline]\fP"

.PP
Gets the matching sequence as a string\&. 
.PP
\fBReturns\fP
.RS 4
the matching sequence as a string\&.
.RE
.PP
This is the implicit conversion operator\&. It is identical to the str() member function except that it will want to pop up in unexpected places and cause a great deal of confusion and cursing from the unwary\&. 
.PP
Definition at line 898 of file regex\&.h\&.
.PP
References std::sub_match< _BiIter >::str()\&.
.SS "template<typename _BiIter > \fBstring_type\fP \fBstd::sub_match\fP< _BiIter >::str () const\fC [inline]\fP"

.PP
Gets the matching sequence as a string\&. 
.PP
\fBReturns\fP
.RS 4
the matching sequence as a string\&. 
.RE
.PP

.PP
Definition at line 907 of file regex\&.h\&.
.PP
References std::pair< _BiIter, _BiIter >::first, and std::pair< _BiIter, _BiIter >::second\&.
.PP
Referenced by std::sub_match< _BiIter >::operator string_type()\&.
.SS "constexpr void \fBstd::pair\fP< _BiIter , _BiIter  >::swap (\fBpair\fP< _BiIter, _BiIter > & __p)\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP, \fC [inherited]\fP"

.PP
Swap the first members and then the second members\&. 
.PP
Definition at line 439 of file stl_pair\&.h\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "constexpr \fBpair\fP< typename __decay_and_strip< _BiIter  >::__type, typename __decay_and_strip< _BiIter  >::__type > make_pair (_BiIter  && __x, _BiIter  && __y)\fC [related]\fP"

.PP
A convenience wrapper for creating a pair from two objects\&. 
.PP
\fBParameters\fP
.RS 4
\fI__x\fP The first object\&. 
.br
\fI__y\fP The second object\&. 
.RE
.PP
\fBReturns\fP
.RS 4
A newly-constructed pair<> object of the appropriate type\&.
.RE
.PP
The C++98 standard says the objects are passed by reference-to-const, but C++03 says they are passed by value (this was LWG issue #181)\&.
.PP
Since C++11 they have been passed by forwarding reference and then forwarded to the new members of the pair\&. To create a pair with a member of reference type, pass a \fCreference_wrapper\fP to this function\&. 
.PP
Definition at line 567 of file stl_pair\&.h\&.
.SS "constexpr bool operator!= (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"

.PP
Uses \fCoperator==\fP to find the result\&. 
.PP
Definition at line 496 of file stl_pair\&.h\&.
.SS "constexpr bool operator< (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"
Defines a lexicographical order for pairs\&.
.PP
For two pairs of the same type, \fCP\fP is ordered before \fCQ\fP if \fCP\&.first\fP is less than \fCQ\&.first\fP, or if \fCP\&.first\fP and \fCQ\&.first\fP are equivalent (neither is less than the other) and \fCP\&.second\fP is less than \fCQ\&.second\fP\&. 
.PP
Definition at line 488 of file stl_pair\&.h\&.
.SS "constexpr bool operator<= (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"

.PP
Uses \fCoperator<\fP to find the result\&. 
.PP
Definition at line 507 of file stl_pair\&.h\&.
.SS "constexpr bool operator== (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"
Two pairs of the same type are equal iff their members are equal\&. 
.PP
Definition at line 466 of file stl_pair\&.h\&.
.SS "constexpr bool operator> (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"

.PP
Uses \fCoperator<\fP to find the result\&. 
.PP
Definition at line 502 of file stl_pair\&.h\&.
.SS "constexpr bool operator>= (const \fBpair\fP< _BiIter , _BiIter  > & __x, const \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"

.PP
Uses \fCoperator<\fP to find the result\&. 
.PP
Definition at line 514 of file stl_pair\&.h\&.
.SS "constexpr \fBenable_if\fP< __and_< __is_swappable< _BiIter  >, __is_swappable< _BiIter  > >::value >::type swap (\fBpair\fP< _BiIter , _BiIter  > & __x, \fBpair\fP< _BiIter , _BiIter  > & __y)\fC [related]\fP"
Swap overload for pairs\&. Calls std::pair::swap()\&.
.PP
\fBNote\fP
.RS 4
This std::swap overload is not declared in C++03 mode, which has performance implications, e\&.g\&. see https://gcc.gnu.org/PR38466 
.RE
.PP

.PP
Definition at line 533 of file stl_pair\&.h\&.
.SH "Member Data Documentation"
.PP 
.SS "_BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::first\fC [inherited]\fP"

.PP
The first member\&. 
.PP
Definition at line 217 of file stl_pair\&.h\&.
.SS "_BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::second\fC [inherited]\fP"

.PP
The second member\&. 
.PP
Definition at line 218 of file stl_pair\&.h\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.