.TH "std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >" 3cxx "Tue Jul 18 2023" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <regex\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef std::ptrdiff_t \fBdifference_type\fP"
.br
.ti -1c
.RI "typedef \fBstd::forward_iterator_tag\fP \fBiterator_category\fP"
.br
.ti -1c
.RI "typedef const \fBvalue_type\fP * \fBpointer\fP"
.br
.ti -1c
.RI "typedef const \fBvalue_type\fP & \fBreference\fP"
.br
.ti -1c
.RI "typedef \fBbasic_regex\fP< _Ch_type, _Rx_traits > \fBregex_type\fP"
.br
.ti -1c
.RI "typedef \fBsub_match\fP< _Bi_iter > \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBregex_token_iterator\fP ()"
.br
.RI "Default constructs a regex_token_iterator\&. "
.ti -1c
.RI "template<std::size_t _Nm> \fBregex_token_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP &__re, const int(&__submatches)[_Nm], \fBregex_constants::match_flag_type\fP __m=\fBregex_constants::match_default\fP)"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP &__re, const \fBstd::vector\fP< int > &__submatches, \fBregex_constants::match_flag_type\fP __m=\fBregex_constants::match_default\fP)"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP &__re, \fBinitializer_list\fP< int > __submatches, \fBregex_constants::match_flag_type\fP __m=\fBregex_constants::match_default\fP)"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP &__re, int __submatch=0, \fBregex_constants::match_flag_type\fP __m=\fBregex_constants::match_default\fP)"
.br
.ti -1c
.RI "template<std::size_t _Nm> \fBregex_token_iterator\fP (_Bi_iter, _Bi_iter, const \fBregex_type\fP &&, const int(&)[_Nm], \fBregex_constants::match_flag_type\fP=\fBregex_constants::match_default\fP)=delete"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter, _Bi_iter, const \fBregex_type\fP &&, const \fBstd::vector\fP< int > &, \fBregex_constants::match_flag_type\fP=\fBregex_constants::match_default\fP)=delete"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter, _Bi_iter, const \fBregex_type\fP &&, \fBinitializer_list\fP< int >, \fBregex_constants::match_flag_type\fP=\fBregex_constants::match_default\fP)=delete"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (_Bi_iter, _Bi_iter, const \fBregex_type\fP &&, int=0, \fBregex_constants::match_flag_type\fP=\fBregex_constants::match_default\fP)=delete"
.br
.ti -1c
.RI "\fBregex_token_iterator\fP (const \fBregex_token_iterator\fP &__rhs)"
.br
.RI "Copy constructs a regex_token_iterator\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBregex_token_iterator\fP &__rhs) const"
.br
.RI "Compares a regex_token_iterator to another for inequality\&. "
.ti -1c
.RI "const \fBvalue_type\fP & \fBoperator*\fP () const"
.br
.RI "Dereferences a regex_token_iterator\&. "
.ti -1c
.RI "\fBregex_token_iterator\fP & \fBoperator++\fP ()"
.br
.RI "Increments a regex_token_iterator\&. "
.ti -1c
.RI "\fBregex_token_iterator\fP \fBoperator++\fP (int)"
.br
.RI "Postincrements a regex_token_iterator\&. "
.ti -1c
.RI "const \fBvalue_type\fP * \fBoperator\->\fP () const"
.br
.RI "Selects a regex_token_iterator member\&. "
.ti -1c
.RI "\fBregex_token_iterator\fP & \fBoperator=\fP (const \fBregex_token_iterator\fP &__rhs)"
.br
.RI "Assigns a regex_token_iterator to another\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBregex_token_iterator\fP &__rhs) const"
.br
.RI "Compares a regex_token_iterator to another for equality\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename _Bi_iter, typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
.br
class std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >"Iterates over submatches in a range (or \fIsplits\fP a text string)\&.
.PP
The purpose of this iterator is to enumerate all, or all specified, matches of a regular expression within a text range\&. The dereferenced value of an iterator of this class is a std::sub_match object\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ()\fC [inline]\fP"

