2007-06-08 09:23:23 +00:00
< html >
< head >
2020-10-12 18:22:57 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
2007-12-14 10:11:21 +00:00
< title > match_results< / title >
2010-07-08 22:49:58 +00:00
< link rel = "stylesheet" href = "../../../../../../doc/src/boostbook.css" type = "text/css" >
2019-10-26 10:51:25 +01:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.79.1" >
2022-03-08 11:26:11 +00:00
< link rel = "home" href = "../../index.html" title = "Boost.Regex 7.0.1" >
2007-12-14 10:11:21 +00:00
< link rel = "up" href = "../ref.html" title = "Reference" >
< link rel = "prev" href = "basic_regex.html" title = "basic_regex" >
< link rel = "next" href = "sub_match.html" title = "sub_match" >
2024-03-23 19:03:45 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2007-06-08 09:23:23 +00:00
< / head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
2007-08-13 17:54:01 +00:00
< table cellpadding = "2" width = "100%" > < tr >
2007-06-08 09:23:23 +00:00
< td valign = "top" > < img alt = "Boost C++ Libraries" width = "277" height = "86" src = "../../../../../../boost.png" > < / td >
2008-04-11 08:53:54 +00:00
< td align = "center" > < a href = "../../../../../../index.html" > Home< / a > < / td >
2007-06-08 09:23:23 +00:00
< td align = "center" > < a href = "../../../../../../libs/libraries.htm" > Libraries< / a > < / td >
2008-07-25 09:28:01 +00:00
< td align = "center" > < a href = "http://www.boost.org/users/people.html" > People< / a > < / td >
< td align = "center" > < a href = "http://www.boost.org/users/faq.html" > FAQ< / a > < / td >
2007-06-08 09:23:23 +00:00
< td align = "center" > < a href = "../../../../../../more/index.htm" > More< / a > < / td >
2007-08-13 17:54:01 +00:00
< / tr > < / table >
2007-06-08 09:23:23 +00:00
< hr >
< div class = "spirit-nav" >
2010-07-08 22:49:58 +00:00
< a accesskey = "p" href = "basic_regex.html" > < img src = "../../../../../../doc/src/images/prev.png" alt = "Prev" > < / a > < a accesskey = "u" href = "../ref.html" > < img src = "../../../../../../doc/src/images/up.png" alt = "Up" > < / a > < a accesskey = "h" href = "../../index.html" > < img src = "../../../../../../doc/src/images/home.png" alt = "Home" > < / a > < a accesskey = "n" href = "sub_match.html" > < img src = "../../../../../../doc/src/images/next.png" alt = "Next" > < / a >
2007-06-08 09:23:23 +00:00
< / div >
2013-12-14 17:42:13 +00:00
< div class = "section" >
2007-06-08 09:23:23 +00:00
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.ref.match_results" > < / a > < a class = "link" href = "match_results.html" title = "match_results" > match_results< / a >
2007-12-14 10:11:21 +00:00
< / h3 > < / div > < / div > < / div >
2011-12-24 17:51:57 +00:00
< h5 >
< a name = "boost_regex.ref.match_results.h0" > < / a >
2012-11-29 10:28:07 +00:00
< span class = "phrase" > < a name = "boost_regex.ref.match_results.synopsis" > < / a > < / span > < a class = "link" href = "match_results.html#boost_regex.ref.match_results.synopsis" > Synopsis< / a >
2007-12-14 10:11:21 +00:00
< / h5 >
< pre class = "programlisting" > < span class = "preprocessor" > #include< / span > < span class = "special" > < < / span > < span class = "identifier" > boost< / span > < span class = "special" > /< / span > < span class = "identifier" > regex< / span > < span class = "special" > .< / span > < span class = "identifier" > hpp< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
Regular expressions are different from many simple pattern-matching algorithms
in that as well as finding an overall match they can also produce sub-expression
matches: each sub-expression being delimited in the pattern by a pair of
parenthesis (...). There has to be some method for reporting sub-expression
2007-12-14 10:11:21 +00:00
matches back to the user: this is achieved this by defining a class < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code > that acts as an indexed collection
2007-06-08 09:23:23 +00:00
of sub-expression matches, each sub-expression match being contained in an
2008-12-23 11:46:00 +00:00
object of type < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a > .
2007-06-08 09:23:23 +00:00
< / p >
< p >
2007-12-14 10:11:21 +00:00
Template class < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code >
2007-06-08 09:23:23 +00:00
denotes a collection of character sequences representing the result of a
2007-12-14 10:11:21 +00:00
regular expression match. Objects of type < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code >
2008-12-23 11:46:00 +00:00
are passed to the algorithms < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > and < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > , and are returned by
the iterator < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > . Storage for the
2007-06-08 09:23:23 +00:00
collection is allocated and freed as necessary by the member functions of
2007-12-14 10:11:21 +00:00
class < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code > .
2007-06-08 09:23:23 +00:00
< / p >
< p >
2007-12-14 10:11:21 +00:00
The template class < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code >
2007-06-08 09:23:23 +00:00
conforms to the requirements of a Sequence, as specified in (lib.sequence.reqmts),
except that only operations defined for const-qualified Sequences are supported.
< / p >
< p >
2007-12-14 10:11:21 +00:00
Class template < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code >
is most commonly used as one of the typedefs < code class = "computeroutput" > < span class = "identifier" > cmatch< / span > < / code > ,
< code class = "computeroutput" > < span class = "identifier" > wcmatch< / span > < / code > , < code class = "computeroutput" > < span class = "identifier" > smatch< / span > < / code > ,
or < code class = "computeroutput" > < span class = "identifier" > wsmatch< / span > < / code > :
2007-06-08 09:23:23 +00:00
< / p >
2007-12-14 10:11:21 +00:00
< pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > =< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > allocator< / span > < span class = "special" > < < / span > < span class = "identifier" > sub_match< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > < / span > < span class = "special" > > < / span >
< span class = "keyword" > class< / span > < span class = "identifier" > match_results< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "keyword" > const< / span > < span class = "keyword" > char< / span > < span class = "special" > *> < / span > < span class = "identifier" > cmatch< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "keyword" > const< / span > < span class = "keyword" > wchar_t< / span > < span class = "special" > *> < / span > < span class = "identifier" > wcmatch< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > string< / span > < span class = "special" > ::< / span > < span class = "identifier" > const_iterator< / span > < span class = "special" > > < / span > < span class = "identifier" > smatch< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > wstring< / span > < span class = "special" > ::< / span > < span class = "identifier" > const_iterator< / span > < span class = "special" > > < / span > < span class = "identifier" > wsmatch< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span >
< span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > =< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > allocator< / span > < span class = "special" > < < / span > < span class = "identifier" > sub_match< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > < / span > < span class = "special" > > < / span >
< span class = "keyword" > class< / span > < span class = "identifier" > match_results< / span >
2011-12-24 17:51:57 +00:00
< span class = "special" > {< / span >
< span class = "keyword" > public< / span > < span class = "special" > :< / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > typedef< / span > < span class = "identifier" > sub_match< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > < / span > < span class = "identifier" > value_type< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "keyword" > const< / span > < span class = "identifier" > value_type< / span > < span class = "special" > & < / span > < span class = "identifier" > const_reference< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > const_reference< / span > < span class = "identifier" > reference< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > implementation< / span > < span class = "identifier" > defined< / span > < span class = "identifier" > const_iterator< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > const_iterator< / span > < span class = "identifier" > iterator< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "keyword" > typename< / span > < span class = "identifier" > iterator_traits< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > ::< / span > < span class = "identifier" > difference_type< / span > < span class = "identifier" > difference_type< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "keyword" > typename< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > ::< / span > < span class = "identifier" > size_type< / span > < span class = "identifier" > size_type< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > Allocator< / span > < span class = "identifier" > allocator_type< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "keyword" > typename< / span > < span class = "identifier" > iterator_traits< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > ::< / span > < span class = "identifier" > value_type< / span > < span class = "identifier" > char_type< / span > < span class = "special" > ;< / span >
< span class = "keyword" > typedef< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > > < / span > < span class = "identifier" > string_type< / span > < span class = "special" > ;< / span >
2011-07-21 10:01:09 +00:00
< span class = "comment" > // construct/copy/destroy:< / span >
< a class = "link" href = "match_results.html#boost_regex.match_results.construct" > explicit match_results< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > & < / span > < span class = "identifier" > a< / span > < span class = "special" > =< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > ());< / span >
2008-12-23 11:46:00 +00:00
< a class = "link" href = "match_results.html#boost_regex.match_results.copy_construct" > match_results< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
2011-12-24 17:51:57 +00:00
< a class = "link" href = "match_results.html#boost_regex.match_results.assign" > match_results& operator=< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< span class = "special" > ~< / span > < span class = "identifier" > match_results< / span > < span class = "special" > ();< / span >
2011-07-21 10:01:09 +00:00
< span class = "comment" > // size:< / span >
< span class = "identifier" > size_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.size" > size< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > size_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.max_size" > max_size< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > bool< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.empty" > empty< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2011-07-21 10:01:09 +00:00
< span class = "comment" > // element access:< / span >
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.length" > length< / a > < span class = "special" > (< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.length" > length< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.length" > length< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.length" > length< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.position" > position< / a > < span class = "special" > (< / span > < span class = "keyword" > unsigned< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.position" > position< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.position" > position< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.position" > position< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.str" > str< / a > < span class = "special" > (< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.str" > str< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.str" > str< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.str" > str< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.str" > str< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.subscript" > operator[]< / a > < span class = "special" > (< / span > < span class = "keyword" > int< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.subscript" > operator[]< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.subscript" > operator[]< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.subscript" > operator[]< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.subscript" > operator[]< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
2008-12-23 11:46:00 +00:00
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.prefix" > prefix< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
2008-12-23 11:46:00 +00:00
< span class = "identifier" > const_reference< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.suffix" > suffix< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "identifier" > const_iterator< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.begin" > begin< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "identifier" > const_iterator< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.end" > end< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2011-07-21 10:01:09 +00:00
< span class = "comment" > // format:< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > OutputIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Formatter< / span > < span class = "special" > > < / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > OutputIterator< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.format" > format< / a > < span class = "special" > (< / span > < span class = "identifier" > OutputIterator< / span > < span class = "identifier" > out< / span > < span class = "special" > ,< / span >
2009-10-30 17:25:12 +00:00
< span class = "identifier" > Formatter< / span > < span class = "identifier" > fmt< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "identifier" > match_flag_type< / span > < span class = "identifier" > flags< / span > < span class = "special" > =< / span > < span class = "identifier" > format_default< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-10-30 17:25:12 +00:00
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Formatter< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.format2" > format< / a > < span class = "special" > (< / span > < span class = "identifier" > Formatter< / span > < span class = "identifier" > fmt< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "identifier" > match_flag_type< / span > < span class = "identifier" > flags< / span > < span class = "special" > =< / span > < span class = "identifier" > format_default< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "identifier" > allocator_type< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.get_allocator" > get_allocator< / a > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > void< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.swap" > swap< / a > < span class = "special" > (< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > that< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< span class = "preprocessor" > #ifdef< / span > < span class = "identifier" > BOOST_REGEX_MATCH_EXTRA< / span >
< span class = "keyword" > typedef< / span > < span class = "keyword" > typename< / span > < span class = "identifier" > value_type< / span > < span class = "special" > ::< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "special" > ;< / span >
2008-12-23 11:46:00 +00:00
< span class = "keyword" > const< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "special" > & < / span > < a class = "link" href = "match_results.html#boost_regex.match_results.captures" > captures< / a > < span class = "special" > (< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > size_t< / span > < span class = "identifier" > i< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< span class = "preprocessor" > #endif< / span >
< span class = "special" > };< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2008-12-23 11:46:00 +00:00
< span class = "keyword" > bool< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.op_eq" > operator ==< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2008-12-23 11:46:00 +00:00
< span class = "keyword" > bool< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.op_ne" > operator !=< / a > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
< span class = "identifier" > basic_ostream< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > traits< / span > < span class = "special" > > & < / span >
2008-12-23 11:46:00 +00:00
< a class = "link" href = "match_results.html#boost_regex.match_results.op_stream" > operator < < < / a > < span class = "special" > (< / span > < span class = "identifier" > basic_ostream< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > traits< / span > < span class = "special" > > & < / span > < span class = "identifier" > os< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2008-12-23 11:46:00 +00:00
< span class = "keyword" > void< / span > < a class = "link" href = "match_results.html#boost_regex.match_results.op_swap" > swap< / a > < span class = "special" > (< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
2007-06-08 09:23:23 +00:00
< span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< / pre >
2011-12-24 17:51:57 +00:00
< h5 >
< a name = "boost_regex.ref.match_results.h1" > < / a >
2012-11-29 10:28:07 +00:00
< span class = "phrase" > < a name = "boost_regex.ref.match_results.description" > < / a > < / span > < a class = "link" href = "match_results.html#boost_regex.ref.match_results.description" > Description< / a >
2007-12-14 10:11:21 +00:00
< / h5 >
2007-06-08 09:23:23 +00:00
< p >
2007-12-14 10:11:21 +00:00
In all < code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code > constructors,
2007-06-08 09:23:23 +00:00
a copy of the Allocator argument is used for any memory allocation performed
by the constructor or member functions during the lifetime of the object.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.construct" > < / a > < pre class = "programlisting" > < span class = "identifier" > match_results< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > & < / span > < span class = "identifier" > a< / span > < span class = "special" > =< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > ());< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Constructs an object of class
< code class = "computeroutput" > < span class = "identifier" > match_results< / span > < / code > . The postconditions
2007-06-08 09:23:23 +00:00
of this function are indicated in the table:
< / p >
< div class = "informaltable" > < table class = "table" >
< colgroup >
< col >
< col >
< / colgroup >
< thead > < tr >
< th >
2010-07-08 22:49:58 +00:00
< p >
Element
< / p >
2007-06-08 09:23:23 +00:00
< / th >
< th >
2010-07-08 22:49:58 +00:00
< p >
Value
< / p >
2007-06-08 09:23:23 +00:00
< / th >
< / tr > < / thead >
< tbody >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
empty()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
true
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
size()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
0
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
str()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
basic_string< charT> ()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< / tbody >
< / table > < / div >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.copy_construct" > < / a > < pre class = "programlisting" > < span class = "identifier" > match_results< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Constructs an object of class match_results,
2007-06-08 09:23:23 +00:00
as a copy of m.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.assign" > < / a > < pre class = "programlisting" > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "keyword" > operator< / span > < span class = "special" > =(< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Assigns m to *this. The postconditions
2007-06-08 09:23:23 +00:00
of this function are indicated in the table:
< / p >
< div class = "informaltable" > < table class = "table" >
< colgroup >
< col >
< col >
< / colgroup >
< thead > < tr >
< th >
2010-07-08 22:49:58 +00:00
< p >
Element
< / p >
2007-06-08 09:23:23 +00:00
< / th >
< th >
2010-07-08 22:49:58 +00:00
< p >
Value
< / p >
2007-06-08 09:23:23 +00:00
< / th >
< / tr > < / thead >
< tbody >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
empty()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.empty().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
size()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.size().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
str(n)
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.str(n) for all integers n < m.size().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
prefix()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.prefix().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
suffix()
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.suffix().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
(*this)[n]
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m[n] for all integers n < m.size().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
length(n)
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.length(n) for all integers n < m.size().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< tr >
< td >
2010-07-08 22:49:58 +00:00
< p >
position(n)
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< td >
2010-07-08 22:49:58 +00:00
< p >
m.position(n) for all integers n < m.size().
< / p >
2007-06-08 09:23:23 +00:00
< / td >
< / tr >
< / tbody >
< / table > < / div >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.size" > < / a > < pre class = "programlisting" > < span class = "identifier" > size_type< / span > < span class = "identifier" > size< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2008-12-23 11:46:00 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns the number of < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a > elements stored in *this;
2007-06-08 09:23:23 +00:00
that is the number of marked sub-expressions in the regular expression that
was matched plus one.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.max_size" > < / a > < pre class = "programlisting" > < span class = "identifier" > size_type< / span > < span class = "identifier" > max_size< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns the maximum number of
2008-12-23 11:46:00 +00:00
< a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
2007-06-08 09:23:23 +00:00
elements that can be stored in *this.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.empty" > < / a > < pre class = "programlisting" > < span class = "keyword" > bool< / span > < span class = "identifier" > empty< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns size() == 0.
2007-06-08 09:23:23 +00:00
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.length" > < / a > < pre class = "programlisting" > < span class = "identifier" > difference_type< / span > < span class = "identifier" > length< / span > < span class = "special" > (< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > difference_type< / span > < span class = "identifier" > length< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < span class = "identifier" > length< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < span class = "identifier" > length< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns the length of sub-expression
< span class = "emphasis" > < em > sub< / em > < / span > , that is to say: < code class = "computeroutput" > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )[< / span > < span class = "identifier" > sub< / span > < span class = "special" > ].< / span > < span class = "identifier" > length< / span > < span class = "special" > ()< / span > < / code > .
2007-06-08 09:23:23 +00:00
< / p >
2009-05-07 09:46:51 +00:00
< p >
The overloads that accept a string refer to a named sub-expression < span class = "emphasis" > < em > n< / em > < / span > .
2010-05-15 09:15:20 +00:00
In the event that there is no such named sub-expression then returns zero.
2009-05-07 09:46:51 +00:00
< / p >
< p >
The template overloads of this function, allow the string and/or character
type to be different from the character type of the underlying sequence and/or
regular expression: in this case the characters will be widened to the underlying
character type of the original regular expression. A compiler error will
occur if the argument passes a wider character type than the underlying sequence.
These overloads allow a normal narrow character C string literal to be used
as an argument, even when the underlying character type of the expression
being matched may be something more exotic such as a Unicode character type.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.position" > < / a > < pre class = "programlisting" > < span class = "identifier" > difference_type< / span > < span class = "identifier" > position< / span > < span class = "special" > (< / span > < span class = "keyword" > unsigned< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > difference_type< / span > < span class = "identifier" > position< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < span class = "identifier" > position< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > difference_type< / span > < span class = "identifier" > position< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns the starting location of
2007-06-08 09:23:23 +00:00
sub-expression < span class = "emphasis" > < em > sub< / em > < / span > , or -1 if < span class = "emphasis" > < em > sub< / em > < / span >
2007-12-14 10:11:21 +00:00
was not matched. Note that if this represents a partial match , then < code class = "computeroutput" > < span class = "identifier" > position< / span > < span class = "special" > ()< / span > < / code >
will return the location of the partial match even though < code class = "computeroutput" > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )[< / span > < span class = "number" > 0< / span > < span class = "special" > ].< / span > < span class = "identifier" > matched< / span > < / code >
2007-06-08 09:23:23 +00:00
is false.
< / p >
2009-05-07 09:46:51 +00:00
< p >
The overloads that accept a string refer to a named sub-expression < span class = "emphasis" > < em > n< / em > < / span > .
2010-05-15 09:15:20 +00:00
In the event that there is no such named sub-expression then returns -1.
2009-05-07 09:46:51 +00:00
< / p >
< p >
The template overloads of this function, allow the string and/or character
type to be different from the character type of the underlying sequence and/or
regular expression: in this case the characters will be widened to the underlying
character type of the original regular expression. A compiler error will
occur if the argument passes a wider character type than the underlying sequence.
These overloads allow a normal narrow character C string literal to be used
as an argument, even when the underlying character type of the expression
being matched may be something more exotic such as a Unicode character type.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.str" > < / a > < pre class = "programlisting" > < span class = "identifier" > string_type< / span > < span class = "identifier" > str< / span > < span class = "special" > (< / span > < span class = "keyword" > int< / span > < span class = "identifier" > sub< / span > < span class = "special" > =< / span > < span class = "number" > 0< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > string_type< / span > < span class = "identifier" > str< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < span class = "identifier" > str< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < span class = "identifier" > str< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > string_type< / span > < span class = "identifier" > str< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > sub< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns sub-expression < span class = "emphasis" > < em > sub< / em > < / span >
as a string: < code class = "computeroutput" > < span class = "identifier" > string_type< / span > < span class = "special" > ((*< / span > < span class = "keyword" > this< / span > < span class = "special" > )[< / span > < span class = "identifier" > sub< / span > < span class = "special" > ])< / span > < / code > .
2007-06-08 09:23:23 +00:00
< / p >
2009-05-07 09:46:51 +00:00
< p >
The overloads that accept a string, return the string that matched the named
sub-expression < span class = "emphasis" > < em > n< / em > < / span > . In the event that there is no such
named sub-expression then returns an empty string.
< / p >
< p >
The template overloads of this function, allow the string and/or character
type to be different from the character type of the underlying sequence and/or
regular expression: in this case the characters will be widened to the underlying
character type of the original regular expression. A compiler error will
occur if the argument passes a wider character type than the underlying sequence.
These overloads allow a normal narrow character C string literal to be used
as an argument, even when the underlying character type of the expression
being matched may be something more exotic such as a Unicode character type.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.subscript" > < / a > < pre class = "programlisting" > < span class = "identifier" > const_reference< / span > < span class = "keyword" > operator< / span > < span class = "special" > [](< / span > < span class = "keyword" > int< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2009-05-07 09:46:51 +00:00
< span class = "identifier" > const_reference< / span > < span class = "keyword" > operator< / span > < span class = "special" > [](< / span > < span class = "keyword" > const< / span > < span class = "identifier" > char_type< / span > < span class = "special" > *< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < span class = "keyword" > operator< / span > < span class = "special" > [](< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < span class = "keyword" > operator< / span > < span class = "special" > [](< / span > < span class = "keyword" > const< / span > < span class = "identifier" > charT< / span > < span class = "special" > *< / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
< span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > A< / span > < span class = "special" > > < / span >
< span class = "identifier" > const_reference< / span > < span class = "keyword" > operator< / span > < span class = "special" > [](< / span > < span class = "keyword" > const< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > Traits< / span > < span class = "special" > ,< / span > < span class = "identifier" > A< / span > < span class = "special" > > & < / span > < span class = "identifier" > n< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2008-12-23 11:46:00 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a reference to the < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
2007-06-08 09:23:23 +00:00
object representing the character sequence that matched marked sub-expression
2007-12-14 10:11:21 +00:00
< span class = "emphasis" > < em > n< / em > < / span > . If < code class = "computeroutput" > < span class = "identifier" > n< / span > < span class = "special" > ==< / span > < span class = "number" > 0< / span > < / code > then returns
2008-12-23 11:46:00 +00:00
a reference to a < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a > object representing the
2007-06-08 09:23:23 +00:00
character sequence that matched the whole regular expression. If < span class = "emphasis" > < em > n< / em > < / span >
is out of range, or if < span class = "emphasis" > < em > n< / em > < / span > is an unmatched sub-expression,
2008-12-23 11:46:00 +00:00
then returns a < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
2007-06-08 09:23:23 +00:00
object whose matched member is false.
< / p >
2009-05-07 09:46:51 +00:00
< p >
The overloads that accept a string, return a reference to the < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a > object representing the
character sequence that matched the named sub-expression < span class = "emphasis" > < em > n< / em > < / span > .
In the event that there is no such named sub-expression then returns a < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
object whose matched member is false.
< / p >
< p >
The template overloads of this function, allow the string and/or character
type to be different from the character type of the underlying sequence and/or
regular expression: in this case the characters will be widened to the underlying
character type of the original regular expression. A compiler error will
occur if the argument passes a wider character type than the underlying sequence.
These overloads allow a normal narrow character C string literal to be used
as an argument, even when the underlying character type of the expression
being matched may be something more exotic such as a Unicode character type.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.prefix" > < / a > < pre class = "programlisting" > < span class = "identifier" > const_reference< / span > < span class = "identifier" > prefix< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2008-12-23 11:46:00 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a reference to the < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
2007-06-08 09:23:23 +00:00
object representing the character sequence from the start of the string being
matched or searched, to the start of the match found.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.suffix" > < / a > < pre class = "programlisting" > < span class = "identifier" > const_reference< / span > < span class = "identifier" > suffix< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2008-12-23 11:46:00 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a reference to the < a class = "link" href = "sub_match.html" title = "sub_match" > < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < / code > < / a >
2007-06-08 09:23:23 +00:00
object representing the character sequence from the end of the match found
to the end of the string being matched or searched.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.begin" > < / a > < pre class = "programlisting" > < span class = "identifier" > const_iterator< / span > < span class = "identifier" > begin< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a starting iterator that
2007-06-08 09:23:23 +00:00
enumerates over all the marked sub-expression matches stored in *this.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.end" > < / a > < pre class = "programlisting" > < span class = "identifier" > const_iterator< / span > < span class = "identifier" > end< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a terminating iterator
2007-06-08 09:23:23 +00:00
that enumerates over all the marked sub-expression matches stored in *this.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results_format" > < / a > < a name = "boost_regex.match_results.format" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > OutputIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Formatter< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< span class = "identifier" > OutputIterator< / span > < span class = "identifier" > format< / span > < span class = "special" > (< / span > < span class = "identifier" > OutputIterator< / span > < span class = "identifier" > out< / span > < span class = "special" > ,< / span >
2009-10-30 17:25:12 +00:00
< span class = "identifier" > Formatter< / span > < span class = "identifier" > fmt< / span > < span class = "special" > ,< / span >
< span class = "identifier" > match_flag_type< / span > < span class = "identifier" > flags< / span > < span class = "special" > =< / span > < span class = "identifier" > format_default< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Requires< / strong > < / span > : The type < code class = "computeroutput" > < span class = "identifier" > OutputIterator< / span > < / code >
2007-06-08 09:23:23 +00:00
conforms to the Output Iterator requirements (C++ std 24.1.2).
< / p >
< p >
2009-10-30 17:25:12 +00:00
The type < code class = "computeroutput" > < span class = "identifier" > Formatter< / span > < / code > must be
either a pointer to a null-terminated string of type < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < span class = "special" > []< / span > < / code > , or be a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's
(for example < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > > < / span > < / code > )
or be a unary, binary or ternary functor that computes the replacement string
from a function call: either < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )< / span > < / code >
which must return a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's
to be used as the replacement text, or either < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span >
< span class = "identifier" > out< / span > < span class = "special" > )< / span > < / code >
or < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > out< / span > < span class = "special" > ,< / span > < span class = "identifier" > flags< / span > < span class = "special" > )< / span > < / code > , both of which write the replacement text
to < code class = "computeroutput" > < span class = "special" > *< / span > < span class = "identifier" > out< / span > < / code > ,
2010-03-17 18:20:09 +00:00
and then return the new OutputIterator position. Note that if the formatter
is a functor, then it is < span class = "emphasis" > < em > passed by value< / em > < / span > : users that
want to pass function objects with internal state might want to use < a href = "../../../../../../doc/html/ref.html" target = "_top" > Boost.Ref< / a > to wrap the object
so that it's passed by reference.
2009-10-30 17:25:12 +00:00
< / p >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2009-10-30 17:25:12 +00:00
< p >
< span class = "bold" > < strong > Effects< / strong > < / span > : If < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < / code >
is either a null-terminated string, or a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's,
then copies the character sequence < code class = "computeroutput" > < span class = "special" > [< / span > < span class = "identifier" > fmt< / span > < span class = "special" > .< / span > < span class = "identifier" > begin< / span > < span class = "special" > (),< / span > < span class = "identifier" > fmt< / span > < span class = "special" > .< / span > < span class = "identifier" > end< / span > < span class = "special" > ())< / span > < / code >
2007-12-14 10:11:21 +00:00
to < code class = "computeroutput" > < span class = "identifier" > OutputIterator< / span > < / code > < span class = "emphasis" > < em > out< / em > < / span > .
2007-06-08 09:23:23 +00:00
For each format specifier or escape sequence in < span class = "emphasis" > < em > fmt< / em > < / span > ,
replace that sequence with either the character(s) it represents, or the
2007-12-14 10:11:21 +00:00
sequence of characters within < code class = "computeroutput" > < span class = "special" > *< / span > < span class = "keyword" > this< / span > < / code > to which it refers. The bitmasks specified
2007-06-08 09:23:23 +00:00
in flags determines what format specifiers or escape sequences are recognized,
by default this is the format used by ECMA-262, ECMAScript Language Specification,
Chapter 15 part 5.4.11 String.prototype.replace.
< / p >
2009-10-30 17:25:12 +00:00
< p >
If < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < / code > is a function object,
then depending on the number of arguments the function object accepts, it
will either:
< / p >
2012-11-29 10:28:07 +00:00
< div class = "itemizedlist" > < ul class = "itemizedlist" style = "list-style-type: disc; " >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )< / span > < / code >
and copy the string returned to < code class = "computeroutput" > < span class = "identifier" > OutputIterator< / span > < / code >
< span class = "emphasis" > < em > out< / em > < / span > .
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > out< / span > < span class = "special" > )< / span > < / code > .
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > out< / span > < span class = "special" > ,< / span > < span class = "identifier" > flags< / span > < span class = "special" > )< / span > < / code > .
< / li >
2009-10-30 17:25:12 +00:00
< / ul > < / div >
< p >
In all cases the new position of the < code class = "computeroutput" > < span class = "identifier" > OutputIterator< / span > < / code >
is returned.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2008-12-23 11:46:00 +00:00
See the < a class = "link" href = "../format.html" title = "Search and Replace Format String Syntax" > format syntax guide for more information< / a > .
2007-06-08 09:23:23 +00:00
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Returns< / strong > < / span > : out.
2007-06-08 09:23:23 +00:00
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.format2" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > Formatter< / span > < span class = "special" > > < / span >
2009-10-30 17:25:12 +00:00
< span class = "identifier" > string_type< / span > < span class = "identifier" > format< / span > < span class = "special" > (< / span > < span class = "identifier" > Formatter< / span > < span class = "identifier" > fmt< / span > < span class = "special" > ,< / span >
< span class = "identifier" > match_flag_type< / span > < span class = "identifier" > flags< / span > < span class = "special" > =< / span > < span class = "identifier" > format_default< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2009-10-30 17:25:12 +00:00
< span class = "bold" > < strong > Requires< / strong > < / span > The type < code class = "computeroutput" > < span class = "identifier" > Formatter< / span > < / code >
must be either a pointer to a null-terminated string of type < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < span class = "special" > []< / span > < / code > ,
or be a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's
(for example < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > basic_string< / span > < span class = "special" > < < / span > < span class = "identifier" > char_type< / span > < span class = "special" > > < / span > < / code > )
or be a unary, binary or ternary functor that computes the replacement string
from a function call: either < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )< / span > < / code >
which must return a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's
to be used as the replacement text, or either < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span >
< span class = "identifier" > out< / span > < span class = "special" > )< / span > < / code >
or < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > out< / span > < span class = "special" > ,< / span > < span class = "identifier" > flags< / span > < span class = "special" > )< / span > < / code > , both of which write the replacement text
to < code class = "computeroutput" > < span class = "special" > *< / span > < span class = "identifier" > out< / span > < / code > ,
and then return the new OutputIterator position.
< / p >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2009-10-30 17:25:12 +00:00
< p >
< span class = "bold" > < strong > Effects< / strong > < / span > : If < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < / code >
is either a null-terminated string, or a container of < code class = "computeroutput" > < span class = "identifier" > char_type< / span > < / code > 's,
then copies the string < span class = "emphasis" > < em > fmt< / em > < / span > : For each format specifier
or escape sequence in < span class = "emphasis" > < em > fmt< / em > < / span > , replace that sequence with
either the character(s) it represents, or the sequence of characters within
< code class = "computeroutput" > < span class = "special" > *< / span > < span class = "keyword" > this< / span > < / code >
to which it refers. The bitmasks specified in flags determines what format
specifiers or escape sequences are recognized, by default this is the format
used by ECMA-262, ECMAScript Language Specification, Chapter 15 part 5.4.11
String.prototype.replace.
< / p >
< p >
If < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < / code > is a function object,
then depending on the number of arguments the function object accepts, it
will either:
< / p >
2012-11-29 10:28:07 +00:00
< div class = "itemizedlist" > < ul class = "itemizedlist" style = "list-style-type: disc; " >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )< / span > < / code >
and return the result.
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > unspecified< / span > < span class = "special" > -< / span > < span class = "identifier" > output< / span > < span class = "special" > -< / span > < span class = "identifier" > iterator< / span > < span class = "special" > )< / span > < / code > ,
where < code class = "computeroutput" > < span class = "identifier" > unspecified< / span > < span class = "special" > -< / span > < span class = "identifier" > output< / span > < span class = "special" > -< / span > < span class = "identifier" > iterator< / span > < / code > is an unspecified OutputIterator
type used to copy the output to the string result.
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
Call < code class = "computeroutput" > < span class = "identifier" > fmt< / span > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > ,< / span > < span class = "identifier" > unspecified< / span > < span class = "special" > -< / span > < span class = "identifier" > output< / span > < span class = "special" > -< / span > < span class = "identifier" > iterator< / span > < span class = "special" > ,< / span >
< span class = "identifier" > flags< / span > < span class = "special" > )< / span > < / code > ,
where < code class = "computeroutput" > < span class = "identifier" > unspecified< / span > < span class = "special" > -< / span > < span class = "identifier" > output< / span > < span class = "special" > -< / span > < span class = "identifier" > iterator< / span > < / code > is an unspecified OutputIterator
type used to copy the output to the string result.
< / li >
2009-10-30 17:25:12 +00:00
< / ul > < / div >
2007-06-08 09:23:23 +00:00
< p >
2008-12-23 11:46:00 +00:00
See the < a class = "link" href = "../format.html" title = "Search and Replace Format String Syntax" > format syntax guide for more information< / a > .
2007-06-08 09:23:23 +00:00
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.get_allocator" > < / a > < pre class = "programlisting" > < span class = "identifier" > allocator_type< / span > < span class = "identifier" > get_allocator< / span > < span class = "special" > ()< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Returns a copy of the Allocator
2007-06-08 09:23:23 +00:00
that was passed to the object's constructor.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.swap" > < / a > < pre class = "programlisting" > < span class = "keyword" > void< / span > < span class = "identifier" > swap< / span > < span class = "special" > (< / span > < span class = "identifier" > match_results< / span > < span class = "special" > & < / span > < span class = "identifier" > that< / span > < span class = "special" > );< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Swaps the contents of the two sequences.
2007-06-08 09:23:23 +00:00
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Postcondition< / strong > < / span > : *this contains the sequence
2007-06-08 09:23:23 +00:00
of matched sub-expressions that were in that, that contains the sequence
of matched sub-expressions that were in *this.
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Complexity< / strong > < / span > : constant time.
2007-06-08 09:23:23 +00:00
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.capture_type" > < / a > < pre class = "programlisting" > < span class = "keyword" > typedef< / span > < span class = "keyword" > typename< / span > < span class = "identifier" > value_type< / span > < span class = "special" > ::< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
< p >
Defines an implementation-specific type that satisfies the requirements of
a standard library Sequence (21.1.1 including the optional Table 68 operations),
2007-12-14 10:11:21 +00:00
whose value_type is a < code class = "computeroutput" > < span class = "identifier" > sub_match< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > < / span > < / code > . This type happens to be < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > vector< / span > < span class = "special" > < < / span > < span class = "identifier" > sub_match< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > > < / span > < span class = "special" > > < / span > < / code > ,
2007-06-08 09:23:23 +00:00
but you shouldn't actually rely on that.
< / p >
2011-12-24 17:51:57 +00:00
< a name = "boost_regex.match_results.captures" > < / a > < pre class = "programlisting" > < span class = "keyword" > const< / span > < span class = "identifier" > capture_sequence_type< / span > < span class = "special" > & < / span > < span class = "identifier" > captures< / span > < span class = "special" > (< / span > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > size_t< / span > < span class = "identifier" > i< / span > < span class = "special" > )< / span > < span class = "keyword" > const< / span > < span class = "special" > ;< / span >
2007-06-08 09:23:23 +00:00
< / pre >
2010-05-15 09:15:20 +00:00
< p >
< span class = "bold" > < strong > Requires< / strong > < / span > : that the match_results object
has been initialized as a result of a successful call to < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > or < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > or was returned from
a < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > ,
and that the underlying iterators have not been subsequently invalidated.
Will raise a < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > logic_error< / span > < / code > if the match_results object
was not initialized.
< / p >
2007-06-08 09:23:23 +00:00
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : returns a sequence containing all
2007-06-08 09:23:23 +00:00
the captures obtained for sub-expression i.
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Returns< / strong > < / span > : < code class = "computeroutput" > < span class = "special" > (*< / span > < span class = "keyword" > this< / span > < span class = "special" > )[< / span > < span class = "identifier" > i< / span > < span class = "special" > ].< / span > < span class = "identifier" > captures< / span > < span class = "special" > ();< / span > < / code >
2007-06-08 09:23:23 +00:00
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Preconditions< / strong > < / span > : the library must be built
2007-06-08 09:23:23 +00:00
and used with BOOST_REGEX_MATCH_EXTRA defined, and you must pass the flag
2008-12-23 11:46:00 +00:00
match_extra to the regex matching functions ( < a class = "link" href = "regex_match.html" title = "regex_match" > < code class = "computeroutput" > < span class = "identifier" > regex_match< / span > < / code > < / a > , < a class = "link" href = "regex_search.html" title = "regex_search" > < code class = "computeroutput" > < span class = "identifier" > regex_search< / span > < / code > < / a > , < a class = "link" href = "regex_iterator.html" title = "regex_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_iterator< / span > < / code > < / a > or < a class = "link" href = "regex_token_iterator.html" title = "regex_token_iterator" > < code class = "computeroutput" > < span class = "identifier" > regex_token_iterator< / span > < / code > < / a > ) in order for
2007-06-08 09:23:23 +00:00
this member function to be defined and return useful information.
< / p >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Rationale< / strong > < / span > : Enabling this feature has several
2007-06-08 09:23:23 +00:00
consequences:
< / p >
2012-11-29 10:28:07 +00:00
< div class = "itemizedlist" > < ul class = "itemizedlist" style = "list-style-type: disc; " >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
sub_match occupies more memory resulting in complex expressions running
out of memory or stack space more quickly during matching.
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
The matching algorithms are less efficient at handling some features
(independent sub-expressions for example), even when match_extra is not
used.
< / li >
2011-07-21 10:01:09 +00:00
< li class = "listitem" >
2010-07-08 22:49:58 +00:00
The matching algorithms are much less efficient (i.e. slower), when match_extra
is used. Mostly this is down to the extra memory allocations that have
to take place.
< / li >
2007-06-08 09:23:23 +00:00
< / ul > < / div >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.op_eq" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > bool< / span > < span class = "keyword" > operator< / span > < span class = "special" > ==< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Compares the two sequences for
2007-06-08 09:23:23 +00:00
equality.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.op_ne" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > bool< / span > < span class = "keyword" > operator< / span > < span class = "special" > !=< / span > < span class = "special" > (< / span > < span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Compares the two sequences for
2007-06-08 09:23:23 +00:00
inequality.
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.op_stream" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > traits< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< span class = "identifier" > basic_ostream< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > traits< / span > < span class = "special" > > & < / span >
< span class = "keyword" > operator< / span > < span class = "special" > < < < / span > < span class = "special" > (< / span > < span class = "identifier" > basic_ostream< / span > < span class = "special" > < < / span > < span class = "identifier" > charT< / span > < span class = "special" > ,< / span > < span class = "identifier" > traits< / span > < span class = "special" > > & < / span > < span class = "identifier" > os< / span > < span class = "special" > ,< / span >
< span class = "keyword" > const< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m< / span > < span class = "special" > );< / span >
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Writes the contents of < span class = "emphasis" > < em > m< / em > < / span >
to the stream < span class = "emphasis" > < em > os< / em > < / span > as if by calling < code class = "computeroutput" > < span class = "identifier" > os< / span >
< span class = "special" > < < < / span > < span class = "identifier" > m< / span > < span class = "special" > .< / span > < span class = "identifier" > str< / span > < span class = "special" > ()< / span > < / code > ;
2007-06-08 09:23:23 +00:00
Returns < span class = "emphasis" > < em > os< / em > < / span > .
< / p >
2011-01-01 12:27:00 +00:00
< a name = "boost_regex.match_results.op_swap" > < / a > < pre class = "programlisting" > < span class = "keyword" > template< / span > < span class = "special" > < < / span > < span class = "keyword" > class< / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "keyword" > class< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > < / span >
2007-06-08 09:23:23 +00:00
< span class = "keyword" > void< / span > < span class = "identifier" > swap< / span > < span class = "special" > (< / span > < span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m1< / span > < span class = "special" > ,< / span >
< span class = "identifier" > match_results< / span > < span class = "special" > < < / span > < span class = "identifier" > BidirectionalIterator< / span > < span class = "special" > ,< / span > < span class = "identifier" > Allocator< / span > < span class = "special" > > & < / span > < span class = "identifier" > m2< / span > < span class = "special" > );< / span >
< / pre >
< p >
2007-12-14 10:11:21 +00:00
< span class = "bold" > < strong > Effects< / strong > < / span > : Swaps the contents of the two sequences.
2007-06-08 09:23:23 +00:00
< / p >
< / div >
2024-03-23 19:03:45 +00:00
< div class = "copyright-footer" > Copyright © 1998-2013 John Maddock< p >
2007-11-07 03:23:31 +00:00
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt< / a > )
2007-12-14 10:11:21 +00:00
< / p >
2024-03-23 19:03:45 +00:00
< / div >
2007-06-08 09:23:23 +00:00
< hr >
< div class = "spirit-nav" >
2010-07-08 22:49:58 +00:00
< a accesskey = "p" href = "basic_regex.html" > < img src = "../../../../../../doc/src/images/prev.png" alt = "Prev" > < / a > < a accesskey = "u" href = "../ref.html" > < img src = "../../../../../../doc/src/images/up.png" alt = "Up" > < / a > < a accesskey = "h" href = "../../index.html" > < img src = "../../../../../../doc/src/images/home.png" alt = "Home" > < / a > < a accesskey = "n" href = "sub_match.html" > < img src = "../../../../../../doc/src/images/next.png" alt = "Next" > < / a >
2007-06-08 09:23:23 +00:00
< / div >
< / body >
< / html >
