Provided by: libstdc++-5-doc_5.5.0-12ubuntu1_all bug

NAME

       std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >

SYNOPSIS

   Public Types
       typedef std::ptrdiff_t difference_type
       typedef std::forward_iterator_tag iterator_category
       typedef const value_type * pointer
       typedef const value_type & reference
       typedef basic_regex< _Ch_type, _Rx_traits > regex_type
       typedef sub_match< _Bi_iter > value_type

   Public Member Functions
       regex_token_iterator ()
       regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, int __submatch=0,
           regex_constants::match_flag_type __m=regex_constants::match_default)
       regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, const std::vector< int >
           &__submatches, regex_constants::match_flag_type __m=regex_constants::match_default)
       regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, initializer_list< int >
           __submatches, regex_constants::match_flag_type __m=regex_constants::match_default)
       template<std::size_t _Nm> regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, const
           int(&__submatches)[_Nm], regex_constants::match_flag_type __m=regex_constants::match_default)
       regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, int=0,
           regex_constants::match_flag_type=regex_constants::match_default)=delete
       regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, const std::vector< int > &,
           regex_constants::match_flag_type=regex_constants::match_default)=delete
       regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, initializer_list< int >,
           regex_constants::match_flag_type=regex_constants::match_default)=delete
       template<std::size_t _Nm> regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, const
           int(&)[_Nm], regex_constants::match_flag_type=regex_constants::match_default)=delete
       regex_token_iterator (const regex_token_iterator &__rhs)
       bool operator!= (const regex_token_iterator &__rhs) const
       const value_type & operator* () const
       regex_token_iterator & operator++ ()
       regex_token_iterator operator++ (int)
       const value_type * operator-> () const
       regex_token_iterator & operator= (const regex_token_iterator &__rhs)
       bool operator== (const regex_token_iterator &__rhs) const

Detailed Description

   template<typename _Bi_iter, typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits = regex_traits<_Ch_type>>
       class std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >" Iterates over submatches in a range
       (or splits a text string).

       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.

       Definition at line 2562 of file regex.h.

Constructor & Destructor Documentation

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::regex_token_iterator () [inline]
       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.

       Definition at line 2580 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type & __re, int __submatch = 0,
       regex_constants::match_flag_type __m = regex_constants::match_default) [inline]
       Constructs a regex_token_iterator...

       Parameters:
           __a [IN] The start of the text to search.
           __b [IN] One-past-the-end of the text to search.
           __re [IN] The regular expression to search for.
           __submatch [IN] Which submatch to return. There are some special values for this parameter:

           • -1 each enumerated subexpression does NOT match the regular expression (aka field splitting)

           • 0 the entire string matching the subexpression is returned for each match within the text.

           • >0 enumerates only the indicated subexpression from a match within the text.

           __m [IN] Policy flags for match rules.

       Definition at line 2602 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type & __re, const std::vector< int > &
       __submatches, regex_constants::match_flag_type __m = regex_constants::match_default) [inline]
       Constructs a regex_token_iterator...

       Parameters:
           __a [IN] The start of the text to search.
           __b [IN] One-past-the-end of the text to search.
           __re [IN] The regular expression to search for.
           __submatches [IN] A list of subexpressions to return for each regular expression match within the
           text.
           __m [IN] Policy flags for match rules.

       Definition at line 2618 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type & __re, initializer_list< int >
       __submatches, regex_constants::match_flag_type __m = regex_constants::match_default) [inline]
       Constructs a regex_token_iterator...

       Parameters:
           __a [IN] The start of the text to search.
           __b [IN] One-past-the-end of the text to search.
           __re [IN] The regular expression to search for.
           __submatches [IN] A list of subexpressions to return for each regular expression match within the
           text.
           __m [IN] Policy flags for match rules.

       Definition at line 2635 of file regex.h.

   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> std::regex_token_iterator< _Bi_iter,
       _Ch_type, _Rx_traits >::regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type & __re, const
       int(&) __submatches[_Nm], regex_constants::match_flag_type __m = regex_constants::match_default) [inline]
       Constructs a regex_token_iterator...

       Parameters:
           __a [IN] The start of the text to search.
           __b [IN] One-past-the-end of the text to search.
           __re [IN] The regular expression to search for.
           __submatches [IN] A list of subexpressions to return for each regular expression match within the
           text.
           __m [IN] Policy flags for match rules.

       Definition at line 2653 of file regex.h.

       References std::regex_constants::match_default.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::regex_token_iterator (const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) [inline]
       Copy constructs a regex_token_iterator.

       Parameters:
           __rhs [IN] A regex_token_iterator to copy.

       Definition at line 2685 of file regex.h.

Member Function Documentation

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> bool std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       >::operator!= (const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > & __rhs) const [inline]
       Compares a regex_token_iterator to another for inequality.

       Definition at line 2707 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> const value_type& std::regex_token_iterator< _Bi_iter, _Ch_type,
       _Rx_traits >::operator* () const [inline]
       Dereferences a regex_token_iterator.

       Definition at line 2714 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits > regex_token_iterator< _Bi_iter,
       _Ch_type, _Rx_traits > & std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator++ ()
       Increments a regex_token_iterator.

       Definition at line 621 of file regex.tcc.

       Referenced by std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator==().

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> regex_token_iterator std::regex_token_iterator< _Bi_iter, _Ch_type,
       _Rx_traits >::operator++ (int) [inline]
       Postincrements a regex_token_iterator.

       Definition at line 2734 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type  = typename iterator_traits<_Bi_iter>::value_type, typename
       _Rx_traits  = regex_traits<_Ch_type>> const value_type* std::regex_token_iterator< _Bi_iter, _Ch_type,
       _Rx_traits >::operator-> () const [inline]
       Selects a regex_token_iterator member.

       Definition at line 2721 of file regex.h.

   template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits > regex_token_iterator< _Bi_iter,
       _Ch_type, _Rx_traits > & std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator= (const
       regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > & __rhs)
       Assigns a regex_token_iterator to another.

       Parameters:
           __rhs [IN] A regex_token_iterator to copy.

       Definition at line 585 of file regex.tcc.

       References std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator==().

   template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits > bool std::regex_token_iterator<
       _Bi_iter, _Ch_type, _Rx_traits >::operator== (const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits
       > & __rhs) const
       Compares a regex_token_iterator to another for equality.

       Definition at line 601 of file regex.tcc.

       References std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator++().

       Referenced by std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator=().

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

libstdc++                                      std::regex1token8iterator< _Bi_iter, _Ch_type, _Rx_traits >(3cxx)