l4/pkg/libstdc++-v3/contrib/libstdc++-v3-4.4/doc/html/ext/pb_ds/priority_queue.html

   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>priority_queue Interface</title>
  10   <meta http-equiv="Content-Type" content=
  11   "text/html; charset=us-ascii" />
  12   </head>
  13
  14 <body>
  15   <div id="page">
  16     <h1><tt>priority_queue</tt> Interface</h1>
  17
  18     <p>Basic priority queue.</p>
  19
  20     <p>Defined in: <a href=
  21     "http://gcc.gnu.org/viewcvs/*checkout*/trunk/libstdc%2B%2B-v3/include/ext/pb_ds/priority_queue.hpp"><tt>priority_queue.hpp</tt></a></p>
  22
  23     <h2><a name="link1" id="link1">Template Parameters</a></h2>
  24
  25     <table class="c1" width="100%" border="1" summary=
  26     "Template Parameters">
  27       <tr>
  28         <td width="20%" align="left"><b>Parameter</b></td>
  29
  30         <td width="50%" align="left"><b>Description</b></td>
  31
  32         <td width="30%" align="left"><b>Default Value</b></td>
  33       </tr>
  34
  35       <tr>
  36         <td>
  37           <pre>
  38 <a name="Value_Type216514186" id=
  39 "Value_Type216514186"><b>typename</b> Value_Type</a>
  40 </pre>
  41         </td>
  42
  43         <td>
  44           <p>Value type.</p>
  45         </td>
  46
  47         <td>-</td>
  48       </tr>
  49
  50       <tr>
  51         <td>
  52           <pre>
  53 <a name="Cmp_Fn294335" id="Cmp_Fn294335"><b>class</b> Cmp_Fn </a>
  54 </pre>
  55         </td>
  56
  57         <td>
  58           <p>Comparison functor.</p>
  59         </td>
  60
  61         <td>
  62           <pre>
  63 std::less&lt;<a href=
  64 "#Value_Type216514186"><tt>Value_Type</tt></a>&gt;
  65 </pre>
  66         </td>
  67       </tr>
  68
  69       <tr>
  70         <td>
  71           <pre>
  72 <a name="Tag278938" id="Tag278938"><b>class</b> Tag </a>
  73 </pre>
  74         </td>
  75
  76         <td>
  77           <p>Data-structure tag.</p>
  78         </td>
  79
  80         <td><a href="pairing_heap_tag.html"><span class=
  81         "c2"><tt>pairing_heap_tag</tt></span></a></td>
  82       </tr>
  83
  84       <tr>
  85         <td>
  86           <pre>
  87 <a name="Allocator35940069" id=
  88 "Allocator35940069"><b>class</b> Allocator </a>
  89 </pre>
  90         </td>
  91
  92         <td>
  93           <p>Allocator type.</p>
  94         </td>
  95
  96         <td>
  97           <pre>
  98 std::allocator&lt;<b>char</b>&gt;
  99 </pre>
 100         </td>
 101       </tr>
 102     </table>
 103
 104     <h2><a name="link2" id="link2">Public Types and
 105     Constants</a></h2>
 106
 107     <h3><a name="link3" id="link3">General Container
 108     Definitions</a></h3>
 109
 110     <table class="c1" width="100%" border="1" summary="Types">
 111       <tr>
 112         <td width="30%" align="left"><b>Type</b></td>
 113
 114         <td width="55%" align="left"><b>Definition</b></td>
 115
 116         <td width="15%" align="left"><b>Description</b></td>
 117       </tr>
 118
 119       <tr>
 120         <td>
 121           <pre>
 122 <a name="size_type55424436" id="size_type55424436">size_type</a>
 123 </pre>
 124         </td>
 125
 126         <td>
 127           <pre>
 128 <b>typename</b> <a href=
 129 "#Allocator35940069"><tt>Allocator</tt></a>::size_type
 130 </pre>
 131         </td>
 132
 133         <td>
 134           <p>Size type.</p>
 135         </td>
 136       </tr>
 137
 138       <tr>
 139         <td>
 140           <pre>
 141 <a name="difference_type868028452" id=
 142 "difference_type868028452">difference_type</a>
 143 </pre>
 144         </td>
 145
 146         <td>
 147           <pre>
 148 <b>typename</b> <a href=
 149 "#Allocator35940069"><tt>Allocator</tt></a>::difference_type
 150 </pre>
 151         </td>
 152
 153         <td>
 154           <p>Difference type.</p>
 155         </td>
 156       </tr>
 157     </table>
 158
 159     <h3><a name="link4" id="link4">Categories</a></h3>
 160
 161     <table class="c1" width="100%" border="1" summary="Types">
 162       <tr>
 163         <td width="30%" align="left"><b>Type</b></td>
 164
 165         <td width="55%" align="left"><b>Definition</b></td>
 166
 167         <td width="15%" align="left"><b>Description</b></td>
 168       </tr>
 169
 170       <tr>
 171         <td>
 172           <pre>
 173 <a name="container_category1247973216" id=
 174 "container_category1247973216">container_category</a>
 175 </pre>
 176         </td>
 177
 178         <td>
 179           <pre>
 180 <a href="#Tag278938"><tt>Tag</tt></a>
 181 </pre>
 182         </td>
 183
 184         <td>
 185           <p>The underlying mapped-structure tag of the
 186           container.</p>
 187
 188           <p>This is one of:</p>
 189
 190           <ol>
 191             <li><a href="binary_heap_tag.html"><span class=
 192             "c2"><tt>binary_heap_tag</tt></span></a></li>
 193
 194             <li><a href="binomial_heap_tag.html"><span class=
 195             "c2"><tt>binomial_heap_tag</tt></span></a></li>
 196
 197             <li><a href="rc_binomial_heap_tag.html"><span class=
 198             "c2"><tt>rc_binomial_heap_tag</tt></span></a></li>
 199
 200             <li><a href="pairing_heap_tag.html"><span class=
 201             "c2"><tt>pairing_heap_tag</tt></span></a></li>
 202
 203             <li><a href="thin_heap_tag.html"><span class=
 204             "c2"><tt>thin_heap_tag</tt></span></a></li>
 205           </ol>
 206         </td>
 207       </tr>
 208     </table>
 209
 210     <h3><a name="link5" id="link5">Policy Definitions</a></h3>
 211
 212     <table class="c1" width="100%" border="1" summary="Types">
 213       <tr>
 214         <td width="30%" align="left"><b>Type</b></td>
 215
 216         <td width="55%" align="left"><b>Definition</b></td>
 217
 218         <td width="15%" align="left"><b>Description</b></td>
 219       </tr>
 220
 221       <tr>
 222         <td>
 223           <pre>
 224 <a name="cmp_fn394495" id="cmp_fn394495">cmp_fn</a>
 225 </pre>
 226         </td>
 227
 228         <td>
 229           <pre>
 230 <a href="#Cmp_Fn294335"><tt>Cmp_Fn</tt></a>
 231 </pre>
 232         </td>
 233
 234         <td>
 235           <p>Comparison functor type.</p>
 236         </td>
 237       </tr>
 238
 239       <tr>
 240         <td>
 241           <pre>
 242 <a name="allocator48440069" id="allocator48440069">allocator</a>
 243 </pre>
 244         </td>
 245
 246         <td>
 247           <pre>
 248 <a href="#Allocator35940069"><tt>Allocator</tt></a>
 249 </pre>
 250         </td>
 251
 252         <td>
 253           <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
 254           type.</p>
 255         </td>
 256       </tr>
 257     </table>
 258
 259     <h3><a name="link6" id="link6">Value-Type Definitions</a></h3>
 260
 261     <table class="c1" width="100%" border="1" summary="Types">
 262       <tr>
 263         <td width="30%" align="left"><b>Type</b></td>
 264
 265         <td width="55%" align="left"><b>Definition</b></td>
 266
 267         <td width="15%" align="left"><b>Description</b></td>
 268       </tr>
 269
 270       <tr>
 271         <td>
 272           <pre>
 273 <a name="value_type279018186" id=
 274 "value_type279018186">value_type</a>
 275 </pre>
 276         </td>
 277
 278         <td>
 279           <pre>
 280 <a href="#Value_Type216514186"><tt>Value_Type</tt></a>
 281 </pre>
 282         </td>
 283
 284         <td>
 285           <p>Value type.</p>
 286         </td>
 287       </tr>
 288
 289       <tr>
 290         <td>
 291           <pre>
 292 <a name="reference54418471" id="reference54418471">reference</a>
 293 </pre>
 294         </td>
 295
 296         <td>
 297           <pre>
 298 <b>typename</b> <a href=
 299 "#allocator48440069"><tt>allocator</tt></a>::<b>template</b> rebind&lt;
 300     <a href=
 301 "#value_type279018186"><tt>value_type</tt></a>&gt;::other::reference
 302 </pre>
 303         </td>
 304
 305         <td>
 306           <p>Value reference type.</p>
 307         </td>
 308       </tr>
 309
 310       <tr>
 311         <td>
 312           <pre>
 313 <a name="const_reference495461441" id=
 314 "const_reference495461441">const_reference</a>
 315 </pre>
 316         </td>
 317
 318         <td>
 319           <pre>
 320 <b>typename</b> <a href=
 321 "#allocator48440069"><tt>allocator</tt></a>::<b>template</b> rebind&lt;
 322     <a href=
 323 "#value_type279018186"><tt>value_type</tt></a>&gt;::other::const_reference
 324 </pre>
 325         </td>
 326
 327         <td>
 328           <p>Const value <a href=
 329           "#reference54418471"><tt>reference</tt></a> type.</p>
 330         </td>
 331       </tr>
 332
 333       <tr>
 334         <td>
 335           <pre>
 336 <a name="pointer2179769" id="pointer2179769">pointer</a>
 337 </pre>
 338         </td>
 339
 340         <td>
 341           <pre>
 342 <b>typename</b> <a href=
 343 "#allocator48440069"><tt>allocator</tt></a>::<b>template</b> rebind&lt;
 344     <a href=
 345 "#value_type279018186"><tt>value_type</tt></a>&gt;::other::pointer
 346 </pre>
 347         </td>
 348
 349         <td>
 350           <p>Value pointer type.</p>
 351         </td>
 352       </tr>
 353
 354       <tr>
 355         <td>
 356           <pre>
 357 <a name="const_pointer878814947" id=
 358 "const_pointer878814947">const_pointer</a>
 359 </pre>
 360         </td>
 361
 362         <td>
 363           <pre>
 364 <b>typename</b> <a href=
 365 "#allocator48440069"><tt>allocator</tt></a>::<b>template</b> rebind&lt;
 366     <a href=
 367 "#value_type279018186"><tt>value_type</tt></a>&gt;::other::const_pointer
 368 </pre>
 369         </td>
 370
 371         <td>
 372           <p>Const Value <a href=
 373           "#pointer2179769"><tt>pointer</tt></a> type.</p>
 374         </td>
 375       </tr>
 376     </table>
 377
 378     <h3><a name="link7" id="link7">Iterator Definitions</a></h3>
 379
 380     <table class="c1" width="100%" border="1" summary="Types">
 381       <tr>
 382         <td width="30%" align="left"><b>Type</b></td>
 383
 384         <td width="55%" align="left"><b>Definition</b></td>
 385
 386         <td width="15%" align="left"><b>Description</b></td>
 387       </tr>
 388
 389       <tr>
 390         <td>
 391           <pre>
 392 <a name="const_point_iterator2364676009" id=
 393 "const_point_iterator2364676009">const_point_iterator</a>
 394 </pre>
 395         </td>
 396
 397         <td>
 398           <pre>
 399 Const point-type iterator.
 400 </pre>
 401         </td>
 402
 403         <td>
 404           <p>Const point-type iterator.</p>
 405         </td>
 406       </tr>
 407
 408       <tr>
 409         <td>
 410           <pre>
 411 <a name="point_iterator2789896775" id=
 412 "point_iterator2789896775">point_iterator</a>
 413 </pre>
 414         </td>
 415
 416         <td>
 417           <pre>
 418 Point-type iterator.
 419 </pre>
 420         </td>
 421
 422         <td>
 423           <p>Point-type iterator.</p>
 424         </td>
 425       </tr>
 426
 427       <tr>
 428         <td>
 429           <pre>
 430 <a name="const_iterator98626788" id=
 431 "const_iterator98626788">const_iterator</a>
 432 </pre>
 433         </td>
 434
 435         <td>
 436           <pre>
 437 Const range-type iterator.
 438 </pre>
 439         </td>
 440
 441         <td>
 442           <p>Const range-type iterator.</p>
 443         </td>
 444       </tr>
 445
 446       <tr>
 447         <td>
 448           <pre>
 449 <a name="iterator10418194" id="iterator10418194">iterator</a>
 450 </pre>
 451         </td>
 452
 453         <td>
 454           <pre>
 455 Range-type iterator.
 456 </pre>
 457         </td>
 458
 459         <td>
 460           <p>Range-type iterator.</p>
 461         </td>
 462       </tr>
 463     </table>
 464
 465     <h2><a name="link8" id="link8">Public Methods</a></h2>
 466
 467     <h3><a name="link9" id="link9">Constructors, Destructor, and
 468     Related</a></h3>
 469
 470     <table class="c1" width="100%" border="1" summary="Methods">
 471       <tr>
 472         <td width="45%" align="left"><b>Method</b></td>
 473
 474         <td width="55%" align="left"><b>Description</b></td>
 475       </tr>
 476
 477       <tr>
 478         <td>
 479           <pre>
 480   priority_queue
 481   ()
 482 </pre>
 483         </td>
 484
 485         <td>
 486           <p>Default constructor.</p>
 487         </td>
 488       </tr>
 489
 490       <tr>
 491         <td>
 492           <pre>
 493   priority_queue
 494   (<b>const</b> <a href=
 495 "#cmp_fn394495"><tt>cmp_fn</tt></a> &amp;r_cmp_fn)
 496 </pre>
 497         </td>
 498
 499         <td>
 500           <p>Constructor taking some policy objects. <span class=
 501           "c1"><tt>r_cmp_fn</tt></span> will be copied by the
 502           <a href="#Cmp_Fn294335"><tt>Cmp_Fn</tt></a> object of the
 503           container object.</p>
 504         </td>
 505       </tr>
 506
 507       <tr>
 508         <td>
 509           <pre>
 510 <b>template</b>&lt;
 511     <b>class</b> It&gt;
 512   priority_queue
 513   (It first_it,
 514     It last_it)
 515 </pre>
 516         </td>
 517
 518         <td>
 519           <p>Constructor taking iterators to a range of <a href=
 520           "#value_type279018186"><tt>value_type</tt></a>s. The
 521           <a href="#value_type279018186"><tt>value_type</tt></a>s
 522           between <span class="c1"><tt>first_it</tt></span> and
 523           <span class="c1"><tt>last_it</tt></span> will be inserted
 524           into the container object.</p>
 525         </td>
 526       </tr>
 527
 528       <tr>
 529         <td>
 530           <pre>
 531 <b>template</b>&lt;
 532     <b>class</b> It&gt;
 533   priority_queue
 534   (It first_it,
 535     It last_it,
 536     <b>const</b> <a href=
 537 "#cmp_fn394495"><tt>cmp_fn</tt></a> &amp;r_cmp_fn)
 538 </pre>
 539         </td>
 540
 541         <td>
 542           <p>Constructor taking iterators to a range of <a href=
 543           "#value_type279018186"><tt>value_type</tt></a>s and some
 544           policy objects The <a href=
 545           "#value_type279018186"><tt>value_type</tt></a>s between
 546           <span class="c1"><tt>first_it</tt></span> and
 547           <span class="c1"><tt>last_it</tt></span> will be inserted
 548           into the container object. <span class=
 549           "c1"><tt>r_cmp_fn</tt></span> will be copied by the
 550           <a href="#cmp_fn394495"><tt>cmp_fn</tt></a> object of the
 551           container object.</p>
 552         </td>
 553       </tr>
 554
 555       <tr>
 556         <td>
 557           <pre>
 558   priority_queue
 559   (<b>const</b> <span class=
 560 "c2"><tt>priority_queue</tt></span> &amp;other)
 561 </pre>
 562         </td>
 563
 564         <td>
 565           <p>Copy constructor.</p>
 566         </td>
 567       </tr>
 568
 569       <tr>
 570         <td>
 571           <pre>
 572 <b>virtual</b>
 573   ~priority_queue
 574   ()
 575 </pre>
 576         </td>
 577
 578         <td>
 579           <p>Destructor.</p>
 580         </td>
 581       </tr>
 582
 583       <tr>
 584         <td>
 585           <pre>
 586 <span class="c2"><tt>priority_queue</tt></span> &amp;
 587   <b>operator</b>=
 588   (<b>const</b> <span class=
 589 "c2"><tt>priority_queue</tt></span> &amp;other)
 590 </pre>
 591         </td>
 592
 593         <td>
 594           <p>Assignment operator.</p>
 595         </td>
 596       </tr>
 597
 598       <tr>
 599         <td>
 600           <pre>
 601 <b>void</b>
 602   swap
 603   (<span class="c2"><tt>priority_queue</tt></span> &amp;other)
 604 </pre>
 605         </td>
 606
 607         <td>
 608           <p>Swaps content.</p>
 609         </td>
 610       </tr>
 611     </table>
 612
 613     <h3><a name="link10" id="link10">Information Methods</a></h3>
 614
 615     <table class="c1" width="100%" border="1" summary="Methods">
 616       <tr>
 617         <td width="45%" align="left"><b>Method</b></td>
 618
 619         <td width="55%" align="left"><b>Description</b></td>
 620       </tr>
 621
 622       <tr>
 623         <td>
 624           <pre>
 625 <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
 626   size
 627   () <b>const</b>
 628 </pre>
 629         </td>
 630
 631         <td>
 632           <p>Returns the number of distinct <a href=
 633           "#value_type279018186"><tt>value_type</tt></a> objects
 634           the container object is storing.</p>
 635         </td>
 636       </tr>
 637
 638       <tr>
 639         <td>
 640           <pre>
 641 <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
 642   max_size
 643   () <b>const</b>
 644 </pre>
 645         </td>
 646
 647         <td>
 648           <p>Returns an upper bound on the number of distinct
 649           <a href="#value_type279018186"><tt>value_type</tt></a>
 650           objects this container can store.</p>
 651         </td>
 652       </tr>
 653
 654       <tr>
 655         <td>
 656           <pre>
 657 <b>inline</b> <b>bool</b>
 658   empty
 659   () <b>const</b>
 660 </pre>
 661         </td>
 662
 663         <td>
 664           <p>Returns whether the container object is not storing
 665           any <a href=
 666           "#value_type279018186"><tt>value_type</tt></a>
 667           objects.</p>
 668         </td>
 669       </tr>
 670     </table>
 671
 672     <h3><a name="link11" id="link11">Insert Methods</a></h3>
 673
 674     <table class="c1" width="100%" border="1" summary="Methods">
 675       <tr>
 676         <td width="45%" align="left"><b>Method</b></td>
 677
 678         <td width="55%" align="left"><b>Description</b></td>
 679       </tr>
 680
 681       <tr>
 682         <td>
 683           <pre>
 684 <b>inline</b> <a href=
 685 "#point_iterator2789896775"><tt>point_iterator</tt></a>
 686   push
 687   (<a href=
 688 "#const_reference495461441"><tt>const_reference</tt></a> r_val)
 689 </pre>
 690         </td>
 691
 692         <td>
 693           <p>Inserts a <a href=
 694           "#value_type279018186"><tt>value_type</tt></a> object.
 695           returns a <a href=
 696           "#point_iterator2789896775"><tt>point_iterator</tt></a>
 697           object associated with the new pushed <span class=
 698           "c1"><tt>r_val</tt></span>.</p>
 699         </td>
 700       </tr>
 701     </table>
 702
 703     <h3><a name="link12" id="link12">Find Methods</a></h3>
 704
 705     <table class="c1" width="100%" border="1" summary="Methods">
 706       <tr>
 707         <td width="45%" align="left"><b>Method</b></td>
 708
 709         <td width="55%" align="left"><b>Description</b></td>
 710       </tr>
 711
 712       <tr>
 713         <td>
 714           <pre>
 715 <b>inline</b> <a href=
 716 "#const_reference495461441"><tt>const_reference</tt></a>
 717   top
 718   () <b>const</b>
 719 </pre>
 720         </td>
 721
 722         <td>
 723           <p>Returns the <a href=
 724           "#const_reference495461441"><tt>const_reference</tt></a>
 725           of the largest <a href=
 726           "#value_type279018186"><tt>value_type</tt></a> in the
 727           container object, i.e., a <a href=
 728           "#value_type279018186"><tt>value_type</tt></a> v_max for
 729           which any other <a href=
 730           "#value_type279018186"><tt>value_type</tt></a> v in the
 731           container object will satisfy !<a href=
 732           "#cmp_fn394495"><tt>cmp_fn</tt></a>()(v_max, v).</p>
 733         </td>
 734       </tr>
 735     </table>
 736
 737     <h3><a name="link13" id="link13">Modify Methods</a></h3>
 738
 739     <table class="c1" width="100%" border="1" summary="Methods">
 740       <tr>
 741         <td width="45%" align="left"><b>Method</b></td>
 742
 743         <td width="55%" align="left"><b>Description</b></td>
 744       </tr>
 745
 746       <tr>
 747         <td>
 748           <pre>
 749 <b>inline</b> <b>void</b>
 750   modify
 751   (<a href=
 752 "#point_iterator2789896775"><tt>point_iterator</tt></a> it,
 753     <a href=
 754 "#const_reference495461441"><tt>const_reference</tt></a> r_new_val)
 755 </pre>
 756         </td>
 757
 758         <td>
 759           <p>Modifies the <a href=
 760           "#value_type279018186"><tt>value_type</tt></a> associated
 761           with the <a href=
 762           "#point_iterator2789896775"><tt>point_iterator</tt></a>
 763           <span class="c1"><tt>it</tt></span> into <span class=
 764           "c1"><tt>r_new_val</tt></span>.</p>
 765
 766           <p>To use this method, <a href=
 767           "#value_type279018186"><tt>value_type</tt></a> must be
 768           assignable.</p>
 769         </td>
 770       </tr>
 771     </table>
 772
 773     <h3><a name="link14" id="link14">Erase Methods</a></h3>
 774
 775     <table class="c1" width="100%" border="1" summary="Methods">
 776       <tr>
 777         <td width="45%" align="left"><b>Method</b></td>
 778
 779         <td width="55%" align="left"><b>Description</b></td>
 780       </tr>
 781
 782       <tr>
 783         <td>
 784           <pre>
 785 <b>inline</b> <b>void</b>
 786   pop
 787   ()
 788 </pre>
 789         </td>
 790
 791         <td>
 792           <p>Pops the largest <a href=
 793           "#value_type279018186"><tt>value_type</tt></a>.</p>
 794
 795           <p>If the container object is empty, results are
 796           undefined.</p>
 797         </td>
 798       </tr>
 799
 800       <tr>
 801         <td>
 802           <pre>
 803 <b>inline</b> <b>void</b>
 804   erase
 805   (<a href=
 806 "#point_iterator2789896775"><tt>point_iterator</tt></a> it)
 807 </pre>
 808         </td>
 809
 810         <td>
 811           <p>Erases the <a href=
 812           "#value_type279018186"><tt>value_type</tt></a> associated
 813           with the <a href=
 814           "#point_iterator2789896775"><tt>point_iterator</tt></a>
 815           <span class="c1"><tt>it</tt></span>.</p>
 816         </td>
 817       </tr>
 818
 819       <tr>
 820         <td>
 821           <pre>
 822 <b>template</b>&lt;
 823   <b>class</b> Pred&gt;
 824 <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
 825   erase_if
 826   (Pred prd)
 827 </pre>
 828         </td>
 829
 830         <td>
 831           <p>Erases any <a href=
 832           "#value_type279018186"><tt>value_type</tt></a> satisfying
 833           the predicate <span class="c1"><tt>prd</tt></span>;
 834           returns the number of <a href=
 835           "#value_type279018186"><tt>value_type</tt></a>s
 836           erased.</p>
 837         </td>
 838       </tr>
 839
 840       <tr>
 841         <td>
 842           <pre>
 843 <b>void</b>
 844   clear
 845   ()
 846 </pre>
 847         </td>
 848
 849         <td>
 850           <p>Clears the container object.</p>
 851         </td>
 852       </tr>
 853     </table>
 854
 855     <h3><a name="link15" id="link15">Split and join
 856     Methods</a></h3>
 857
 858     <table class="c1" width="100%" border="1" summary="Methods">
 859       <tr>
 860         <td width="45%" align="left"><b>Method</b></td>
 861
 862         <td width="55%" align="left"><b>Description</b></td>
 863       </tr>
 864
 865       <tr>
 866         <td>
 867           <pre>
 868 <b>void</b>
 869   join
 870   (<span class="c2"><tt>priority_queue</tt></span> &amp;other)
 871 </pre>
 872         </td>
 873
 874         <td>
 875           <p>Joins two container objects. When this function
 876           returns, <span class="c1"><tt>other</tt></span> will be
 877           empty.</p>
 878
 879           <p>When calling this method, <span class=
 880           "c1"><tt>other</tt></span>'s policies must be
 881           equivalent to this object's policies.</p>
 882         </td>
 883       </tr>
 884
 885       <tr>
 886         <td>
 887           <pre>
 888 <b>template</b>&lt;
 889   <b>class</b> Pred&gt;
 890 <b>inline</b> <b>void</b>
 891   split
 892   (Pred prd,
 893     <span class="c2"><tt>priority_queue</tt></span> &amp;other)
 894 </pre>
 895         </td>
 896
 897         <td>
 898           <p>Splits into two container objects. When this function
 899           returns, <span class="c1"><tt>other</tt></span> will be
 900           contain only values v for which <span class=
 901           "c1"><tt>prd</tt></span>(v) is <tt><b>true</b></tt>.</p>
 902
 903           <p>When calling this method, <span class=
 904           "c1"><tt>other</tt></span>'s policies must be
 905           equivalent to this object's policies.</p>
 906         </td>
 907       </tr>
 908     </table>
 909
 910     <h3><a name="link16" id="link16">Iteration Methods</a></h3>
 911
 912     <table class="c1" width="100%" border="1" summary="Methods">
 913       <tr>
 914         <td width="45%" align="left"><b>Method</b></td>
 915
 916         <td width="55%" align="left"><b>Description</b></td>
 917       </tr>
 918
 919       <tr>
 920         <td>
 921           <pre>
 922 <b>inline</b> <a href="#iterator10418194"><tt>iterator</tt></a>
 923   begin
 924   ()
 925 </pre>
 926         </td>
 927
 928         <td>
 929           <p>Returns an <a href=
 930           "#iterator10418194"><tt>iterator</tt></a> corresponding
 931           to the first <a href=
 932           "#value_type279018186"><tt>value_type</tt></a> in the
 933           container.</p>
 934         </td>
 935       </tr>
 936
 937       <tr>
 938         <td>
 939           <pre>
 940 <b>inline</b> <a href=
 941 "#const_iterator98626788"><tt>const_iterator</tt></a>
 942   begin
 943   () <b>const</b>
 944 </pre>
 945         </td>
 946
 947         <td>
 948           <p>Returns a <a href=
 949           "#const_iterator98626788"><tt>const_iterator</tt></a>
 950           corresponding to the first <a href=
 951           "#value_type279018186"><tt>value_type</tt></a> in the
 952           container.</p>
 953         </td>
 954       </tr>
 955
 956       <tr>
 957         <td>
 958           <pre>
 959 <b>inline</b> <a href="#iterator10418194"><tt>iterator</tt></a>
 960   end
 961   ()
 962 </pre>
 963         </td>
 964
 965         <td>
 966           <p>Returns an <a href=
 967           "#iterator10418194"><tt>iterator</tt></a> corresponding
 968           to the just-after-last <a href=
 969           "#value_type279018186"><tt>value_type</tt></a> in the
 970           container.</p>
 971         </td>
 972       </tr>
 973
 974       <tr>
 975         <td>
 976           <pre>
 977 <b>inline</b> <a href=
 978 "#const_iterator98626788"><tt>const_iterator</tt></a>
 979   end
 980   () <b>const</b>
 981 </pre>
 982         </td>
 983
 984         <td>
 985           <p>Returns a <a href=
 986           "#const_iterator98626788"><tt>const_iterator</tt></a>
 987           corresponding to the just-after-last <a href=
 988           "#value_type279018186"><tt>value_type</tt></a> in the
 989           container.</p>
 990         </td>
 991       </tr>
 992     </table>
 993   </div>
 994 </body>
 995 </html>