diff options
Diffstat (limited to 'doc/html/id2580251.html')
-rw-r--r-- | doc/html/id2580251.html | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/html/id2580251.html b/doc/html/id2580251.html new file mode 100644 index 0000000000..4746aa43cb --- /dev/null +++ b/doc/html/id2580251.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Function template split</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="string_algo/reference.html#id2541245" 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%"> +<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="ifind_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2541245"><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="trim_left_copy_if.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="id2580251"></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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> SequenceSequenceT, <span class="bold"><strong>typename</strong></span> RangeT, <span class="bold"><strong>typename</strong></span> PredicateT> + <span class="type">SequenceSequenceT &</span> + split(SequenceSequenceT & Result, RangeT & Input, PredicateT Pred, + token_compress_mode_type eCompress = token_compress_off);</pre></div> +<div class="refsect1" lang="en"> +<a name="id2772641"></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="variablelist"> +<p class="title"><b>Parameters</b></p> +<dl> +<dt><span class="term">Input</span></dt> +<dd><p>A container which will be searched. </p></dd> +<dt><span class="term">Pred</span></dt> +<dd><p>A predicate to identify separators. This predicate is supposed to return true if a given element is a separator. </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">eCompress</span></dt> +<dd><p>If eCompress argument is set to token_compress_on, adjacent separators are merged together. Otherwise, every two separators delimit a token. </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 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 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="ifind_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2541245"><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="trim_left_copy_if.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |