.TH "std::match_results< _Bi_iter, _Alloc >" 3cxx "Tue Jul 2 2019" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::match_results< _Bi_iter, _Alloc > \- The results of a match or search operation\&.  

.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBstd::vector< sub_match< _Bi_iter >, _Alloc >\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "template<typename _Out_iter > _Out_iter \fBformat\fP (_Out_iter __out, const \fBmatch_results\fP< _Bi_iter, _Alloc >::char_type *__fmt_first, const \fBmatch_results\fP< _Bi_iter, _Alloc >::char_type *__fmt_last, \fBmatch_flag_type\fP __flags) const"
.br
.ti -1c
.RI "bool \fBready\fP () const"
.br
.RI "Indicates if the match_results is ready\&. "
.in -1c
.SS "Private Types"

.in +1c
.ti -1c
.RI "typedef _Alloc_traits::const_pointer \fBconst_pointer\fP"
.br
.ti -1c
.RI "typedef \fBstd::reverse_iterator\fP< const_iterator > \fBconst_reverse_iterator\fP"
.br
.ti -1c
.RI "typedef _Base::pointer \fBpointer\fP"
.br
.ti -1c
.RI "typedef \fBstd::reverse_iterator\fP< iterator > \fBreverse_iterator\fP"
.br
.in -1c
.SS "Private Member Functions"

