diff options
Diffstat (limited to 'doc/html/boost/algorithm/split_id819641.html')
-rw-r--r-- | doc/html/boost/algorithm/split_id819641.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/doc/html/boost/algorithm/split_id819641.html b/doc/html/boost/algorithm/split_id819641.html new file mode 100644 index 0000000000..d95687cab9 --- /dev/null +++ b/doc/html/boost/algorithm/split_id819641.html @@ -0,0 +1,106 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template split</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp" title="Header <boost/algorithm/string/split.hpp>"> +<link rel="prev" href="ifind_all.html" title="Function template ifind_all"> +<link rel="next" href="trim_left_copy_if.html" title="Function trim_left_copy_if"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<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> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ifind_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp"><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="trim_left_copy_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.algorithm.split_id819641"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template split</span></h2> +<p>boost::algorithm::split — Split 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="comment">// In header: <<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp" title="Header <boost/algorithm/string/split.hpp>">boost/algorithm/string/split.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SequenceSequenceT<span class="special">,</span> <span class="keyword">typename</span> RangeT<span class="special">,</span> <span class="keyword">typename</span> PredicateT<span class="special">></span> + <span class="identifier">SequenceSequenceT</span> <span class="special">&</span> + <span class="identifier">split</span><span class="special">(</span><span class="identifier">SequenceSequenceT</span> <span class="special">&</span> Result<span class="special">,</span> <span class="identifier">RangeT</span> <span class="special">&</span> Input<span class="special">,</span> <span class="identifier">PredicateT</span> Pred<span class="special">,</span> + <span class="identifier">token_compress_mode_type</span> eCompress <span class="special">=</span> <span class="identifier">token_compress_off</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id3309138"></a><h2>Description</h2> +<p>Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separators are given by means of the predicate.</p> +<p>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<std::string></code> or <code class="computeroutput">std::list<boost::iterator_range<std::string::iterator>></code> </p> +<p> + +</p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Prior content of the result will be overwritten.</p> +<p>This function provides the strong exception-safety guarantee </p> +</td></tr> +</table></div> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td> +<td><p>A container which will be searched. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">Pred</code></span></p></td> +<td><p>A predicate to identify separators. This predicate is supposed to return true if a given element is a separator. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">Result</code></span></p></td> +<td><p>A container that can hold copies of references to the substrings </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">eCompress</code></span></p></td> +<td><p>If eCompress argument is set to token_compress_on, adjacent separators are merged together. Otherwise, every two separators delimit a token. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>A reference the result</p></td> +</tr> +</tbody> +</table></div> +</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"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost + Software License, Version 1.0. (See accompanying file + <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ifind_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp"><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="trim_left_copy_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |