summaryrefslogtreecommitdiff
path: root/doc/html/erase_head_copy.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/erase_head_copy.html')
-rw-r--r--doc/html/erase_head_copy.html70
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/html/erase_head_copy.html b/doc/html/erase_head_copy.html
new file mode 100644
index 0000000000..50a1e84501
--- /dev/null
+++ b/doc/html/erase_head_copy.html
@@ -0,0 +1,70 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Function erase_head_copy</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#id2571451" title="Header &lt;boost/algorithm/string/erase.hpp&gt;">
+<link rel="prev" href="ierase_all.html" title="Function template ierase_all">
+<link rel="next" href="erase_head.html" title="Function template erase_head">
+</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="ierase_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2571451"><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="erase_head.html"><img src="images/next.png" alt="Next"></a>
+</div>
+<div class="refentry" lang="en">
+<a name="erase_head_copy"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Function erase_head_copy</span></h2>
+<p>boost::algorithm::erase_head_copy &#8212; Erase head 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>&lt;<span class="bold"><strong>typename</strong></span> OutputIteratorT, <span class="bold"><strong>typename</strong></span> RangeT&gt;
+  <span class="type">OutputIteratorT</span>
+  erase_head_copy(OutputIteratorT Output, <span class="bold"><strong>const</strong></span> RangeT &amp; Input,
+                  <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>int</strong></span> N);
+<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> SequenceT&gt;
+  <span class="type">SequenceT</span> erase_head_copy(<span class="bold"><strong>const</strong></span> SequenceT &amp; Input, <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>int</strong></span> N);</pre></div>
+<div class="refsect1" lang="en">
+<a name="id2754192"></a><h2>Description</h2>
+<p>Remove the head from the input. The head is a prefix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the head. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</p>
+<p></p>
+<div class="variablelist">
+<p class="title"><b>Parameters</b></p>
+<dl>
+<dt><span class="term">Input</span></dt>
+<dd><p>An input string </p></dd>
+<dt><span class="term">N</span></dt>
+<dd><p>Length of the head </p></dd>
+<dt><span class="term">Output</span></dt>
+<dd><p>An output iterator to which the result will be copied </p></dd>
+</dl>
+</div>
+<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
+
+ An output iterator pointing just after the last inserted character or a modified copy of the input<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:
+
+ The second variant of this function provides the strong exception-safety guarantee </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="ierase_all.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2571451"><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="erase_head.html"><img src="images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>