.in +1c
.ti -1c
.RI "pointer \fB_M_allocate\fP (size_t __n)"
.br
.ti -1c
.RI "pointer \fB_M_allocate_and_copy\fP (size_type __n, _ForwardIterator __first, _ForwardIterator __last)"
.br
.ti -1c
.RI "void \fB_M_assign_aux\fP (_InputIterator __first, _InputIterator __last, \fBstd::input_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_assign_aux\fP (_ForwardIterator __first, _ForwardIterator __last, \fBstd::forward_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_assign_dispatch\fP (_Integer __n, _Integer __val, __true_type)"
.br
.ti -1c
.RI "void \fB_M_assign_dispatch\fP (_InputIterator __first, _InputIterator __last, __false_type)"
.br
.ti -1c
.RI "size_type \fB_M_check_len\fP (size_type __n, const char *__s) const"
.br
.ti -1c
.RI "void \fB_M_deallocate\fP (pointer __p, size_t __n)"
.br
.ti -1c
.RI "void \fB_M_default_append\fP (size_type __n)"
.br
.ti -1c
.RI "void \fB_M_default_initialize\fP (size_type __n)"
.br
.ti -1c
.RI "auto \fB_M_emplace_aux\fP (const_iterator __position, _Args &&\&.\&.\&. __args) \-> iterator"
.br
.ti -1c
.RI "iterator \fB_M_emplace_aux\fP (const_iterator __position, _Args &&\&.\&.\&. __args)"
.br
.ti -1c
.RI "iterator \fB_M_emplace_aux\fP (const_iterator __position, \fBvalue_type\fP &&__v)"
.br
.ti -1c
.RI "iterator \fB_M_erase\fP (iterator __position)"
.br
.ti -1c
.RI "iterator \fB_M_erase\fP (iterator __first, iterator __last)"
.br
.ti -1c
.RI "void \fB_M_erase_at_end\fP (pointer __pos) noexcept"
.br
.ti -1c
.RI "void \fB_M_fill_assign\fP (size_type __n, const \fBvalue_type\fP &__val)"
.br
.ti -1c
.RI "void \fB_M_fill_initialize\fP (size_type __n, const \fBvalue_type\fP &__value)"
.br
.ti -1c
.RI "void \fB_M_fill_insert\fP (iterator __pos, size_type __n, const \fBvalue_type\fP &__x)"
.br
.ti -1c
.RI "_Tp_alloc_type & \fB_M_get_Tp_allocator\fP () noexcept"
.br
.ti -1c
.RI "const _Tp_alloc_type & \fB_M_get_Tp_allocator\fP () const noexcept"
.br
.ti -1c
.RI "void \fB_M_initialize_dispatch\fP (_Integer __n, _Integer __value, __true_type)"
.br
.ti -1c
.RI "void \fB_M_initialize_dispatch\fP (_InputIterator __first, _InputIterator __last, __false_type)"
.br
.ti -1c
.RI "void \fB_M_insert_aux\fP (iterator __position, _Arg &&__arg)"
.br
.ti -1c
.RI "void \fB_M_insert_dispatch\fP (iterator __pos, _Integer __n, _Integer __val, __true_type)"
.br
.ti -1c
.RI "void \fB_M_insert_dispatch\fP (iterator __pos, _InputIterator __first, _InputIterator __last, __false_type)"
.br
.ti -1c
.RI "iterator \fB_M_insert_rval\fP (const_iterator __position, \fBvalue_type\fP &&__v)"
.br
.ti -1c
.RI "void \fB_M_range_check\fP (size_type __n) const"
.br
.RI "Safety check used only from at()\&. "
.ti -1c
.RI "void \fB_M_range_initialize\fP (_InputIterator __first, _InputIterator __last, \fBstd::input_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_range_initialize\fP (_ForwardIterator __first, _ForwardIterator __last, \fBstd::forward_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_range_insert\fP (iterator __pos, _InputIterator __first, _InputIterator __last, \fBstd::input_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_range_insert\fP (iterator __pos, _ForwardIterator __first, _ForwardIterator __last, \fBstd::forward_iterator_tag\fP)"
.br
.ti -1c
.RI "void \fB_M_realloc_insert\fP (iterator __position, _Args &&\&.\&.\&. __args)"
.br
.ti -1c
.RI "bool \fB_M_shrink_to_fit\fP ()"
.br
.ti -1c
.RI "void \fBassign\fP (size_type __n, const \fBvalue_type\fP &__val)"
.br
.RI "Assigns a given value to a vector\&. "
.ti -1c
.RI "void \fBassign\fP (_InputIterator __first, _InputIterator __last)"
.br
.RI "Assigns a range to a vector\&. "
.ti -1c
.RI "void \fBassign\fP (\fBinitializer_list\fP< \fBvalue_type\fP > __l)"
.br
.RI "Assigns an initializer list to a vector\&. "
.ti -1c
.RI "\fBreference\fP \fBat\fP (size_type __n)"
.br
.RI "Provides access to the data contained in the vector\&. "
.ti -1c
.RI "\fBconst_reference\fP \fBat\fP (size_type __n) const"
.br
.RI "Provides access to the data contained in the vector\&. "
.ti -1c
.RI "\fBreference\fP \fBback\fP () noexcept"
.br
.ti -1c
.RI "\fBconst_reference\fP \fBback\fP () const noexcept"
.br
.ti -1c
.RI "iterator \fBbegin\fP () noexcept"
.br
.ti -1c
.RI "size_type \fBcapacity\fP () const noexcept"
.br
.ti -1c
.RI "void \fBclear\fP () noexcept"
.br
.ti -1c
.RI "\fBconst_reverse_iterator\fP \fBcrbegin\fP () const noexcept"
.br
.ti -1c
.RI "\fBconst_reverse_iterator\fP \fBcrend\fP () const noexcept"
.br
.ti -1c
.RI "\fBsub_match\fP< _Bi_iter > * \fBdata\fP () noexcept"
.br
.ti -1c
.RI "const \fBsub_match\fP< _Bi_iter > * \fBdata\fP () const noexcept"
.br
.ti -1c
.RI "iterator \fBemplace\fP (const_iterator __position, _Args &&\&.\&.\&. __args)"
.br
.RI "Inserts an object in vector before specified iterator\&. "
.ti -1c
.RI "void \fBemplace_back\fP (_Args &&\&.\&.\&. __args)"
.br
.ti -1c
.RI "iterator \fBend\fP () noexcept"
.br
.ti -1c
.RI "iterator \fBerase\fP (const_iterator __position)"
.br
.RI "Remove element at given position\&. "
.ti -1c
.RI "iterator \fBerase\fP (const_iterator __first, const_iterator __last)"
.br
.RI "Remove a range of elements\&. "
.ti -1c
.RI "\fBreference\fP \fBfront\fP () noexcept"
.br
.ti -1c
.RI "\fBconst_reference\fP \fBfront\fP () const noexcept"
.br
.ti -1c
.RI "iterator \fBinsert\fP (const_iterator __position, const \fBvalue_type\fP &__x)"
.br
.RI "Inserts given value into vector before specified iterator\&. "
.ti -1c
.RI "iterator \fBinsert\fP (const_iterator __position, \fBvalue_type\fP &&__x)"
.br
.RI "Inserts given rvalue into vector before specified iterator\&. "
.ti -1c
.RI "iterator \fBinsert\fP (const_iterator __position, \fBinitializer_list\fP< \fBvalue_type\fP > __l)"
.br
.RI "Inserts an initializer_list into the vector\&. "
.ti -1c
.RI "iterator \fBinsert\fP (const_iterator __position, size_type __n, const \fBvalue_type\fP &__x)"
.br
.RI "Inserts a number of copies of given data into the vector\&. "
.ti -1c
.RI "iterator \fBinsert\fP (const_iterator __position, _InputIterator __first, _InputIterator __last)"
.br
.RI "Inserts a range into the vector\&. "
.ti -1c
.RI "\fBreference\fP \fBoperator[]\fP (size_type __n) noexcept"
.br
.RI "Subscript access to the data contained in the vector\&. "
.ti -1c
.RI "\fBconst_reference\fP \fBoperator[]\fP (size_type __n) const noexcept"
.br
.RI "Subscript access to the data contained in the vector\&. "
.ti -1c
.RI "void \fBpop_back\fP () noexcept"
.br
.RI "Removes last element\&. "
.ti -1c
.RI "void \fBpush_back\fP (const \fBvalue_type\fP &__x)"
.br
.RI "Add data to the end of the vector\&. "
.ti -1c
.RI "void \fBpush_back\fP (\fBvalue_type\fP &&__x)"
.br
.ti -1c
.RI "\fBreverse_iterator\fP \fBrbegin\fP () noexcept"
.br
.ti -1c
.RI "\fBconst_reverse_iterator\fP \fBrbegin\fP () const noexcept"
.br
.ti -1c
.RI "\fBreverse_iterator\fP \fBrend\fP () noexcept"
.br
.ti -1c
.RI "\fBconst_reverse_iterator\fP \fBrend\fP () const noexcept"
.br
.ti -1c
.RI "void \fBreserve\fP (size_type __n)"
.br
.RI "Attempt to preallocate enough memory for specified number of elements\&. "
.ti -1c
.RI "void \fBresize\fP (size_type __new_size)"
.br
.RI "Resizes the vector to the specified number of elements\&. "
.ti -1c
.RI "void \fBresize\fP (size_type __new_size, const \fBvalue_type\fP &__x)"
.br
.RI "Resizes the vector to the specified number of elements\&. "
.ti -1c
.RI "void \fBshrink_to_fit\fP ()"
.br
.ti -1c
.RI "void \fBswap\fP (\fBvector\fP &__x) noexcept"
.br
.RI "Swaps data with another vector\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "_Vector_impl \fB_M_impl\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<typename _Bp , typename _Ap , typename _Cp , typename _Rp , __detail::_RegexExecutorPolicy , bool > bool \fB__detail::__regex_algo_impl\fP (_Bp, _Bp, \fBmatch_results\fP< _Bp, _Ap > &, const \fBbasic_regex\fP< _Cp, _Rp > &, \fBregex_constants::match_flag_type\fP)"
.br
.ti -1c
.RI "template<typename , typename , typename , bool > class \fB__detail::_Executor\fP"
.br
.ti -1c
.RI "template<typename , typename , typename > class \fBregex_iterator\fP"
.br
.in -1c
.SS "10\&.? Public Types"

