Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/regex/sub match"

From cppreference.com
< cpp‎ | regex
(use correct template)
(Added more description.)
Line 8: Line 8:
  
 
The class template {{tt|sub_match}} is used by the regular expression engine to denote sequences of characters matched by marked sub-expressions.  
 
The class template {{tt|sub_match}} is used by the regular expression engine to denote sequences of characters matched by marked sub-expressions.  
{{todo}}
+
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 {{cpp|std::match_results}} container during the processing of one of the regex algorithms.
 +
 
 +
The member functions return defined default values unless the {{cpp|matched}} member is {{tt|true}}.
  
 
Inherits {{cpp|std::pair<BidirectionalIterator, BidirectionalIterator>}}
 
Inherits {{cpp|std::pair<BidirectionalIterator, BidirectionalIterator>}}
Line 47: Line 51:
 
===Non-member functions===
 
===Non-member functions===
 
{{dcl list begin}}
 
{{dcl list begin}}
 +
{{dcl list template | cpp/regex/dcl list operator_comp | sub_match}}
 
{{dcl list end}}
 
{{dcl list end}}
 
{{todo | reason=non-member functions}}
 

Revision as of 06:45, 21 October 2011

Template:cpp/regex/sub match/sidebar

Defined in header <regex>
template<

    class BidirectionalIterator

> class sub_match;
Template:mark c++11 feature

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 Template:cpp container during the processing of one of the regex algorithms.

The member functions return defined default values unless the Template:cpp member is true.

Inherits Template:cpp

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 functions

constructs the match object
(public member function)
Observers
returns the length of the match, if any
(public member function)
cast to the underlying string type
(public member function)
returns the matched subsequence
(public member function)
compares matched subsequence (if any)
(public member function)

Member objects

defines whether this match was successful
(public member object)

Non-member functions

Template:cpp/regex/dcl list operator comp