doc/html/boost/algorithm/split_idp547505328.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function template split</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp" title="Header &lt;boost/algorithm/string/split.hpp&gt;">
  10 <link rel="prev" href="ifind_all.html" title="Function template ifind_all">
  11 <link rel="next" href="trim_left_copy_if.html" title="Function trim_left_copy_if">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.algorithm.split_idp547505328"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template split</span></h2>
  30 <p>boost::algorithm::split &#8212; Split algorithm. </p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.split_hpp" title="Header &lt;boost/algorithm/string/split.hpp&gt;">boost/algorithm/string/split.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  37   <span class="identifier">SequenceSequenceT</span> <span class="special">&amp;</span>
  38   <span class="identifier">split</span><span class="special">(</span><span class="identifier">SequenceSequenceT</span> <span class="special">&amp;</span> Result<span class="special">,</span> <span class="identifier">RangeT</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="identifier">PredicateT</span> Pred<span class="special">,</span>
  39         <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>
  40 <div class="refsect1">
  41 <a name="idp121437808"></a><h2>Description</h2>
  42 <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>
  43 <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&lt;std::string&gt;</code> or <code class="computeroutput">std::list&lt;boost::iterator_range&lt;std::string::iterator&gt;&gt;</code> </p>
  44 <p>
  45
  46 </p>
  47 <div class="note"><table border="0" summary="Note">
  48 <tr>
  49 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  50 <th align="left">Note</th>
  51 </tr>
  52 <tr><td align="left" valign="top">
  53 <p>Prior content of the result will be overwritten.</p>
  54 <p>This function provides the strong exception-safety guarantee </p>
  55 </td></tr>
  56 </table></div>
  57 <p>
  58 </p>
  59 <div class="variablelist"><table border="0" class="variablelist compact">
  60 <colgroup>
  61 <col align="left" valign="top">
  62 <col>
  63 </colgroup>
  64 <tbody>
  65 <tr>
  66 <td><p><span class="term">Parameters:</span></p></td>
  67 <td><div class="variablelist"><table border="0" class="variablelist compact">
  68 <colgroup>
  69 <col align="left" valign="top">
  70 <col>
  71 </colgroup>
  72 <tbody>
  73 <tr>
  74 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  75 <td><p>A container which will be searched. </p></td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term"><code class="computeroutput">Pred</code></span></p></td>
  79 <td><p>A predicate to identify separators. This predicate is supposed to return true if a given element is a separator. </p></td>
  80 </tr>
  81 <tr>
  82 <td><p><span class="term"><code class="computeroutput">Result</code></span></p></td>
  83 <td><p>A container that can hold copies of references to the substrings </p></td>
  84 </tr>
  85 <tr>
  86 <td><p><span class="term"><code class="computeroutput">eCompress</code></span></p></td>
  87 <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>
  88 </tr>
  89 </tbody>
  90 </table></div></td>
  91 </tr>
  92 <tr>
  93 <td><p><span class="term">Returns:</span></p></td>
  94 <td><p>A reference the result</p></td>
  95 </tr>
  96 </tbody>
  97 </table></div>
  98 </div>
  99 </div>
 100 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 101 <td align="left"></td>
 102 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
 103                 Software License, Version 1.0. (See accompanying file
 104                 <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>)
 105             </p>
 106 </div></td>
 107 </tr></table>
 108 <hr>
 109 <div class="spirit-nav">
 110 <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>
 111 </div>
 112 </body>
 113 </html>