| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Function template split</title> |
|---|
| 5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> |
|---|
| 7 | <link rel="start" href="index.html" title="The Boost C++ Libraries"> |
|---|
| 8 | <link rel="up" href="string_algo/reference.html#id2541245" title="Header <boost/algorithm/string/split.hpp>"> |
|---|
| 9 | <link rel="prev" href="ifind_all.html" title="Function template ifind_all"> |
|---|
| 10 | <link rel="next" href="trim_left_copy_if.html" title="Function trim_left_copy_if"> |
|---|
| 11 | </head> |
|---|
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 13 | <table cellpadding="2" width="100%"> |
|---|
| 14 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> |
|---|
| 15 | <td align="center"><a href="../../index.htm">Home</a></td> |
|---|
| 16 | <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> |
|---|
| 17 | <td align="center"><a href="../../people/people.htm">People</a></td> |
|---|
| 18 | <td align="center"><a href="../../more/faq.htm">FAQ</a></td> |
|---|
| 19 | <td align="center"><a href="../../more/index.htm">More</a></td> |
|---|
| 20 | </table> |
|---|
| 21 | <hr> |
|---|
| 22 | <div class="spirit-nav"> |
|---|
| 23 | <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> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="refentry" lang="en"> |
|---|
| 26 | <a name="id2580251"></a><div class="titlepage"></div> |
|---|
| 27 | <div class="refnamediv"> |
|---|
| 28 | <h2><span class="refentrytitle">Function template split</span></h2> |
|---|
| 29 | <p>boost::algorithm::split — Split algorithm. </p> |
|---|
| 30 | </div> |
|---|
| 31 | <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
|---|
| 32 | <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"> |
|---|
| 33 | <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> |
|---|
| 34 | <span class="type">SequenceSequenceT &</span> |
|---|
| 35 | split(SequenceSequenceT & Result, RangeT & Input, PredicateT Pred, |
|---|
| 36 | token_compress_mode_type eCompress = token_compress_off);</pre></div> |
|---|
| 37 | <div class="refsect1" lang="en"> |
|---|
| 38 | <a name="id2772641"></a><h2>Description</h2> |
|---|
| 39 | <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> |
|---|
| 40 | <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> |
|---|
| 41 | <p></p> |
|---|
| 42 | <div class="variablelist"> |
|---|
| 43 | <p class="title"><b>Parameters</b></p> |
|---|
| 44 | <dl> |
|---|
| 45 | <dt><span class="term">Input</span></dt> |
|---|
| 46 | <dd><p>A container which will be searched. </p></dd> |
|---|
| 47 | <dt><span class="term">Pred</span></dt> |
|---|
| 48 | <dd><p>A predicate to identify separators. This predicate is supposed to return true if a given element is a separator. </p></dd> |
|---|
| 49 | <dt><span class="term">Result</span></dt> |
|---|
| 50 | <dd><p>A container that can hold copies of references to the substrings </p></dd> |
|---|
| 51 | <dt><span class="term">eCompress</span></dt> |
|---|
| 52 | <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> |
|---|
| 53 | </dl> |
|---|
| 54 | </div> |
|---|
| 55 | <p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>: |
|---|
| 56 | |
|---|
| 57 | A reference the result<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>: |
|---|
| 58 | |
|---|
| 59 | Prior content of the result will be overwritten.<p>This function provides the strong exception-safety guarantee </p></p> |
|---|
| 60 | </div> |
|---|
| 61 | </div> |
|---|
| 62 | <table width="100%"><tr> |
|---|
| 63 | <td align="left"></td> |
|---|
| 64 | <td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td> |
|---|
| 65 | </tr></table> |
|---|
| 66 | <hr> |
|---|
| 67 | <div class="spirit-nav"> |
|---|
| 68 | <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> |
|---|
| 69 | </div> |
|---|
| 70 | </body> |
|---|
| 71 | </html> |
|---|
