File: find_iterator.html

package info (click to toggle)
boost1.42 1.42.0-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 277,864 kB
  • ctags: 401,076
  • sloc: cpp: 1,235,659; xml: 74,142; ansic: 41,313; python: 26,756; sh: 11,840; cs: 2,118; makefile: 655; perl: 494; yacc: 456; asm: 353; csh: 6
file content (118 lines) | stat: -rwxr-xr-x 10,161 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template find_iterator</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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_iterator_hpp" title="Header &lt;boost/algorithm/string/find_iterator.hpp&gt;">
<link rel="prev" href="find_format_all.html" title="Function template find_format_all">
<link rel="next" href="split_iterator.html" title="Class template split_iterator">
</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="find_format_all.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_iterator_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="split_iterator.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template find_iterator">
<a name="boost.algorithm.find_iterator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template find_iterator</span></h2>
<p>boost::algorithm::find_iterator &#8212; find_iterator </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="emphasis"><em>// In header: &lt;<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.find_iterator_hpp" title="Header &lt;boost/algorithm/string/find_iterator.hpp&gt;">boost/algorithm/string/find_iterator.hpp</a>&gt;

</em></span><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> IteratorT&gt; 
<span class="bold"><strong>class</strong></span> <a class="link" href="find_iterator.html" title="Class template find_iterator">find_iterator</a> {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// <a class="link" href="find_iterator.html#boost.algorithm.find_iteratorconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a class="link" href="find_iterator.html#id1112029-bb">find_iterator</a>();
  <a class="link" href="find_iterator.html#id622570-bb">find_iterator</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp;);
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT&gt; <a class="link" href="find_iterator.html#id622944-bb">find_iterator</a>(IteratorT, IteratorT, FinderT);
  <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 class="link" href="find_iterator.html#id655407-bb">find_iterator</a>(RangeT &amp;, FinderT);

  <span class="emphasis"><em>// <a class="link" href="find_iterator.html#id623699-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="find_iterator.html#id1112014-bb">eof</a>() <span class="bold"><strong>const</strong></span>;

  <span class="emphasis"><em>// <a class="link" href="find_iterator.html#id701400-bb">private member functions</a></em></span>
  <span class="type"><span class="bold"><strong>const</strong></span> match_type &amp;</span> <a class="link" href="find_iterator.html#id701403-bb">dereference</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="find_iterator.html#id701411-bb">increment</a>() ;
  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="find_iterator.html#id701419-bb">equal</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp;) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1737132"></a><h2>Description</h2>
<p>Find iterator encapsulates a Finder and allows for incremental searching in a string. Each increment moves the iterator to the next match.</p>
<p>Find iterator is a readable forward traversal iterator.</p>
<p>Dereferencing the iterator yields an iterator_range delimiting the current match. </p>
<div class="refsect2" title="find_iterator public construct/copy/destruct">
<a name="id1737147"></a><h3>
<a name="boost.algorithm.find_iteratorconstruct-copy-destruct"></a><code class="computeroutput">find_iterator</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id1112029-bb"></a>find_iterator();</pre>Default constructor. <p>Construct null iterator. All null iterators are equal.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td><p>eof()==true </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id622570-bb"></a>find_iterator(<span class="bold"><strong>const</strong></span> <a class="link" href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp; Other);</pre>Copy constructor. <p>Construct a copy of the find_iterator </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> FinderT&gt; 
  <a name="id622944-bb"></a>find_iterator(IteratorT Begin, IteratorT End, FinderT Finder);</pre>Constructor. <p>Construct new find_iterator for a given finder and a range. </p>
</li>
<li class="listitem">
<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; 
  <a name="id655407-bb"></a>find_iterator(RangeT &amp; Col, FinderT Finder);</pre>Constructor. <p>Construct new find_iterator for a given finder and a range. </p>
</li>
</ol></div>
</div>
<div class="refsect2" title="find_iterator public member functions">
<a name="id1737296"></a><h3>
<a name="id623699-bb"></a><code class="computeroutput">find_iterator</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id1112014-bb"></a>eof() <span class="bold"><strong>const</strong></span>;</pre>Eof check. <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>
</li></ol></div>
</div>
<div class="refsect2" title="find_iterator private member functions">
<a name="id1737345"></a><h3>
<a name="id701400-bb"></a><code class="computeroutput">find_iterator</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> match_type &amp;</span> <a name="id701403-bb"></a>dereference() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id701411-bb"></a>increment() ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id701419-bb"></a>equal(<span class="bold"><strong>const</strong></span> <a class="link" href="find_iterator.html" title="Class template find_iterator">find_iterator</a> &amp; Other) <span class="bold"><strong>const</strong></span>;</pre></li>
</ol></div>
</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 &#169; 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="find_format_all.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_iterator_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="split_iterator.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>