l4/pkg/libstdc++-v3/contrib/libstdc++-v3-4.1.0/docs/html/ext/pb_assoc/basic_tree_assoc_cntnr_rev_it.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>basic_tree_assoc_cntnr Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>basic_tree_assoc_cntnr
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>A basic tree-based associative container specialized for underlying data-structure which do not support reverse iteration.
  23 </p>
  24
  25 <ol>
  26 <li>
  27 <a href = "../../../../include/ext/pb_assoc/assoc_cntnr.hpp"><tt>assoc_cntnr.hpp</tt>
  28 </a>
  29
  30 </li>
  31
  32 <li>
  33 <a href = "#link1">Template parameters.
  34 </a>
  35
  36 </li>
  37
  38 <li>
  39 <a href = "#link2">Base classes.
  40 </a>
  41
  42 </li>
  43
  44 <li>
  45 Public Types and Constants:
  46
  47
  48 <ol>
  49 <li>
  50 <a href = "#link3">General container definitions.
  51 </a>
  52
  53 </li>
  54
  55 <li>
  56 <a href = "#link4">Key-type definitions.
  57 </a>
  58
  59 </li>
  60
  61 <li>
  62 <a href = "#link5">Policy definitions.
  63 </a>
  64
  65 </li>
  66
  67 <li>
  68 <a href = "#link6">Iterator definitions.
  69 </a>
  70
  71 </li>
  72
  73 </ol>
  74
  75 </li>
  76
  77 <li>
  78 Public Methods:
  79
  80
  81 <ol>
  82 <li>
  83 <a href = "#link7">Constructors, destructor, and related.
  84 </a>
  85
  86 </li>
  87
  88 <li>
  89 <a href = "#link8">Policy access methods.
  90 </a>
  91
  92 </li>
  93
  94 <li>
  95 <a href = "#link9">Erase methods.
  96 </a>
  97
  98 </li>
  99
 100 <li>
 101 <a href = "#link10">Node-Iteration methods.
 102 </a>
 103
 104 </li>
 105
 106 <li>
 107 <a href = "#link11">Split and join methods.
 108 </a>
 109
 110 </li>
 111
 112 </ol>
 113
 114 </li>
 115
 116 </ol>
 117
 118
 119 <h2>
 120 <a name = "link1">Template parameters.
 121 </a>
 122
 123 </h2>
 124
 125 <table WIDTH = "100%" BORDER = "1">
 126 <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>
 127
 128
 129 <tr>
 130 <td>
 131 <pre><a name = "Key3735928856">Key</a></pre>
 132
 133
 134 </td>
 135
 136 <td>
 137 <p>Key type.</p>
 138
 139
 140 </td>
 141
 142 <td>
 143 -
 144
 145
 146 </td>
 147
 148 </tr>
 149
 150 <tr>
 151 <td>
 152 <pre><a name = "Data3735928937">Data</a></pre>
 153
 154
 155 </td>
 156
 157 <td>
 158 <p>Data type.</p>
 159
 160
 161 </td>
 162
 163 <td>
 164 -
 165
 166
 167 </td>
 168
 169 </tr>
 170
 171 <tr>
 172 <td>
 173 <pre><a name = "Cmp_Fn3735929122">Cmp_Fn</a></pre>
 174
 175
 176 </td>
 177
 178 <td>
 179 <p>Comparison functor.</p>
 180
 181
 182 </td>
 183
 184 <td>
 185 -
 186
 187
 188 </td>
 189
 190 </tr>
 191
 192 <tr>
 193 <td>
 194 <pre><a name = "Node_Updator3735929779">Node_Updator</a></pre>
 195
 196
 197 </td>
 198
 199 <td>
 200 <p>Node updator type.</p>
 201
 202
 203 <p><a href = "concepts.html#concepts_node_invariants">Node Invariants</a> explains this concept.</p>
 204
 205
 206 </td>
 207
 208 <td>
 209 -
 210
 211
 212 </td>
 213
 214 </tr>
 215
 216 <tr>
 217 <td>
 218 <pre><a name = "Allocator3735929488">Allocator</a></pre>
 219
 220
 221 </td>
 222
 223 <td>
 224 <p>Allocator type.</p>
 225
 226
 227 </td>
 228
 229 <td>
 230 -
 231
 232
 233 </td>
 234
 235 </tr>
 236
 237 </table>
 238
 239 <h2>
 240 <a name = "link2">Base classes.
 241 </a>
 242
 243 </h2>
 244
 245 <table WIDTH = "100%" BORDER = "1">
 246 <TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
 247
 248
 249 <tr>
 250 <td>
 251 <pre><a href = "#Node_Updator3735929779">Node_Updator</a></pre>
 252
 253
 254 </td>
 255
 256 <td>
 257 <p>public</p>
 258
 259
 260 </td>
 261
 262 </tr>
 263
 264 </table>
 265
 266 <h2>
 267 <a name = "link3">General container definitions.
 268 </a>
 269
 270 </h2>
 271
 272 <table WIDTH = "100%" BORDER = "1">
 273 <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>
 274
 275
 276 <tr>
 277 <td>
 278 <pre><a name = "size_type3735929547">size_type</a></pre>
 279
 280
 281 </td>
 282
 283 <td>
 284 <pre><b>typename</b> <a href = "#Allocator3735929488">Allocator</a>::size_type</pre>
 285
 286
 287 </td>
 288
 289 <td>
 290 <p>Size type.</p>
 291
 292
 293 </td>
 294
 295 </tr>
 296
 297 </table>
 298
 299 <h2>
 300 <a name = "link4">Key-type definitions.
 301 </a>
 302
 303 </h2>
 304
 305 <table WIDTH = "100%" BORDER = "1">
 306 <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>
 307
 308
 309 <tr>
 310 <td>
 311 <pre><a name = "const_key_reference3735929552">const_key_reference</a></pre>
 312
 313
 314 </td>
 315
 316 <td>
 317 <pre><b>typename</b> <a href = "#Allocator3735929488">Allocator</a>::<b>template</b> rebind&lt;
 318     <a href = "#Key3735928856">Key</a>&gt;::other::const_reference</pre>
 319
 320
 321 </td>
 322
 323 <td>
 324 <p>Const key reference type.</p>
 325
 326
 327 </td>
 328
 329 </tr>
 330
 331 </table>
 332
 333 <h2>
 334 <a name = "link5">Policy definitions.
 335 </a>
 336
 337 </h2>
 338
 339 <table WIDTH = "100%" BORDER = "1">
 340 <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>
 341
 342
 343 <tr>
 344 <td>
 345 <pre><a name = "cmp_fn3735929186">cmp_fn</a></pre>
 346
 347
 348 </td>
 349
 350 <td>
 351 <pre><a href = "#Cmp_Fn3735929122">Cmp_Fn</a></pre>
 352
 353
 354 </td>
 355
 356 <td>
 357 <p>Comparison functor type.</p>
 358
 359
 360 </td>
 361
 362 </tr>
 363
 364 <tr>
 365 <td>
 366 <pre><a name = "node_updator3735929843">node_updator</a></pre>
 367
 368
 369 </td>
 370
 371 <td>
 372 <pre><a href = "#Node_Updator3735929779">Node_Updator</a></pre>
 373
 374
 375 </td>
 376
 377 <td>
 378 <p>Node updator type.</p>
 379
 380
 381 </td>
 382
 383 </tr>
 384
 385 </table>
 386
 387 <h2>
 388 <a name = "link6">Iterator definitions.
 389 </a>
 390
 391 </h2>
 392
 393 <table WIDTH = "100%" BORDER = "1">
 394 <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>
 395
 396
 397 <tr>
 398 <td>
 399 <pre><a name = "const_iterator3735930079">const_iterator</a></pre>
 400
 401
 402 </td>
 403
 404 <td>
 405 <pre>Underlying data-structure's const range-type iterator.</pre>
 406
 407
 408 </td>
 409
 410 <td>
 411 <p>Const range-type iterator.</p>
 412
 413
 414 </td>
 415
 416 </tr>
 417
 418 <tr>
 419 <td>
 420 <pre><a name = "iterator3735929433">iterator</a></pre>
 421
 422
 423 </td>
 424
 425 <td>
 426 <pre>Underlying data-structure's range-type iterator.</pre>
 427
 428
 429 </td>
 430
 431 <td>
 432 <p>Range-type iterator.</p>
 433
 434
 435 </td>
 436
 437 </tr>
 438
 439 <tr>
 440 <td>
 441 <pre><a name = "const_node_iterator3735929535">const_node_iterator</a></pre>
 442
 443
 444 </td>
 445
 446 <td>
 447 <pre><a href = "basic_tree_assoc_cntnr_const_node_iterator.html"><tt><font color = "olive">basic_tree_assoc_cntnr</font>::const_node_iterator</tt></a></pre>
 448
 449
 450 </td>
 451
 452 <td>
 453 <p>Const node iterator.</p>
 454
 455
 456 </td>
 457
 458 </tr>
 459
 460 <tr>
 461 <td>
 462 <pre><a name = "node_iterator3735929950">node_iterator</a></pre>
 463
 464
 465 </td>
 466
 467 <td>
 468 <pre><a href = "basic_tree_assoc_cntnr_node_iterator.html"><tt><font color = "olive">basic_tree_assoc_cntnr</font>::node_iterator</tt></a></pre>
 469
 470
 471 </td>
 472
 473 <td>
 474 <p>Node iterator.</p>
 475
 476
 477 </td>
 478
 479 </tr>
 480
 481 </table>
 482
 483 <h2>
 484 <a name = "link7">Constructors, destructor, and related.
 485 </a>
 486
 487 </h2>
 488
 489 <table WIDTH = "100%" BORDER = "1">
 490 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 491
 492
 493 <tr>
 494 <td>
 495 <pre><b>virtual</b>
 496   ~basic_tree_assoc_cntnr
 497   ()</pre>
 498
 499
 500 </td>
 501
 502 <td>
 503 <p>Destructor.</p>
 504
 505
 506 </td>
 507
 508 </tr>
 509
 510 </table>
 511
 512 <h2>
 513 <a name = "link8">Policy access methods.
 514 </a>
 515
 516 </h2>
 517
 518 <table WIDTH = "100%" BORDER = "1">
 519 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 520
 521
 522 <tr>
 523 <td>
 524 <pre><a href = "#cmp_fn3735929186">cmp_fn</a> &amp;
 525   get_cmp_fn
 526   ()</pre>
 527
 528
 529 </td>
 530
 531 <td>
 532 <p>Access to the <a href = "#cmp_fn3735929186"><tt>cmp_fn</tt></a> object.</p>
 533
 534
 535 </td>
 536
 537 </tr>
 538
 539 <tr>
 540 <td>
 541 <pre><b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;
 542   get_cmp_fn
 543   () <b>const</b></pre>
 544
 545
 546 </td>
 547
 548 <td>
 549 <p>Const access to the <a href = "#cmp_fn3735929186"><tt>cmp_fn</tt></a> object.</p>
 550
 551
 552 </td>
 553
 554 </tr>
 555
 556 <tr>
 557 <td>
 558 <pre><a href = "#node_updator3735929843">node_updator</a> &amp;
 559   get_node_updator
 560   ()</pre>
 561
 562
 563 </td>
 564
 565 <td>
 566 <p>Access to the <a href = "#node_updator3735929843"><tt>node_updator</tt></a> object.</p>
 567
 568
 569 </td>
 570
 571 </tr>
 572
 573 <tr>
 574 <td>
 575 <pre><b>const</b> <a href = "#node_updator3735929843">node_updator</a> &amp;
 576   get_node_updator
 577   () <b>const</b></pre>
 578
 579
 580 </td>
 581
 582 <td>
 583 <p>Const access to the <a href = "#node_updator3735929843"><tt>node_updator</tt></a> object.</p>
 584
 585
 586 </td>
 587
 588 </tr>
 589
 590 </table>
 591
 592 <h2>
 593 <a name = "link9">Erase methods.
 594 </a>
 595
 596 </h2>
 597
 598 <table WIDTH = "100%" BORDER = "1">
 599 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 600
 601
 602 <tr>
 603 <td>
 604 <pre><b>inline</b> <a href = "#size_type3735929547">size_type</a>
 605   erase
 606   (<a href = "#const_key_reference3735929552">const_key_reference</a> r_key)</pre>
 607
 608
 609 </td>
 610
 611 <td>
 612 <p>Erases the value_type associated with <font color = "#666666"><tt>r_key</tt></font>; returns the number of value_types erased (0 or 1).</p>
 613
 614
 615 </td>
 616
 617 </tr>
 618
 619 <tr>
 620 <td>
 621 <pre><b>inline</b> <a href = "#iterator3735929433">iterator</a>
 622   erase
 623   (<a href = "#iterator3735929433">iterator</a> it)</pre>
 624
 625
 626 </td>
 627
 628 <td>
 629 <p>Erases the value_type corresponding to the <a href = "#iterator3735929433"><tt>iterator</tt></a> <font color = "#666666"><tt>it</tt></font>. Returns the <a href = "#iterator3735929433"><tt>iterator</tt></a> corresponding to the next value_type.</p>
 630
 631
 632 </td>
 633
 634 </tr>
 635
 636 </table>
 637
 638 <h2>
 639 <a name = "link10">Node-Iteration methods.
 640 </a>
 641
 642 </h2>
 643
 644 <table WIDTH = "100%" BORDER = "1">
 645 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 646
 647
 648 <tr>
 649 <td>
 650 <pre><b>inline</b> <a href = "#node_iterator3735929950">node_iterator</a>
 651   node_begin
 652   ()</pre>
 653
 654
 655 </td>
 656
 657 <td>
 658 <p>Returns a <a href = "#node_iterator3735929950"><tt>node_iterator</tt></a> corresponding to the value_type at the root of the tree.</p>
 659
 660
 661 </td>
 662
 663 </tr>
 664
 665 <tr>
 666 <td>
 667 <pre><b>inline</b> <a href = "#const_node_iterator3735929535">const_node_iterator</a>
 668   node_begin
 669   () <b>const</b></pre>
 670
 671
 672 </td>
 673
 674 <td>
 675 <p>Returns a <a href = "#const_node_iterator3735929535"><tt>const_node_iterator</tt></a> corresponding to the value_type at the root of the tree.</p>
 676
 677
 678 </td>
 679
 680 </tr>
 681
 682 <tr>
 683 <td>
 684 <pre><b>inline</b> <a href = "#node_iterator3735929950">node_iterator</a>
 685   node_end
 686   ()</pre>
 687
 688
 689 </td>
 690
 691 <td>
 692 <p>Returns a <a href = "#node_iterator3735929950"><tt>node_iterator</tt></a> corresponding to a value_type just after a leaf of the tree.</p>
 693
 694
 695 </td>
 696
 697 </tr>
 698
 699 <tr>
 700 <td>
 701 <pre><b>inline</b> <a href = "#const_node_iterator3735929535">const_node_iterator</a>
 702   node_end
 703   () <b>const</b></pre>
 704
 705
 706 </td>
 707
 708 <td>
 709 <p>Returns a <a href = "#const_node_iterator3735929535"><tt>const_node_iterator</tt></a> corresponding to a value_type just after a leaf of the tree.</p>
 710
 711
 712 </td>
 713
 714 </tr>
 715
 716 </table>
 717
 718 <h2>
 719 <a name = "link11">Split and join methods.
 720 </a>
 721
 722 </h2>
 723
 724 <table WIDTH = "100%" BORDER = "1">
 725 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 726
 727
 728 <tr>
 729 <td>
 730 <pre><b>void</b>
 731   join
 732   (<font color = "olive">basic_tree_assoc_cntnr</font> &amp;r_other)</pre>
 733
 734
 735 </td>
 736
 737 <td>
 738 <p>Joins two trees. When this function returns, <font color = "#666666"><tt>r_other</tt></font> will be empty.</p>
 739
 740
 741 </td>
 742
 743 </tr>
 744
 745 <tr>
 746 <td>
 747 <pre><b>inline</b> <b>void</b>
 748   split
 749   (<a href = "#const_key_reference3735929552">const_key_reference</a> r_key,
 750     <font color = "olive">basic_tree_assoc_cntnr</font> &amp;r_other)</pre>
 751
 752
 753 </td>
 754
 755 <td>
 756 <p>Joins two trees. When this function returns, <font color = "#666666"><tt>r_other</tt></font> will be empty.</p>
 757
 758
 759 </td>
 760
 761 </tr>
 762
 763 </table>
 764
 765
 766
 767 </body>
 768
 769 </html>
 770
 771