.PP
Default constructs a regex_token_iterator\&. A default-constructed regex_token_iterator is a singular iterator that will compare equal to the one-past-the-end value for any iterator of the same type\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP & __re, int __submatch = \fC0\fP, \fBregex_constants::match_flag_type\fP __m = \fC\fBregex_constants::match_default\fP\fP)\fC [inline]\fP"
Constructs a regex_token_iterator\&.\&.\&. 
.PP
\fBParameters\fP
.RS 4
\fI__a\fP [IN] The start of the text to search\&. 
.br
\fI__b\fP [IN] One-past-the-end of the text to search\&. 
.br
\fI__re\fP [IN] The regular expression to search for\&. 
.br
\fI__submatch\fP [IN] Which submatch to return\&. There are some special values for this parameter:
.IP "\(bu" 2
-1 each enumerated subexpression does NOT match the regular expression (aka field splitting)
.IP "\(bu" 2
0 the entire string matching the subexpression is returned for each match within the text\&.
.IP "\(bu" 2
>0 enumerates only the indicated subexpression from a match within the text\&. 
.PP
.br
\fI__m\fP [IN] Policy flags for match rules\&. 
.RE
.PP

.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP & __re, const \fBstd::vector\fP< int > & __submatches, \fBregex_constants::match_flag_type\fP __m = \fC\fBregex_constants::match_default\fP\fP)\fC [inline]\fP"
Constructs a regex_token_iterator\&.\&.\&. 
.PP
\fBParameters\fP
.RS 4
\fI__a\fP [IN] The start of the text to search\&. 
.br
\fI__b\fP [IN] One-past-the-end of the text to search\&. 
.br
\fI__re\fP [IN] The regular expression to search for\&. 
.br
\fI__submatches\fP [IN] A list of subexpressions to return for each regular expression match within the text\&. 
.br
\fI__m\fP [IN] Policy flags for match rules\&. 
.RE
.PP

.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP & __re, \fBinitializer_list\fP< int > __submatches, \fBregex_constants::match_flag_type\fP __m = \fC\fBregex_constants::match_default\fP\fP)\fC [inline]\fP"
Constructs a regex_token_iterator\&.\&.\&. 
.PP
\fBParameters\fP
.RS 4
\fI__a\fP [IN] The start of the text to search\&. 
.br
\fI__b\fP [IN] One-past-the-end of the text to search\&. 
.br
\fI__re\fP [IN] The regular expression to search for\&. 
.br
\fI__submatches\fP [IN] A list of subexpressions to return for each regular expression match within the text\&. 
.br
\fI__m\fP [IN] Policy flags for match rules\&. 
.RE
.PP

.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> template<std::size_t _Nm> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP & __re, const int(&) __submatches[_Nm], \fBregex_constants::match_flag_type\fP __m = \fC\fBregex_constants::match_default\fP\fP)\fC [inline]\fP"
Constructs a regex_token_iterator\&.\&.\&. 
.PP
\fBParameters\fP
.RS 4
\fI__a\fP [IN] The start of the text to search\&. 
.br
\fI__b\fP [IN] One-past-the-end of the text to search\&. 
.br
\fI__re\fP [IN] The regular expression to search for\&. 
.br
\fI__submatches\fP [IN] A list of subexpressions to return for each regular expression match within the text\&. 
.br
\fI__m\fP [IN] Policy flags for match rules\&. 
.RE
.PP

.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator (const \fBregex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs)\fC [inline]\fP"

.PP
Copy constructs a regex_token_iterator\&. 
.PP
\fBParameters\fP
.RS 4
\fI__rhs\fP [IN] A regex_token_iterator to copy\&. 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> bool \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator!= (const \fBregex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) const\fC [inline]\fP"

.PP
Compares a regex_token_iterator to another for inequality\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> const \fBvalue_type\fP & \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator* () const\fC [inline]\fP"

.PP
Dereferences a regex_token_iterator\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBregex_token_iterator\fP & \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator++ ()"

.PP
Increments a regex_token_iterator\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBregex_token_iterator\fP \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator++ (int)\fC [inline]\fP"

.PP
Postincrements a regex_token_iterator\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> const \fBvalue_type\fP * \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator\-> () const\fC [inline]\fP"

.PP
Selects a regex_token_iterator member\&. 
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBregex_token_iterator\fP & \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator= (const \fBregex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs)"

.PP
Assigns a regex_token_iterator to another\&. 
.PP
\fBParameters\fP
.RS 4
\fI__rhs\fP [IN] A regex_token_iterator to copy\&. 
.RE
.PP

.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> bool \fBstd::regex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator== (const \fBregex_token_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) const"

.PP
Compares a regex_token_iterator to another for equality\&. 

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