doc/html/boost/algorithm/erase_tail_copy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function erase_tail_copy</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.erase_hpp" title="Header &lt;boost/algorithm/string/erase.hpp&gt;">
   9 <link rel="prev" href="erase_head.html" title="Function template erase_head">
  10 <link rel="next" href="erase_tail.html" title="Function template erase_tail">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="erase_head.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.erase_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="erase_tail.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.erase_tail_copy"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function erase_tail_copy</span></h2>
  29 <p>boost::algorithm::erase_tail_copy &#8212; Erase tail 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"><span class="comment">// In header: &lt;<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.erase_hpp" title="Header &lt;boost/algorithm/string/erase.hpp&gt;">boost/algorithm/string/erase.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIteratorT<span class="special">,</span> <span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
  36   <span class="identifier">OutputIteratorT</span>
  37   <span class="identifier">erase_tail_copy</span><span class="special">(</span><span class="identifier">OutputIteratorT</span> Output<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RangeT</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="keyword">int</span> N<span class="special">)</span><span class="special">;</span>
  38 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceT<span class="special">&gt;</span>
  39   <span class="identifier">SequenceT</span> <span class="identifier">erase_tail_copy</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">int</span> N<span class="special">)</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp433782992"></a><h2>Description</h2>
  42 <p>Remove the tail from the input. The tail is a suffix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the tail. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
  43 <p>
  44
  45 </p>
  46 <div class="note"><table border="0" summary="Note">
  47 <tr>
  48 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  49 <th align="left">Note</th>
  50 </tr>
  51 <tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr>
  52 </table></div>
  53 <p>
  54 </p>
  55 <div class="variablelist"><table border="0" class="variablelist compact">
  56 <colgroup>
  57 <col align="left" valign="top">
  58 <col>
  59 </colgroup>
  60 <tbody>
  61 <tr>
  62 <td><p><span class="term">Parameters:</span></p></td>
  63 <td><div class="variablelist"><table border="0" class="variablelist compact">
  64 <colgroup>
  65 <col align="left" valign="top">
  66 <col>
  67 </colgroup>
  68 <tbody>
  69 <tr>
  70 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  71 <td><p>An input string </p></td>
  72 </tr>
  73 <tr>
  74 <td><p><span class="term"><code class="computeroutput">N</code></span></p></td>
  75 <td><p>Length of the tail. For N&gt;=0, at most N characters are extracted. For N&lt;0, size(Input)-|N| characters are extracted. </p></td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term"><code class="computeroutput">Output</code></span></p></td>
  79 <td><p>An output iterator to which the result will be copied </p></td>
  80 </tr>
  81 </tbody>
  82 </table></div></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term">Returns:</span></p></td>
  86 <td><p>An output iterator pointing just after the last inserted character or a modified copy of the input</p></td>
  87 </tr>
  88 </tbody>
  89 </table></div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
  95                 Software License, Version 1.0. (See accompanying file
  96                 <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>)
  97             </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="erase_head.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.erase_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="erase_tail.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>