Namespaces
Variants
Views
Actions

std::sub_match

From cppreference.com
< cpp‎ | regex
Revision as of 20:46, 19 April 2012 by P12bot (Talk | contribs)

Template:cpp/regex/sub match/sidebar

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: object of this class 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.

Inherits std::pair<BidirectionalIterator, BidirectionalIterator>, although this type can not 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:

Template:tdcl list begin Template:tdcl list header Template:tdcl list hitem Template:tdcl list item Template:tdcl list item Template:tdcl list item Template:tdcl list item Template:tdcl list end

Contents

Member types

Template:tdcl list begin Template:tdcl list hitem Template:tdcl list item Template:tdcl list item Template:tdcl list item Template:tdcl list item Template:tdcl list end

Member objects

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

Template:tdcl list end

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. |-

Template:tdcl list end

Member functions

constructs the match object
(public member function)
Observers
Returns the length of the match (if any).
(public member function)
Converts to the underlying string type.
(public member function)
Compares matched subsequence (if any).
(public member function)

Non-member functions

Template:cpp/regex/dcl list operator cmp