.TH "std::sub_match< _BiIter >" 3cxx "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::sub_match< _BiIter >
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <regex\&.h>\fP
.PP
Inherits \fBstd::pair< _BiIter, _BiIter >\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "\fBusing\fP \fB_PCCFP\fP = _PCC<!\fBis_same\fP< _BiIter, \fB_U1\fP >::value||!\fBis_same\fP< _BiIter, \fB_U2\fP >::value, _BiIter, _BiIter >"
.br
.ti -1c
.RI "\fBusing\fP \fB_PCCP\fP = _PCC< \fBtrue\fP, _BiIter, _BiIter >"
.br
.ti -1c
.RI "\fBtypedef\fP __iter_traits::difference_type \fBdifference_type\fP"
.br
.ti -1c
.RI "\fBtypedef\fP _BiIter \fBfirst_type\fP"
.br
.ti -1c
.RI "\fBtypedef\fP _BiIter \fBiterator\fP"
.br
.ti -1c
.RI "\fBtypedef\fP _BiIter \fBsecond_type\fP"
.br
.RI "\fCfirst_type\fP is the first bound type "
.ti -1c
.RI "\fBtypedef\fP \fBbasic_string\fP< value_type > \fBstring_type\fP"
.br
.ti -1c
.RI "\fBtypedef\fP __iter_traits::value_type \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "int \fB_M_compare\fP (\fBconst\fP value_type *\fB__s\fP, size_t __n) \fBconst\fP"
.br
.ti -1c
.RI "int \fBcompare\fP (\fBconst\fP \fBsub_match\fP &\fB__s\fP) \fBconst\fP"
.br
.RI "Compares this and another matched sequence\&. "
.ti -1c
.RI "difference_type \fBlength\fP () \fBconst\fP \fBnoexcept\fP"
.br
.RI "Gets the length of the matching sequence\&. "
.ti -1c
.RI "\fBoperator string_type\fP () \fBconst\fP"
.br
.RI "Gets the matching sequence as a string\&. "
.ti -1c
.RI "\fBstring_type\fP \fBstr\fP () \fBconst\fP"
.br
.RI "Gets the matching sequence as a string\&. "
.ti -1c
.RI "\fBvoid\fP \fBswap\fP (\fBpair\fP &__p) \fBnoexcept\fP(__and_< __is_nothrow_swappable< _BiIter >, __is_nothrow_swappable< _BiIter > >::value)"
.br
.in -1c
.PP
.RI "\fB\fP"
.br

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

.in +1c
.ti -1c
.RI "_BiIter \fBfirst\fP"
.br
.RI "\fCsecond_type\fP is the second bound type "
.ti -1c
.RI "bool \fBmatched\fP"
.br
.ti -1c
.RI "_BiIter \fBsecond\fP"
.br
.RI "\fCfirst\fP is a copy of the first object "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<\fBtypename\fP _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 \fB863\fP of file \fBregex\&.h\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "\fBusing\fP \fBstd::pair\fP< _BiIter , _BiIter  >::_PCCFP =  _PCC<!\fBis_same\fP<_BiIter , \fB_U1\fP>::value || !\fBis_same\fP<_BiIter , \fB_U2\fP>::value, _BiIter , _BiIter >\fC [inherited]\fP"
There is also a templated copy ctor for the \fCpair\fP class itself\&. 
.PP
Definition at line \fB281\fP of file \fBstl_pair\&.h\fP\&.
.SS "\fBusing\fP \fBstd::pair\fP< _BiIter , _BiIter  >::_PCCP =  _PCC<\fBtrue\fP, _BiIter , _BiIter >\fC [inherited]\fP"
Two objects may be passed to a \fCpair\fP constructor to be copied\&. 
.PP
Definition at line \fB252\fP of file \fBstl_pair\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > \fBtypedef\fP __iter_traits::difference_type \fBstd::sub_match\fP< _BiIter >::difference_type"

