1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <meta name="generator" content=
7  "HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />
8
9  <title>tree::const_node_iterator
10  Interface</title>
11  <meta http-equiv="Content-Type" content=
12  "text/html; charset=us-ascii" />
13  </head>
14
15<body>
16  <div id="page">
17    <h1><tt><span class=
18    "c2"><tt>tree</tt></span>::const_node_iterator</tt>
19    Interface</h1>
20
21    <p>Const node iterator.</p>
22
23    <p>This is an &amp;qout;iterator to an iterator&amp;qout; - it
24    iterates over nodes, and de-referencing it returns one of the
25    tree's iterators</p>
26
27    <h2><a name="link1" id="link1">Public Types and
28    Constants</a></h2>
29
30    <h3><a name="link2" id="link2">Iterator Definitions</a></h3>
31
32    <table class="c2" width="100%" border="1" summary="Types">
33      <tr>
34        <td width="30%" align="left"><b>Type</b></td>
35
36        <td width="55%" align="left"><b>Definition</b></td>
37
38        <td width="15%" align="left"><b>Description</b></td>
39      </tr>
40
41      <tr>
42        <td>
43          <pre>
44<a name="iterator_category2821876439" id=
45"iterator_category2821876439">iterator_category</a>
46</pre>
47        </td>
48
49        <td>
50          <pre>
51trivial_iterator_tag
52</pre>
53        </td>
54
55        <td>
56          <p>Category.</p>
57
58          <p>This tag identifies that the iterator has none of the
59          STL's iterators' movement abilities.</p>
60        </td>
61      </tr>
62
63      <tr>
64        <td>
65          <pre>
66<a name="difference_type868028452" id=
67"difference_type868028452">difference_type</a>
68</pre>
69        </td>
70
71        <td>
72          <pre class="c1">
73void
74</pre>
75        </td>
76
77        <td>
78          <p>Difference type.</p>
79        </td>
80      </tr>
81    </table>
82
83    <h3><a name="link3" id="link3">Value-Type Definitions</a></h3>
84
85    <p>Note that a node iterator's value type is actually a tree
86    iterator.</p>
87
88    <table class="c2" width="100%" border="1" summary="Types">
89      <tr>
90        <td width="30%" align="left"><b>Type</b></td>
91
92        <td width="55%" align="left"><b>Definition</b></td>
93
94        <td width="15%" align="left"><b>Description</b></td>
95      </tr>
96
97      <tr>
98        <td>
99          <pre>
100<a name="value_type279018186" id=
101"value_type279018186">value_type</a>
102</pre>
103        </td>
104
105        <td>
106          <pre>
107<a href=
108"container_base.html#const_iterator98626788"><span class="c2"><tt>container_base</tt></span>::const_iterator</a>
109</pre>
110        </td>
111
112        <td>
113          <p>Iterator's value type.</p>
114        </td>
115      </tr>
116
117      <tr>
118        <td>
119          <pre>
120<a name="reference54418471" id="reference54418471">reference</a>
121</pre>
122        </td>
123
124        <td>
125          <pre>
126<a href=
127"container_base.html#const_iterator98626788"><span class="c2"><tt>container_base</tt></span>::const_iterator</a>
128</pre>
129        </td>
130
131        <td>
132          <p>Iterator's reference type.</p>
133        </td>
134      </tr>
135
136      <tr>
137        <td>
138          <pre>
139<a name="const_reference495461441" id=
140"const_reference495461441">const_reference</a>
141</pre>
142        </td>
143
144        <td>
145          <pre>
146<a href=
147"container_base.html#const_iterator98626788"><span class="c2"><tt>container_base</tt></span>::const_iterator</a>
148</pre>
149        </td>
150
151        <td>
152          <p>Iterator's const <a href=
153          "#reference54418471"><tt>reference</tt></a> type.</p>
154        </td>
155      </tr>
156    </table>
157
158    <h3><a name="link4" id="link4">Metadata Definitions</a></h3>
159
160    <p>These are only defined if <a href=
161    "basic_tree.html#Node_Update841554648"><span class="c2">
162    <tt>basic_tree</tt></span>::Node_Update</a>
163    is not <a href="null_tree_node_update.html"><span class=
164    "c2"><tt>null_tree_node_update</tt></span></a></p>
165
166    <table class="c2" width="100%" border="1" summary="Types">
167      <tr>
168        <td width="30%" align="left"><b>Type</b></td>
169
170        <td width="55%" align="left"><b>Definition</b></td>
171
172        <td width="15%" align="left"><b>Description</b></td>
173      </tr>
174
175      <tr>
176        <td>
177          <pre>
178<a name="metadata_type2849297114" id=
179"metadata_type2849297114">metadata_type</a>
180</pre>
181        </td>
182
183        <td>
184          <pre>
185<tt><b>typename</b></tt> <a href=
186"basic_tree.html#Node_Update841554648"><span class="c2"><tt>basic_tree</tt></span>::Node_Update</a><tt>::metadata_type</tt>
187</pre>
188        </td>
189
190        <td>
191          <p>Metadata type.</p>
192        </td>
193      </tr>
194
195      <tr>
196        <td>
197          <pre>
198<a name="const_metadata_reference1108857465" id=
199"const_metadata_reference1108857465">const_metadata_reference</a>
200</pre>
201        </td>
202
203        <td>
204          <pre>
205<b>typename</b> Allocator::<b>template</b> rebind&lt;
206    <a href=
207"#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::<a href="#const_reference495461441"><tt>const_reference</tt></a>
208</pre>
209        </td>
210
211        <td>
212          <p>Const metadata <a href=
213          "#reference54418471"><tt>reference</tt></a> type.</p>
214        </td>
215      </tr>
216    </table>
217
218    <h2><a name="link5" id="link5">Public Methods</a></h2>
219
220    <h3><a name="link6" id="link6">Constructors, Destructor, and
221    Related</a></h3>
222
223    <table class="c2" width="100%" border="1" summary="Methods">
224      <tr>
225        <td width="45%" align="left"><b>Method</b></td>
226
227        <td width="55%" align="left"><b>Description</b></td>
228      </tr>
229
230      <tr>
231        <td>
232          <pre>
233<b>inline</b> 
234  const_node_iterator
235  ()
236</pre>
237        </td>
238
239        <td>
240          <p>Default constructor.</p>
241        </td>
242      </tr>
243    </table>
244
245    <h3><a name="link7" id="link7">Access Methods</a></h3>
246
247    <table class="c2" width="100%" border="1" summary="Methods">
248      <tr>
249        <td width="45%" align="left"><b>Method</b></td>
250
251        <td width="55%" align="left"><b>Description</b></td>
252      </tr>
253
254      <tr>
255        <td>
256          <pre>
257<b>inline</b> <a href=
258"#const_reference495461441"><tt>const_reference</tt></a>
259  <b>operator</b>*
260  () <b>const</b>
261</pre>
262        </td>
263
264        <td>
265          <p>Access.</p>
266        </td>
267      </tr>
268    </table>
269
270    <h3><a name="link8" id="link8">Metadata Access Methods</a></h3>
271
272    <p>These are only defined if <a href=
273    "basic_tree.html#Node_Update841554648"><span class="c2">
274    <tt>basic_tree</tt></span>::Node_Update</a>
275    is not <a href="null_tree_node_update.html"><span class=
276    "c2"><tt>null_tree_node_update</tt></span></a></p>
277
278    <table class="c2" width="100%" border="1" summary="Methods">
279      <tr>
280        <td width="45%" align="left"><b>Method</b></td>
281
282        <td width="55%" align="left"><b>Description</b></td>
283      </tr>
284
285      <tr>
286        <td>
287          <pre>
288<b>inline</b> <a href=
289"#const_metadata_reference1108857465"><tt>const_metadata_reference</tt></a>
290  get_metadata
291  () <b>const</b>
292</pre>
293        </td>
294
295        <td>
296          <p>Metadata access.</p>
297        </td>
298      </tr>
299    </table>
300
301    <h3><a name="link9" id="link9">Movement Methods</a></h3>
302
303    <table class="c2" width="100%" border="1" summary="Methods">
304      <tr>
305        <td width="45%" align="left"><b>Method</b></td>
306
307        <td width="55%" align="left"><b>Description</b></td>
308      </tr>
309
310      <tr>
311        <td>
312          <pre>
313<b>inline</b> <span class="c2"><tt>const_node_iterator</tt></span>
314  get_l_child
315  () <b>const</b>
316</pre>
317        </td>
318
319        <td>
320          <p>Returns the const node iterator associated with the
321          left node.</p>
322        </td>
323      </tr>
324
325      <tr>
326        <td>
327          <pre>
328<b>inline</b> <span class="c2"><tt>const_node_iterator</tt></span>
329  get_r_child
330  () <b>const</b>
331</pre>
332        </td>
333
334        <td>
335          <p>Returns the const node iterator associated with the
336          right node.</p>
337        </td>
338      </tr>
339    </table>
340
341    <h3><a name="link10" id="link10">Comparison Methods</a></h3>
342
343    <table class="c2" width="100%" border="1" summary="Methods">
344      <tr>
345        <td width="45%" align="left"><b>Method</b></td>
346
347        <td width="55%" align="left"><b>Description</b></td>
348      </tr>
349
350      <tr>
351        <td>
352          <pre>
353<b>inline</b> <b>bool</b>
354  <b>operator</b>==
355  (<b>const</b> <span class=
356"c2"><tt>const_node_iterator</tt></span> &amp;other) <b>const</b>
357</pre>
358        </td>
359
360        <td>
361          <p>Compares to a different iterator object.</p>
362        </td>
363      </tr>
364
365      <tr>
366        <td>
367          <pre>
368<b>inline</b> <b>bool</b>
369  <b>operator</b>!=
370  (<b>const</b> <span class=
371"c2"><tt>const_node_iterator</tt></span> &amp;other) <b>const</b>
372</pre>
373        </td>
374
375        <td>
376          <p>Compares (negatively) to a different iterator
377          object.</p>
378        </td>
379      </tr>
380    </table>
381  </div>
382</body>
383</html>
384