doc/html/boost/algorithm/trim_fill_copy_if.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 trim_fill_copy_if</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.trim_all_hpp" title="Header &lt;boost/algorithm/string/trim_all.hpp&gt;">
  10 <link rel="prev" href="trim_all.html" title="Function template trim_all">
  11 <link rel="next" href="trim_fill_if.html" title="Function template trim_fill_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="trim_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.trim_all_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_fill_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.algorithm.trim_fill_copy_if"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template trim_fill_copy_if</span></h2>
  30 <p>boost::algorithm::trim_fill_copy_if &#8212; Trim Fill - parametric. </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.trim_all_hpp" title="Header &lt;boost/algorithm/string/trim_all.hpp&gt;">boost/algorithm/string/trim_all.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceT<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">SequenceT</span> <span class="identifier">trim_fill_copy_if</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SequenceT</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RangeT</span> <span class="special">&amp;</span> Fill<span class="special">,</span>
  38                               <span class="identifier">PredicateT</span> IsSpace<span class="special">)</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idp133597696"></a><h2>Description</h2>
  41 <p>Remove all leading and trailing spaces from the input and replace all every block of consecutive spaces with a fill string defined by user. The result is a trimmed copy of the input</p>
  42 <p>
  43
  44 </p>
  45 <div class="variablelist"><table border="0" class="variablelist compact">
  46 <colgroup>
  47 <col align="left" valign="top">
  48 <col>
  49 </colgroup>
  50 <tbody>
  51 <tr>
  52 <td><p><span class="term">Parameters:</span></p></td>
  53 <td><div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody>
  59 <tr>
  60 <td><p><span class="term"><code class="computeroutput">Fill</code></span></p></td>
  61 <td><p>A string used to fill the inner spaces </p></td>
  62 </tr>
  63 <tr>
  64 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  65 <td><p>An input sequence </p></td>
  66 </tr>
  67 <tr>
  68 <td><p><span class="term"><code class="computeroutput">IsSpace</code></span></p></td>
  69 <td><p>A unary predicate identifying spaces </p></td>
  70 </tr>
  71 </tbody>
  72 </table></div></td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term">Returns:</span></p></td>
  76 <td><p>A trimmed copy of the input </p></td>
  77 </tr>
  78 </tbody>
  79 </table></div>
  80 </div>
  81 </div>
  82 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83 <td align="left"></td>
  84 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
  85                 Software License, Version 1.0. (See accompanying file
  86                 <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>)
  87             </p>
  88 </div></td>
  89 </tr></table>
  90 <hr>
  91 <div class="spirit-nav">
  92 <a accesskey="p" href="trim_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.trim_all_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_fill_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  93 </div>
  94 </body>
  95 </html>