Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/find_iterator.html @ 25

Last change on this file since 25 was 12, checked in by landauf, 17 years ago

added boost
File size: 8.0 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template find_iterator</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="string_algo/reference.html#id2382464" title="Header &lt;boost/algorithm/string/find_iterator.hpp&gt;">
9<link rel="prev" href="id2586835.html" title="Function template regex_formatter">
10<link rel="next" href="split_iterator.html" title="Class template split_iterator">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="id2586835.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2382464"><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="split_iterator.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="find_iterator"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template find_iterator</span></h2>
29<p>boost::algorithm::find_iterator &#8212; find_iterator </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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> IteratorT&gt; 
33<span class="bold"><strong>class</strong></span> find_iterator {
34<span class="bold"><strong>public</strong></span>:
35  <span class="emphasis"><em>// <a href="find_iterator.html#find_iteratorconstruct-copy-destruct">construct/copy/destruct</a></em></span>
36  <a href="find_iterator.html#id2479359-bb">find_iterator</a>();
37  <a href="find_iterator.html#id2559405-bb">find_iterator</a>(<span class="bold"><strong>const</strong></span> <a href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp;);
38  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT&gt; <a href="find_iterator.html#id2506218-bb">find_iterator</a>(IteratorT, IteratorT, FinderT);
39  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT, <span class="bold"><strong>typename</strong></span> RangeT&gt; <a href="find_iterator.html#id2362903-bb">find_iterator</a>(RangeT &amp;, FinderT);
40
41  <span class="emphasis"><em>// <a href="find_iterator.html#id2380448-bb">public member functions</a></em></span>
42  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="find_iterator.html#id2380453-bb">eof</a>() <span class="bold"><strong>const</strong></span>;
43
44  <span class="emphasis"><em>// <a href="find_iterator.html#id2493799-bb">private member functions</a></em></span>
45  <span class="type"><span class="bold"><strong>const</strong></span> match_type &amp;</span> <a href="find_iterator.html#id2493803-bb">dereference</a>() <span class="bold"><strong>const</strong></span>;
46  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="find_iterator.html#id2377799-bb">increment</a>() ;
47  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="find_iterator.html#id2377811-bb">equal</a>(<span class="bold"><strong>const</strong></span> <a href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp;) <span class="bold"><strong>const</strong></span>;
48};</pre></div>
49<div class="refsect1" lang="en">
50<a name="id2758041"></a><h2>Description</h2>
51<p>Find iterator encapsulates a Finder and allows for incremental searching in a string. Each increment moves the iterator to the next match.</p>
52<p>Find iterator is a readable forward traversal iterator.</p>
53<p>Dereferencing the iterator yields an iterator_range delimiting the current match. </p>
54<div class="refsect2" lang="en">
55<a name="id2758056"></a><h3>
56<a name="find_iteratorconstruct-copy-destruct"></a><code class="computeroutput">find_iterator</code> construct/copy/destruct</h3>
57<div class="orderedlist"><ol type="1">
58<li>
59<pre class="literallayout"><a name="id2479359-bb"></a>find_iterator();</pre>
60<p>Construct null iterator. All null iterators are equal.</p>
61<p></p>
62<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Postconditions</span></b>:
63
64    eof()==true </p>
65</li>
66<li>
67<pre class="literallayout"><a name="id2559405-bb"></a>find_iterator(<span class="bold"><strong>const</strong></span> <a href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp; Other);</pre>
68<p>Construct a copy of the find_iterator </p>
69</li>
70<li>
71<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT&gt; 
72  <a name="id2506218-bb"></a>find_iterator(IteratorT Begin, IteratorT End, FinderT Finder);</pre>
73<p>Construct new find_iterator for a given finder and a range. </p>
74</li>
75<li>
76<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT, <span class="bold"><strong>typename</strong></span> RangeT&gt; 
77  <a name="id2362903-bb"></a>find_iterator(RangeT &amp; Col, FinderT Finder);</pre>
78<p>Construct new find_iterator for a given finder and a range. </p>
79</li>
80</ol></div>
81</div>
82<div class="refsect2" lang="en">
83<a name="id2758200"></a><h3>
84<a name="id2380448-bb"></a><code class="computeroutput">find_iterator</code> public member functions</h3>
85<div class="orderedlist"><ol type="1"><li>
86<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id2380453-bb"></a>eof() <span class="bold"><strong>const</strong></span>;</pre>
87<p>Check the eof condition. Eof condition means that there is nothing more to be searched i.e. find_iterator is after the last match. </p>
88</li></ol></div>
89</div>
90<div class="refsect2" lang="en">
91<a name="id2758250"></a><h3>
92<a name="id2493799-bb"></a><code class="computeroutput">find_iterator</code> private member functions</h3>
93<div class="orderedlist"><ol type="1">
94<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> match_type &amp;</span> <a name="id2493803-bb"></a>dereference() <span class="bold"><strong>const</strong></span>;</pre></li>
95<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2377799-bb"></a>increment() ;</pre></li>
96<li><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id2377811-bb"></a>equal(<span class="bold"><strong>const</strong></span> <a href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp; Other) <span class="bold"><strong>const</strong></span>;</pre></li>
97</ol></div>
98</div>
99</div>
100</div>
101<table width="100%"><tr>
102<td align="left"></td>
103<td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td>
104</tr></table>
105<hr>
106<div class="spirit-nav">
107<a accesskey="p" href="id2586835.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id2382464"><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="split_iterator.html"><img src="images/next.png" alt="Next"></a>
108</div>
109</body>
110</html>
Note: See TracBrowser for help on using the repository browser.