summaryrefslogtreecommitdiff
path: root/doc/html/split_regex.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/split_regex.html')
-rw-r--r--doc/html/split_regex.html72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/html/split_regex.html b/doc/html/split_regex.html
new file mode 100644
index 0000000000..bb682f4a92
--- /dev/null
+++ b/doc/html/split_regex.html
@@ -0,0 +1,72 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Function template split_regex</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="index.html" title="The Boost C++ Libraries">
+<link rel="up" href="string_algo/reference.html#id687854" title="Header &lt;boost/algorithm/string/regex.hpp&gt;">
+<link rel="prev" href="find_all_regex.html" title="Function template find_all_regex">
+<link rel="next" href="id1109157.html" title="Function template regex_finder">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
+<td align="center"><a href="../../index.htm">Home</a></td>
+<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="../../people/people.htm">People</a></td>
+<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
+<td align="center"><a href="../../more/index.htm">More</a></td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="find_all_regex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id687854"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1109157.html"><img src="images/next.png" alt="Next"></a>
+</div>
+<div class="refentry" lang="en">
+<a name="split_regex"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Function template split_regex</span></h2>
+<p>boost::algorithm::split_regex &#8212; Split regex algorithm. </p>
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
+<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> SequenceSequenceT, <span class="bold"><strong>typename</strong></span> RangeT, <span class="bold"><strong>typename</strong></span> CharT,
+         <span class="bold"><strong>typename</strong></span> RegexTraitsT&gt;
+  <span class="type">SequenceSequenceT &amp;</span>
+  split_regex(SequenceSequenceT &amp; Result, <span class="bold"><strong>const</strong></span> RangeT &amp; Input,
+              <span class="bold"><strong>const</strong></span> basic_regex&lt; CharT, RegexTraitsT &gt; &amp; Rx,
+              match_flag_type Flags = match_default);</pre></div>
+<div class="refsect1" lang="en">
+<a name="id1347891"></a><h2>Description</h2>
+<p>Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separator is an every match of the given regex. Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <code class="computeroutput">std::vector&lt;std::string&gt;</code> or <code class="computeroutput">std::list&lt;boost::iterator_range&lt;std::string::iterator&gt;&gt;</code></p>
+<p></p>
+<div class="variablelist">
+<p class="title"><b>Parameters</b></p>
+<dl>
+<dt><span class="term">Flags</span></dt>
+<dd><p>Regex options </p></dd>
+<dt><span class="term">Input</span></dt>
+<dd><p>A container which will be searched. </p></dd>
+<dt><span class="term">Result</span></dt>
+<dd><p>A container that can hold copies of references to the substrings. </p></dd>
+<dt><span class="term">Rx</span></dt>
+<dd><p>A regular expression </p></dd>
+</dl>
+</div>
+<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
+
+ A reference to the result<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
+
+ Prior content of the result will be overwritten.<p>This function provides the strong exception-safety guarantee </p></p>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="find_all_regex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id687854"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id1109157.html"><img src="images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>