std::sub_match

Defined in header <regex>
template<     class BidirectionalIterator > class sub_match;		(since C++11)

The class template sub_match is used by the regular expression engine to denote sequences of characters matched by marked sub-expressions. A match is a [begin, end) pair within the target range matched by the regular expression, but with additional observer functions to enhance code clarity.

Only the default constructor is publicly accessible. Instances of sub_match are normally constructed and populated as a part of a std::match_results container during the processing of one of the regex algorithms.

The member functions return defined default values unless the matched member is true.

sub_match inherits from std::pair<BidirectionalIterator, BidirectionalIterator>, although it cannot be treated as a std::pair object because member functions such as swap and assignment will not work as expected.

Several specializations for common character sequence types are provided:

Member objects

Template:tdcl list begin |- class="t-dsc" | matched | Indicates if this match was successful. |-

Inherited from std::pair

Template:tdcl list begin |- class="t-dsc" | first | Start of the match sequence. |-

|- class="t-dsc" | second | One-past-the-end of the match sequence. |-

Member functions

Template:cpp/regex/sub match/dcl list constructorTemplate:cpp/regex/sub match/dcl list lengthTemplate:cpp/regex/sub match/dcl list strTemplate:cpp/regex/sub match/dcl list compare

Observers

Non-member functions

Template:cpp/regex/dcl list operator cmp