.in +1c
.ti -1c
.RI "typedef \fBsub_match\fP< _Bi_iter > \fBvalue_type\fP"
.br
.ti -1c
.RI "typedef const \fBvalue_type\fP & \fBconst_reference\fP"
.br
.ti -1c
.RI "typedef \fBvalue_type\fP & \fBreference\fP"
.br
.ti -1c
.RI "typedef _Base_type::const_iterator \fBconst_iterator\fP"
.br
.ti -1c
.RI "typedef const_iterator \fBiterator\fP"
.br
.ti -1c
.RI "typedef __iter_traits::difference_type \fBdifference_type\fP"
.br
.ti -1c
.RI "typedef \fBallocator_traits\fP< _Alloc >::size_type \fBsize_type\fP"
.br
.ti -1c
.RI "typedef _Alloc \fBallocator_type\fP"
.br
.ti -1c
.RI "typedef __iter_traits::value_type \fBchar_type\fP"
.br
.ti -1c
.RI "typedef \fBstd::basic_string\fP< char_type > \fBstring_type\fP"
.br
.in -1c
.SS "28\&.10\&.1 Construction, Copying, and Destruction"

.in +1c
.ti -1c
.RI "\fBmatch_results\fP (const _Alloc &__a=_Alloc())"
.br
.RI "Constructs a default match_results container\&. "
.ti -1c
.RI "\fBmatch_results\fP (const \fBmatch_results\fP &__rhs)=default"
.br
.RI "Copy constructs a match_results\&. "
.ti -1c
.RI "\fBmatch_results\fP (\fBmatch_results\fP &&__rhs) noexcept=default"
.br
.RI "Move constructs a match_results\&. "
.ti -1c
.RI "\fBmatch_results\fP & \fBoperator=\fP (const \fBmatch_results\fP &__rhs)=default"
.br
.RI "Assigns rhs to *this\&. "
.ti -1c
.RI "\fBmatch_results\fP & \fBoperator=\fP (\fBmatch_results\fP &&__rhs)=default"
.br
.RI "Move-assigns rhs to *this\&. "
.ti -1c
.RI "\fB~match_results\fP ()"
.br
.RI "Destroys a match_results object\&. "
.in -1c
.SS "28\&.10\&.2 Size"