.PP
Definition at line \fB869\fP of file \fBregex\&.h\fP\&.
.SS "\fBtypedef\fP _BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::first_type\fC [inherited]\fP"

.PP
Definition at line \fB211\fP of file \fBstl_pair\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > \fBtypedef\fP _BiIter \fBstd::sub_match\fP< _BiIter >::iterator"

.PP
Definition at line \fB870\fP of file \fBregex\&.h\fP\&.
.SS "\fBtypedef\fP _BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::second_type\fC [inherited]\fP"

.PP
\fCfirst_type\fP is the first bound type 
.PP
Definition at line \fB212\fP of file \fBstl_pair\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > \fBtypedef\fP \fBbasic_string\fP<value_type> \fBstd::sub_match\fP< _BiIter >::string_type"

.PP
Definition at line \fB871\fP of file \fBregex\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > \fBtypedef\fP __iter_traits::value_type \fBstd::sub_match\fP< _BiIter >::value_type"

.PP
Definition at line \fB868\fP of file \fBregex\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<\fBtypename\fP _BiIter > \fBconstexpr\fP \fBstd::sub_match\fP< _BiIter >::sub_match ()\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB875\fP of file \fBregex\&.h\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<\fBtypename\fP _BiIter > int \fBstd::sub_match\fP< _BiIter >::_M_compare (\fBconst\fP value_type * __s, size_t __n) const\fC [inline]\fP"

.PP
Definition at line \fB942\fP of file \fBregex\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (\fBconst\fP \fBstring_type\fP & __s) const\fC [inline]\fP"

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

.PP
Definition at line \fB932\fP of file \fBregex\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (\fBconst\fP \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 `__s`\&. 
.br
\fIzero\fP This matched sequence is equivalent to `__s`\&. 
.br
\fIpositive\fP This matched sequence will collate after `__s`\&. 
.RE
.PP

.PP
Definition at line \fB918\fP of file \fBregex\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > int \fBstd::sub_match\fP< _BiIter >::compare (\fBconst\fP value_type * __s) const\fC [inline]\fP"

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

.PP
Definition at line \fB936\fP of file \fBregex\&.h\fP\&.
.SS "template<\fBtypename\fP _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 \fB879\fP of file \fBregex\&.h\fP\&.
.PP
References \fBstd::distance()\fP, \fBstd::pair< _BiIter, _BiIter >::first\fP, and \fBstd::pair< _BiIter, _BiIter >::second\fP\&.
.SS "template<\fBtypename\fP _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 \fB892\fP of file \fBregex\&.h\fP\&.
.PP
References \fBstd::sub_match< _BiIter >::str()\fP\&.
.SS "template<\fBtypename\fP _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 \fB901\fP of file \fBregex\&.h\fP\&.
.PP
References \fBstd::pair< _BiIter, _BiIter >::first\fP, and \fBstd::pair< _BiIter, _BiIter >::second\fP\&.
.PP
Referenced by \fBstd::sub_match< _BiIter >::operator string_type()\fP\&.
.SS "\fBvoid\fP \fBstd::pair\fP< _BiIter , _BiIter  >::swap (\fBpair\fP< _BiIter, _BiIter > & __p)\fC [inline]\fP, \fC [noexcept]\fP, \fC [inherited]\fP"

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

.PP
\fCsecond_type\fP is the second bound type 
.PP
Definition at line \fB214\fP of file \fBstl_pair\&.h\fP\&.
.SS "template<\fBtypename\fP _BiIter > bool \fBstd::sub_match\fP< _BiIter >::matched"

.PP
Definition at line \fB873\fP of file \fBregex\&.h\fP\&.
.SS "_BiIter  \fBstd::pair\fP< _BiIter , _BiIter  >::second\fC [inherited]\fP"

.PP
\fCfirst\fP is a copy of the first object 
.PP
Definition at line \fB215\fP of file \fBstl_pair\&.h\fP\&.

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