Remove old autovect-branch by moving to "dead" directory.
[official-gcc.git] / old-autovect-branch / libstdc++-v3 / docs / html / ext / pb_assoc / tree_assoc_cntnr.html
blobf524f96eb26034ac532ecbceba7887189d33efda
2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
5 <html>
6 <head>
7 <title>tree_assoc_cntnr Interface
8 </title>
10 </head>
12 <body>
13 <h1>
14 <tt>tree_assoc_cntnr
15 </tt>
17 Interface
20 </h1>
22 <p>A tree-based associative container.
23 </p>
25 <ol>
26 <li>
27 <a href = "../../../../include/ext/pb_assoc/assoc_cntnr.hpp"><tt>assoc_cntnr.hpp</tt>
28 </a>
30 </li>
32 <li>
33 <a href = "#link1">Template parameters.
34 </a>
36 </li>
38 <li>
39 <a href = "#link2">Base classes.
40 </a>
42 </li>
44 <li>
45 Public Types and Constants:
48 <ol>
49 <li>
50 <a href = "#link3">Policy definitions.
51 </a>
53 </li>
55 </ol>
57 </li>
59 <li>
60 Public Methods:
63 <ol>
64 <li>
65 <a href = "#link4">Constructors, destructor, and related.
66 </a>
68 </li>
70 </ol>
72 </li>
74 </ol>
77 <h2>
78 <a name = "link1">Template parameters.
79 </a>
81 </h2>
83 <table WIDTH = "100%" BORDER = "1">
84 <TR><TD Width = "20%" ALIGN = "left"><b>Parameter</b></TD><TD Width = "50%" ALIGN = "left"><b>Description</b></TD><TD Width = "30%" ALIGN = "left"><b>Default Value</b></TD></TR>
87 <tr>
88 <td>
89 <pre><a name = "Key3735928856">Key</a></pre>
92 </td>
94 <td>
95 <p>Key type.</p>
98 </td>
100 <td>
104 </td>
106 </tr>
108 <tr>
109 <td>
110 <pre><a name = "Data3735928937">Data</a></pre>
113 </td>
115 <td>
116 <p>Data type.</p>
119 </td>
121 <td>
125 </td>
127 </tr>
129 <tr>
130 <td>
131 <pre><a name = "Cmp_Fn3735929122">Cmp_Fn</a></pre>
134 </td>
136 <td>
137 <p>Comparison functor.</p>
140 </td>
142 <td>
143 <pre>std::less&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>
146 </td>
148 </tr>
150 <tr>
151 <td>
152 <pre><a name = "DS_Tag3735929089">DS_Tag</a></pre>
155 </td>
157 <td>
158 <p>Data-structure tag.</p>
161 </td>
163 <td>
167 </td>
169 </tr>
171 <tr>
172 <td>
173 <pre><a name = "Node_Updator3735929779">Node_Updator</a></pre>
176 </td>
178 <td>
179 <p>Node updator type.</p>
182 <p><a href = "concepts.html#concepts_node_invariants">Node Invariants</a> explains this concept.</p>
185 </td>
187 <td>
188 <a href = "null_node_updator.html"><tt>null_node_updator</tt></a>
191 </td>
193 </tr>
195 <tr>
196 <td>
197 <pre><a name = "Allocator3735929488">Allocator</a></pre>
200 </td>
202 <td>
203 <p>Allocator type.</p>
206 </td>
208 <td>
209 <pre>std::allocator&lt;<b>char</b>&gt;</pre>
212 </td>
214 </tr>
216 </table>
218 <h2>
219 <a name = "link2">Base classes.
220 </a>
222 </h2>
224 <table WIDTH = "100%" BORDER = "1">
225 <TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
228 <tr>
229 <td>
230 <pre>Depending on whether <a href = "#DS_Tag3735929089">DS_Tag</a> is a type supporting reverse iteration,<ol> <li> <a href = "basic_tree_assoc_cntnr.html"><tt>basic_tree_assoc_cntnr</tt></a> no reverse-iteration specialization </li> <li> <a href = "basic_tree_assoc_cntnr_rev_it.html"><tt>basic_tree_assoc_cntnr</tt></a> reverse-iteration specialization </li></ol></pre>
233 </td>
235 <td>
236 <p>public</p>
239 </td>
241 </tr>
243 </table>
245 <h2>
246 <a name = "link3">Policy definitions.
247 </a>
249 </h2>
251 <table WIDTH = "100%" BORDER = "1">
252 <TR><TD Width = "30%" ALIGN = "left"><b>Type</b></TD><TD Width = "55%" ALIGN = "left"><b>Definition</b></TD><TD Width = "15%" ALIGN = "left"><b>Description</b></TD></TR>
255 <tr>
256 <td>
257 <pre><a name = "cmp_fn3735929186">cmp_fn</a></pre>
260 </td>
262 <td>
263 <pre><a href = "#Cmp_Fn3735929122">Cmp_Fn</a></pre>
266 </td>
268 <td>
269 <p>Comparison functor type.</p>
272 </td>
274 </tr>
276 <tr>
277 <td>
278 <pre><a name = "node_updator3735929843">node_updator</a></pre>
281 </td>
283 <td>
284 <pre><a href = "#Node_Updator3735929779">Node_Updator</a></pre>
287 </td>
289 <td>
290 <p>Node updator type.</p>
293 </td>
295 </tr>
297 </table>
299 <h2>
300 <a name = "link4">Constructors, destructor, and related.
301 </a>
303 </h2>
305 <table WIDTH = "100%" BORDER = "1">
306 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
309 <tr>
310 <td>
311 <pre> tree_assoc_cntnr
312 ()</pre>
315 </td>
317 <td>
318 <p>Default constructor.</p>
321 </td>
323 </tr>
325 <tr>
326 <td>
327 <pre> tree_assoc_cntnr
328 (<b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;r_cmp_fn)</pre>
331 </td>
333 <td>
334 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_cmp_fn</tt></font> will be copied by the <a href = "#Cmp_Fn3735929122"><tt>Cmp_Fn</tt></a> object of the container object.</p>
337 </td>
339 </tr>
341 <tr>
342 <td>
343 <pre> tree_assoc_cntnr
344 (<b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;r_cmp_fn,
345 <b>const</b> <a href = "#Node_Updator3735929779">Node_Updator</a> &amp;r_node_updator)</pre>
348 </td>
350 <td>
351 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_cmp_fn</tt></font> will be copied by the <a href = "#Cmp_Fn3735929122"><tt>Cmp_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_node_updator</tt></font> will be copied by the <a href = "#Node_Updator3735929779"><tt>Node_Updator</tt></a> object of the container object.</p>
354 </td>
356 </tr>
358 <tr>
359 <td>
360 <pre><b>template</b>&lt;
361 <b>class</b> It&gt;
362 tree_assoc_cntnr
363 (It first_it,
364 It last_it)</pre>
367 </td>
369 <td>
370 <p>Constructor taking iterators to a range of value_types. The value_types between <font color = "#666666"><tt>first_it</tt></font> and <font color = "#666666"><tt>last_it</tt></font> will be inserted into the container object.</p>
373 </td>
375 </tr>
377 <tr>
378 <td>
379 <pre><b>template</b>&lt;
380 <b>class</b> It&gt;
381 tree_assoc_cntnr
382 (It first_it,
383 It last_it,
384 <b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;r_cmp_fn)</pre>
387 </td>
389 <td>
390 <p>Constructor taking iterators to a range of value_types and some policy objects The value_types between <font color = "#666666"><tt>first_it</tt></font> and <font color = "#666666"><tt>last_it</tt></font> will be inserted into the container object. <font color = "#666666"><tt>r_cmp_fn</tt></font> will be copied by the <a href = "#Cmp_Fn3735929122"><tt>Cmp_Fn</tt></a> object of the container object.</p>
393 </td>
395 </tr>
397 <tr>
398 <td>
399 <pre><b>template</b>&lt;
400 <b>class</b> It&gt;
401 tree_assoc_cntnr
402 (It first_it,
403 It last_it,
404 <b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;r_cmp_fn,
405 <b>const</b> <a href = "#Node_Updator3735929779">Node_Updator</a> &amp;r_node_updator)</pre>
408 </td>
410 <td>
411 <p>Constructor taking iterators to a range of value_types and some policy objects The value_types between <font color = "#666666"><tt>first_it</tt></font> and <font color = "#666666"><tt>last_it</tt></font> will be inserted into the container object. <font color = "#666666"><tt>r_cmp_fn</tt></font> will be copied by the <a href = "#Cmp_Fn3735929122"><tt>Cmp_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_node_updator</tt></font> will be copied by the <a href = "#Node_Updator3735929779"><tt>Node_Updator</tt></a> object of the container object.</p>
414 </td>
416 </tr>
418 <tr>
419 <td>
420 <pre> tree_assoc_cntnr
421 (<b>const</b> <font color = "olive">tree_assoc_cntnr</font> &amp;r_other)</pre>
424 </td>
426 <td>
427 <p>Copy constructor.</p>
430 </td>
432 </tr>
434 <tr>
435 <td>
436 <pre><b>virtual</b>
437 ~tree_assoc_cntnr
438 ()</pre>
441 </td>
443 <td>
444 <p>Destructor.</p>
447 </td>
449 </tr>
451 <tr>
452 <td>
453 <pre><font color = "olive">tree_assoc_cntnr</font> &amp;
454 <b>operator</b>=
455 (<b>const</b> <font color = "olive">tree_assoc_cntnr</font> &amp;r_other)</pre>
458 </td>
460 <td>
461 <p>Assignment operator.</p>
464 </td>
466 </tr>
468 <tr>
469 <td>
470 <pre><b>void</b>
471 swap
472 (<font color = "olive">tree_assoc_cntnr</font> &amp;r_other)</pre>
475 </td>
477 <td>
478 <p>Swaps content.</p>
481 </td>
483 </tr>
485 </table>
489 </body>
491 </html>