.in +1c
.ti -1c
.RI "size_type \fBsize\fP () const"
.br
.RI "Gets the number of matches and submatches\&. "
.ti -1c
.RI "size_type \fBmax_size\fP () const"
.br
.RI "Gets the number of matches and submatches\&. "
.ti -1c
.RI "bool \fBempty\fP () const"
.br
.RI "Indicates if the match_results contains no results\&. "
.in -1c
.SS "10\&.3 Element Access"

.in +1c
.ti -1c
.RI "difference_type \fBlength\fP (size_type __sub=0) const"
.br
.RI "Gets the length of the indicated submatch\&. "
.ti -1c
.RI "difference_type \fBposition\fP (size_type __sub=0) const"
.br
.RI "Gets the offset of the beginning of the indicated submatch\&. "
.ti -1c
.RI "\fBstring_type\fP \fBstr\fP (size_type __sub=0) const"
.br
.RI "Gets the match or submatch converted to a string type\&. "
.ti -1c
.RI "\fBconst_reference\fP \fBoperator[]\fP (size_type __sub) const"
.br
.RI "Gets a sub_match reference for the match or submatch\&. "
.ti -1c
.RI "\fBconst_reference\fP \fBprefix\fP () const"
.br
.RI "Gets a sub_match representing the match prefix\&. "
.ti -1c
.RI "\fBconst_reference\fP \fBsuffix\fP () const"
.br
.RI "Gets a sub_match representing the match suffix\&. "
.ti -1c
.RI "const_iterator \fBbegin\fP () const"
.br
.RI "Gets an iterator to the start of the sub_match collection\&. "
.ti -1c
.RI "const_iterator \fBcbegin\fP () const"
.br
.RI "Gets an iterator to the start of the sub_match collection\&. "
.ti -1c
.RI "const_iterator \fBend\fP () const"
.br
.RI "Gets an iterator to one-past-the-end of the collection\&. "
.ti -1c
.RI "const_iterator \fBcend\fP () const"
.br
.RI "Gets an iterator to one-past-the-end of the collection\&. "
.in -1c
.SS "10\&.4 Formatting"
These functions perform formatted substitution of the matched character sequences into their target\&. The format specifiers and escape sequences accepted by these functions are determined by their \fCflags\fP parameter as documented above\&. 
.in +1c
.ti -1c
.RI "template<typename _Out_iter > _Out_iter \fBformat\fP (_Out_iter __out, const char_type *__fmt_first, const char_type *__fmt_last, \fBmatch_flag_type\fP __flags=\fBregex_constants::format_default\fP) const"
.br
.ti -1c
.RI "template<typename _Out_iter , typename _St , typename _Sa > _Out_iter \fBformat\fP (_Out_iter __out, const \fBbasic_string\fP< char_type, _St, _Sa > &__fmt, \fBmatch_flag_type\fP __flags=\fBregex_constants::format_default\fP) const"
.br
.ti -1c
.RI "template<typename _St , typename _Sa > \fBbasic_string\fP< char_type, _St, _Sa > \fBformat\fP (const \fBbasic_string\fP< char_type, _St, _Sa > &__fmt, \fBmatch_flag_type\fP __flags=\fBregex_constants::format_default\fP) const"
.br
.ti -1c
.RI "\fBstring_type\fP \fBformat\fP (const char_type *__fmt, \fBmatch_flag_type\fP __flags=\fBregex_constants::format_default\fP) const"
.br
.in -1c
.SS "10\&.5 Allocator"

