diff options
Diffstat (limited to 'doc/html/boost/algorithm/find_head.html')
| -rwxr-xr-x | doc/html/boost/algorithm/find_head.html | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/html/boost/algorithm/find_head.html b/doc/html/boost/algorithm/find_head.html new file mode 100755 index 0000000000..c5284e736a --- /dev/null +++ b/doc/html/boost/algorithm/find_head.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template find_head</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.find_hpp" title="Header <boost/algorithm/string/find.hpp>"> +<link rel="prev" href="ifind_nth.html" title="Function template ifind_nth"> +<link rel="next" href="find_tail.html" title="Function template find_tail"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ifind_nth.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_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="find_tail.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.algorithm.find_head"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template find_head</span></h2> +<p>boost::algorithm::find_head — Find 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="comment">// In header: <<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.find_hpp" title="Header <boost/algorithm/string/find.hpp>">boost/algorithm/string/find.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RangeT<span class="special">></span> + <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">RangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">></span> + <span class="identifier">find_head</span><span class="special">(</span><span class="identifier">RangeT</span> <span class="special">&</span> Input<span class="special">,</span> <span class="keyword">int</span> N<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id3212920"></a><h2>Description</h2> +<p>Get the head of the input. Head is a prefix of the string of the given size. If the input is shorter then required, whole input if considered to be the head.</p> +<p> + +</p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr> +</table></div> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td> +<td><p>An input string </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">N</code></span></p></td> +<td><p>Length of the head For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>An <code class="computeroutput">iterator_range</code> delimiting the match. Returned iterator is either <code class="computeroutput">Range1T::iterator</code> or <code class="computeroutput">Range1T::const_iterator</code>, depending on the constness of the input parameter.</p></td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost + Software License, Version 1.0. (See accompanying file + <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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="ifind_nth.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_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="find_tail.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |