Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / algorithm / find_tail.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 find_tail</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.find_hpp" title="Header &lt;boost/algorithm/string/find.hpp&gt;">
10 <link rel="prev" href="find_head.html" title="Function template find_head">
11 <link rel="next" href="find_token.html" title="Function template find_token">
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="find_head.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_token.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.algorithm.find_tail"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Function template find_tail</span></h2>
30 <p>boost::algorithm::find_tail &#8212; Find tail 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.find_hpp" title="Header &lt;boost/algorithm/string/find.hpp&gt;">boost/algorithm/string/find.hpp</a>&gt;
34
35 </span>
36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span> 
37   <span class="identifier">iterator_range</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span> 
38   <span class="identifier">find_tail</span><span class="special">(</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></pre></div>
39 <div class="refsect1">
40 <a name="idp128130176"></a><h2>Description</h2>
41 <p>Get the tail of the input. Tail is a suffix of the string of the given size. If the input is shorter then required, whole input is considered to be the tail.</p>
42 <p>
43
44 </p>
45 <div class="note"><table border="0" summary="Note">
46 <tr>
47 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
48 <th align="left">Note</th>
49 </tr>
50 <tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr>
51 </table></div>
52 <p>
53 </p>
54 <div class="variablelist"><table border="0" class="variablelist compact">
55 <colgroup>
56 <col align="left" valign="top">
57 <col>
58 </colgroup>
59 <tbody>
60 <tr>
61 <td><p><span class="term">Parameters:</span></p></td>
62 <td><div class="variablelist"><table border="0" class="variablelist compact">
63 <colgroup>
64 <col align="left" valign="top">
65 <col>
66 </colgroup>
67 <tbody>
68 <tr>
69 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
70 <td><p>An input string </p></td>
71 </tr>
72 <tr>
73 <td><p><span class="term"><code class="computeroutput">N</code></span></p></td>
74 <td><p>Length of the tail. For N&gt;=0, at most N characters are extracted. For N&lt;0, at most size(Input)-|N| characters are extracted. </p></td>
75 </tr>
76 </tbody>
77 </table></div></td>
78 </tr>
79 <tr>
80 <td><p><span class="term">Returns:</span></p></td>
81 <td><p>An <code class="computeroutput">iterator_range</code> delimiting the match. Returned iterator is either <code class="computeroutput">RangeT::iterator</code> or <code class="computeroutput">RangeT::const_iterator</code>, depending on the constness of the input parameter.</p></td>
82 </tr>
83 </tbody>
84 </table></div>
85 </div>
86 </div>
87 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
88 <td align="left"></td>
89 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
90                 Software License, Version 1.0. (See accompanying file
91                 <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>)
92             </p>
93 </div></td>
94 </tr></table>
95 <hr>
96 <div class="spirit-nav">
97 <a accesskey="p" href="find_head.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_token.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
98 </div>
99 </body>
100 </html>