.in +1c
.ti -1c
.RI "allocator_type \fBget_allocator\fP () const"
.br
.RI "Gets a copy of the allocator\&. "
.in -1c
.SS "10\&.6 Swap"

.in +1c
.ti -1c
.RI "void \fBswap\fP (\fBmatch_results\fP &__that)"
.br
.RI "Swaps the contents of two match_results\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >>
.br
class std::match_results< _Bi_iter, _Alloc >"
The results of a match or search operation\&. 

A collection of character sequences representing the result of a regular expression match\&. Storage for the collection is allocated and freed as necessary by the member functions of class template match_results\&.
.PP
This class satisfies the Sequence requirements, with the exception that only the operations defined for a const-qualified Sequence are supported\&.
.PP
The sub_match object stored at index 0 represents sub-expression 0, i\&.e\&. the whole match\&. In this case the sub_match member matched is always true\&. The sub_match object stored at index n denotes what matched the marked sub-expression n within the matched expression\&. If the sub-expression n participated in a regular expression match then the sub_match member matched evaluates to true, and members first and second denote the range of characters [first, second) which formed that match\&. Otherwise matched is false, and members first and second point to the end of the sequence that was searched\&. 
.PP
Definition at line 39 of file regex\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstd::match_results\fP< _Bi_iter, _Alloc >::\fBmatch_results\fP (const _Alloc & __a = \fC_Alloc()\fP)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Constructs a default match_results container\&. 
.PP
\fBPostcondition:\fP
.RS 4
size() returns 0 and str() returns an empty string\&. 
.RE
.PP

.PP
Definition at line 1605 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstd::match_results\fP< _Bi_iter, _Alloc >::\fBmatch_results\fP (const \fBmatch_results\fP< _Bi_iter, _Alloc > & __rhs)\fC [default]\fP"

.PP
Copy constructs a match_results\&. 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstd::match_results\fP< _Bi_iter, _Alloc >::\fBmatch_results\fP (\fBmatch_results\fP< _Bi_iter, _Alloc > && __rhs)\fC [default]\fP, \fC [noexcept]\fP"

.PP
Move constructs a match_results\&. 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstd::match_results\fP< _Bi_iter, _Alloc >::~\fBmatch_results\fP ()\fC [inline]\fP"

.PP
Destroys a match_results object\&. 
.PP
Definition at line 1634 of file regex\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> const_iterator \fBstd::match_results\fP< _Bi_iter, _Alloc >::begin () const\fC [inline]\fP"

.PP
Gets an iterator to the start of the sub_match collection\&. 
.PP
Definition at line 1779 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> const_iterator \fBstd::match_results\fP< _Bi_iter, _Alloc >::cbegin () const\fC [inline]\fP"

.PP
Gets an iterator to the start of the sub_match collection\&. 
.PP
Definition at line 1786 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> const_iterator \fBstd::match_results\fP< _Bi_iter, _Alloc >::cend () const\fC [inline]\fP"

.PP
Gets an iterator to one-past-the-end of the collection\&. 
.PP
Definition at line 1800 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> bool \fBstd::match_results\fP< _Bi_iter, _Alloc >::empty () const\fC [inline]\fP"

.PP
Indicates if the match_results contains no results\&. 
.PP
\fBReturn values:\fP
.RS 4
\fItrue\fP The match_results object is empty\&. 
.br
\fIfalse\fP The match_results object is not empty\&. 
.RE
.PP

.PP
Definition at line 1675 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> const_iterator \fBstd::match_results\fP< _Bi_iter, _Alloc >::end () const\fC [inline]\fP"

.PP
Gets an iterator to one-past-the-end of the collection\&. 
.PP
Definition at line 1793 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> template<typename _Out_iter > _Out_iter \fBstd::match_results\fP< _Bi_iter, _Alloc >::format (_Out_iter __out, const char_type * __fmt_first, const char_type * __fmt_last, \fBmatch_flag_type\fP __flags = \fC\fBregex_constants::format_default\fP\fP) const"

.PP
\fBPrecondition:\fP
.RS 4
ready() == true 
.RE
.PP

.PP
Referenced by std::regex_traits< _CharType >::value()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> template<typename _Out_iter , typename _St , typename _Sa > _Out_iter \fBstd::match_results\fP< _Bi_iter, _Alloc >::format (_Out_iter __out, const \fBbasic_string\fP< char_type, _St, _Sa > & __fmt, \fBmatch_flag_type\fP __flags = \fC\fBregex_constants::format_default\fP\fP) const\fC [inline]\fP"

.PP
\fBPrecondition:\fP
.RS 4
ready() == true 
.RE
.PP

.PP
Definition at line 1829 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> template<typename _St , typename _Sa > \fBbasic_string\fP<char_type, _St, _Sa> \fBstd::match_results\fP< _Bi_iter, _Alloc >::format (const \fBbasic_string\fP< char_type, _St, _Sa > & __fmt, \fBmatch_flag_type\fP __flags = \fC\fBregex_constants::format_default\fP\fP) const\fC [inline]\fP"

.PP
\fBPrecondition:\fP
.RS 4
ready() == true 
.RE
.PP

.PP
Definition at line 1841 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstring_type\fP \fBstd::match_results\fP< _Bi_iter, _Alloc >::format (const char_type * __fmt, \fBmatch_flag_type\fP __flags = \fC\fBregex_constants::format_default\fP\fP) const\fC [inline]\fP"

.PP
\fBPrecondition:\fP
.RS 4
ready() == true 
.RE
.PP

.PP
Definition at line 1853 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> allocator_type \fBstd::match_results\fP< _Bi_iter, _Alloc >::get_allocator () const\fC [inline]\fP"

.PP
Gets a copy of the allocator\&. 
.PP
Definition at line 1875 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> difference_type \fBstd::match_results\fP< _Bi_iter, _Alloc >::length (size_type __sub = \fC0\fP) const\fC [inline]\fP"

.PP
Gets the length of the indicated submatch\&. 
.PP
\fBParameters:\fP
.RS 4
\fI__sub\fP indicates the submatch\&. 
.RE
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function returns the length of the indicated submatch, or the length of the entire match if \fC__sub\fP is zero (the default)\&. 
.PP
Definition at line 1694 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> size_type \fBstd::match_results\fP< _Bi_iter, _Alloc >::max_size () const\fC [inline]\fP"

.PP
Gets the number of matches and submatches\&. The number of matches for a given regular expression will be either 0 if there was no match or mark_count() + 1 if a match was successful\&. Some matches may be empty\&.
.PP
\fBReturns:\fP
.RS 4
the number of matches found\&. 
.RE
.PP

.PP
Definition at line 1666 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBmatch_results\fP& \fBstd::match_results\fP< _Bi_iter, _Alloc >::operator= (const \fBmatch_results\fP< _Bi_iter, _Alloc > & __rhs)\fC [default]\fP"

.PP
Assigns rhs to *this\&. 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBmatch_results\fP& \fBstd::match_results\fP< _Bi_iter, _Alloc >::operator= (\fBmatch_results\fP< _Bi_iter, _Alloc > && __rhs)\fC [default]\fP"

.PP
Move-assigns rhs to *this\&. 
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBconst_reference\fP \fBstd::match_results\fP< _Bi_iter, _Alloc >::operator[] (size_type __sub) const\fC [inline]\fP"

.PP
Gets a sub_match reference for the match or submatch\&. 
.PP
\fBParameters:\fP
.RS 4
\fI__sub\fP indicates the submatch\&. 
.RE
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function gets a reference to the indicated submatch, or the entire match if \fC__sub\fP is zero\&.
.PP
If \fC__sub\fP >= size() then this function returns a sub_match with a special value indicating no submatch\&. 
.PP
Definition at line 1737 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> difference_type \fBstd::match_results\fP< _Bi_iter, _Alloc >::position (size_type __sub = \fC0\fP) const\fC [inline]\fP"

.PP
Gets the offset of the beginning of the indicated submatch\&. 
.PP
\fBParameters:\fP
.RS 4
\fI__sub\fP indicates the submatch\&. 
.RE
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function returns the offset from the beginning of the target sequence to the beginning of the submatch, unless the value of \fC__sub\fP is zero (the default), in which case this function returns the offset from the beginning of the target sequence to the beginning of the match\&. 
.PP
Definition at line 1709 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBconst_reference\fP \fBstd::match_results\fP< _Bi_iter, _Alloc >::prefix () const\fC [inline]\fP"

.PP
Gets a sub_match representing the match prefix\&. 
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function gets a reference to a sub_match object representing the part of the target range between the start of the target range and the start of the match\&. 
.PP
Definition at line 1754 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> bool \fBstd::match_results\fP< _Bi_iter, _Alloc >::ready () const\fC [inline]\fP"

.PP
Indicates if the match_results is ready\&. 
.PP
\fBReturn values:\fP
.RS 4
\fItrue\fP The object has a fully-established result state\&. 
.br
\fIfalse\fP The object is not ready\&. 
.RE
.PP

.PP
Definition at line 1645 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> size_type \fBstd::match_results\fP< _Bi_iter, _Alloc >::size () const\fC [inline]\fP"

.PP
Gets the number of matches and submatches\&. The number of matches for a given regular expression will be either 0 if there was no match or mark_count() + 1 if a match was successful\&. Some matches may be empty\&.
.PP
\fBReturns:\fP
.RS 4
the number of matches found\&. 
.RE
.PP

.PP
Definition at line 1662 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBstring_type\fP \fBstd::match_results\fP< _Bi_iter, _Alloc >::str (size_type __sub = \fC0\fP) const\fC [inline]\fP"

.PP
Gets the match or submatch converted to a string type\&. 
.PP
\fBParameters:\fP
.RS 4
\fI__sub\fP indicates the submatch\&. 
.RE
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function gets the submatch (or match, if \fC__sub\fP is zero) extracted from the target range and converted to the associated string type\&. 
.PP
Definition at line 1722 of file regex\&.h\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> \fBconst_reference\fP \fBstd::match_results\fP< _Bi_iter, _Alloc >::suffix () const\fC [inline]\fP"

.PP
Gets a sub_match representing the match suffix\&. 
.PP
\fBPrecondition:\fP
.RS 4
ready() == true
.RE
.PP
This function gets a reference to a sub_match object representing the part of the target range between the end of the match and the end of the target range\&. 
.PP
Definition at line 1769 of file regex\&.h\&.
.PP
Referenced by std::operator==()\&.
.SS "template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >> void \fBstd::match_results\fP< _Bi_iter, _Alloc >::swap (\fBmatch_results\fP< _Bi_iter, _Alloc > & __that)\fC [inline]\fP"

.PP
Swaps the contents of two match_results\&. 
.PP
Definition at line 1889 of file regex\&.h\&.
.PP
Referenced by std::swap()\&.

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