.TH "std::regex_iterator< _Bi_iter, _Ch_type, _Rx_traits >" 3cxx "Sat Aug 14 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::regex_iterator< _Bi_iter, _Ch_type, _Rx_traits >
.SH SYNOPSIS
.br
.PP
.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 value_type * \fBpointer\fP"
.br
.ti -1c
.RI "typedef const value_type & \fBreference\fP"
.br
.ti -1c
.RI "typedef \fBbasic_regex\fP< _Ch_type, _Rx_traits > \fBregex_type\fP"
.br
.ti -1c
.RI "typedef \fBmatch_results\fP< _Bi_iter > \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBregex_iterator\fP ()=default"
.br
.RI "Provides a singular iterator, useful for indicating one-past-the-end of a range\&. "
.ti -1c
.RI "\fBregex_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP &__re, \fBregex_constants::match_flag_type\fP __m=\fBregex_constants::match_default\fP)"
.br
.ti -1c
.RI "\fBregex_iterator\fP (_Bi_iter, _Bi_iter, const \fBregex_type\fP &&, \fBregex_constants::match_flag_type\fP=\fBregex_constants::match_default\fP)=delete"
.br
.ti -1c
.RI "\fBregex_iterator\fP (const \fBregex_iterator\fP &)=default"
.br
.RI "Copy constructs a regex_iterator\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBregex_iterator\fP &__rhs) const noexcept"
.br
.RI "Tests the inequivalence of two regex iterators\&. "
.ti -1c
.RI "const value_type & \fBoperator*\fP () const noexcept"
.br
.RI "Dereferences a regex_iterator\&. "
.ti -1c
.RI "\fBregex_iterator\fP & \fBoperator++\fP ()"
.br
.RI "Increments a regex_iterator\&. "
.ti -1c
.RI "\fBregex_iterator\fP \fBoperator++\fP (int)"
.br
.RI "Postincrements a regex_iterator\&. "
.ti -1c
.RI "const value_type * \fBoperator\->\fP () const noexcept"
.br
.RI "Selects a regex_iterator member\&. "
.ti -1c
.RI "\fBregex_iterator\fP & \fBoperator=\fP (const \fBregex_iterator\fP &)=default"
.br
.RI "Copy assigns one regex_iterator to another\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBregex_iterator\fP &) const noexcept"
.br
.RI "Tests the equivalence of two regex iterators\&. "
.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_iterator< _Bi_iter, _Ch_type, _Rx_traits >"
An iterator adaptor that will provide repeated calls of regex_search over a range until no more matches remain\&. 
.PP
Definition at line 2513 of file regex\&.h\&.
.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_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::\fBregex_iterator\fP ()\fC [default]\fP"

.PP
Provides a singular iterator, useful for indicating one-past-the-end of a range\&. 
.PP
Referenced by std::regex_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_iterator()\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::\fBregex_iterator\fP (_Bi_iter __a, _Bi_iter __b, const \fBregex_type\fP & __re, \fBregex_constants::match_flag_type\fP __m = \fC\fBregex_constants::match_default\fP\fP)\fC [inline]\fP"
Constructs a regex_iterator\&.\&.\&. 
.PP
\fBParameters\fP
.RS 4
\fI__a\fP [IN] The start of a text range to search\&. 
.br
\fI__b\fP [IN] One-past-the-end of the text range to search\&. 
.br
\fI__re\fP [IN] The regular expression to match\&. 
.br
\fI__m\fP [IN] Policy flags for match rules\&. 
.RE
.PP

.PP
Definition at line 2536 of file regex\&.h\&.
.PP
References std::regex_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_iterator(), and std::regex_search()\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::\fBregex_iterator\fP (const \fBregex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > &)\fC [default]\fP"

.PP
Copy constructs a regex_iterator\&. 
.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_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator!= (const \fBregex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Tests the inequivalence of two regex iterators\&. 
.PP
Definition at line 2570 of file regex\&.h\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> const value_type& \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator* () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Dereferences a regex_iterator\&. 
.PP
Definition at line 2577 of file regex\&.h\&.
.SS "template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits > \fBregex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator++"

.PP
Increments a regex_iterator\&. 
.PP
Definition at line 518 of file regex\&.tcc\&.
.PP
References std::regex_constants::match_continuous, std::regex_constants::match_not_null, and std::regex_search()\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBregex_iterator\fP \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator++ (int)\fC [inline]\fP"

.PP
Postincrements a regex_iterator\&. 
.PP
Definition at line 2597 of file regex\&.h\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> const value_type* \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator\-> () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Selects a regex_iterator member\&. 
.PP
Definition at line 2584 of file regex\&.h\&.
.SS "template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits  = regex_traits<_Ch_type>> \fBregex_iterator\fP& \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator= (const \fBregex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > &)\fC [default]\fP"

.PP
Copy assigns one regex_iterator to another\&. 
.SS "template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits > bool \fBstd::regex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits >::operator== (const \fBregex_iterator\fP< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) const\fC [noexcept]\fP"

.PP
Tests the equivalence of two regex iterators\&. 
.PP
Definition at line 502 of file regex\&.tcc\&.

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