old-autovect-branch/libstdc++-v3/docs/html/ext/pb_assoc/cc_hash_assoc_cntnr.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>cc_hash_assoc_cntnr Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>cc_hash_assoc_cntnr
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>A collision-chaining hash-based associative container.
  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">Policy definitions.
  51 </a>
  52
  53 </li>
  54
  55 </ol>
  56
  57 </li>
  58
  59 <li>
  60 Public Methods:
  61
  62
  63 <ol>
  64 <li>
  65 <a href = "#link4">Constructors, destructor, and related.
  66 </a>
  67
  68 </li>
  69
  70 <li>
  71 <a href = "#link5">Policy access methods.
  72 </a>
  73
  74 </li>
  75
  76 </ol>
  77
  78 </li>
  79
  80 </ol>
  81
  82
  83 <h2>
  84 <a name = "link1">Template parameters.
  85 </a>
  86
  87 </h2>
  88
  89 <table WIDTH = "100%" BORDER = "1">
  90 <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>
  91
  92
  93 <tr>
  94 <td>
  95 <pre><a name = "Key3735928856">Key</a></pre>
  96
  97
  98 </td>
  99
 100 <td>
 101 <p>Key type.</p>
 102
 103
 104 </td>
 105
 106 <td>
 107 -
 108
 109
 110 </td>
 111
 112 </tr>
 113
 114 <tr>
 115 <td>
 116 <pre><a name = "Data3735928937">Data</a></pre>
 117
 118
 119 </td>
 120
 121 <td>
 122 <p>Data type.</p>
 123
 124
 125 </td>
 126
 127 <td>
 128 -
 129
 130
 131 </td>
 132
 133 </tr>
 134
 135 <tr>
 136 <td>
 137 <pre><a name = "Hash_Fn3735929222">Hash_Fn</a></pre>
 138
 139
 140 </td>
 141
 142 <td>
 143 <p>Hash functor.</p>
 144
 145
 146 </td>
 147
 148 <td>
 149 <pre>__gnu_cxx::hash&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>if using gcc;<pre>stdext::hash_value&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>if using Visual C++ .net
 150
 151
 152 </td>
 153
 154 </tr>
 155
 156 <tr>
 157 <td>
 158 <pre><a name = "Eq_Fn3735929016">Eq_Fn</a></pre>
 159
 160
 161 </td>
 162
 163 <td>
 164 <p>Equivalence functor.</p>
 165
 166
 167 </td>
 168
 169 <td>
 170 <pre>std::equal_to&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>
 171
 172
 173 </td>
 174
 175 </tr>
 176
 177 <tr>
 178 <td>
 179 <pre><a name = "Comb_Hash_Fn3735929702">Comb_Hash_Fn</a></pre>
 180
 181
 182 </td>
 183
 184 <td>
 185 <p>Combining hash functor.</p>
 186
 187
 188 <p>If <a href = "#Hash_Fn3735929222">Hash_Fn</a> is not <a href = "null_hash_fn.html"><tt>null_hash_fn</tt></a>, then this is the <a href = "concepts.html#concepts_hash_fns">range_hashing function</a> functor; otherwise, this is the <a href = "concepts.html#concepts_hash_fns">ranged_hash function</a> functor.</p>
 189
 190
 191 </td>
 192
 193 <td>
 194 <pre><a href = "direct_mask_range_hashing.html">direct_mask_range_hashing</a>&lt;
 195   <a href = "#Allocator3735929488">Allocator</a>&gt;</pre>
 196
 197
 198 </td>
 199
 200 </tr>
 201
 202 <tr>
 203 <td>
 204 <pre><a name = "Resize_Policy3735929904">Resize_Policy</a></pre>
 205
 206
 207 </td>
 208
 209 <td>
 210 <p>Resize policy.</p>
 211
 212
 213 </td>
 214
 215 <td>
 216 If <tt><a href = "#comb_hash_fn3735929798">comb_hash_fn</a></tt> is <tt><a href = "direct_mask_range_hashing.html">direct_mask_range_hashing&lt;&gt;</a></tt>, then <pre><a href = "hash_standard_resize_policy.html">hash_standard_resize_policy</a>&lt;
 217   <a href = "hash_exponential_size_policy.html">hash_exponential_size_policy</a>&lt;
 218     <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;,
 219   <a href = "hash_load_check_resize_trigger.html">hash_load_check_resize_trigger</a>&lt;
 220     <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;,
 221   <b>false</b>,
 222   <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;</pre>otherwise, <pre><a href = "hash_standard_resize_policy.html">hash_standard_resize_policy</a>&lt;
 223   <a href = "hash_exponential_size_policy.html"><tt>hash_prime_size_policy</tt></a>&lt;
 224     <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;,
 225   <a href = "hash_load_check_resize_trigger.html"><tt>hash_load_check_resize_trigger</tt></a>&lt;
 226     <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;,
 227   <b>false</b>,
 228   <b>typename</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a>::size_type&gt;</pre>
 229
 230
 231 </td>
 232
 233 </tr>
 234
 235 <tr>
 236 <td>
 237 <pre><a name = "Store_Hash3735929567">Store_Hash</a></pre>
 238
 239
 240 </td>
 241
 242 <td>
 243 <p>Indicates whether the hash value will be stored along with each key.</p>
 244
 245
 246 <p>If <tt><a href = "#hash_fn3735929286">hash_fn</a></tt> is <tt><a href = "null_hash_fn.html">null_hash_fn</a></tt>, then the container will not compile if this value is <tt><b>true</b></tt></p>
 247
 248
 249 </td>
 250
 251 <td>
 252 <pre><tt><b>false</b></tt></pre>
 253
 254
 255 </td>
 256
 257 </tr>
 258
 259 <tr>
 260 <td>
 261 <pre><a name = "Allocator3735929488">Allocator</a></pre>
 262
 263
 264 </td>
 265
 266 <td>
 267 <p>Allocator type.</p>
 268
 269
 270 </td>
 271
 272 <td>
 273 <pre>std::allocator&lt;<b>char</b>&gt;</pre>
 274
 275
 276 </td>
 277
 278 </tr>
 279
 280 </table>
 281
 282 <h2>
 283 <a name = "link2">Base classes.
 284 </a>
 285
 286 </h2>
 287
 288 <table WIDTH = "100%" BORDER = "1">
 289 <TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
 290
 291
 292 <tr>
 293 <td>
 294 <pre><a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a></pre>
 295
 296
 297 </td>
 298
 299 <td>
 300 <p>public</p>
 301
 302
 303 </td>
 304
 305 </tr>
 306
 307 <tr>
 308 <td>
 309 <pre><a href = "basic_hash_assoc_cntnr.html"<tt>basic_hash_assoc_cntnr</tt></a></pre>
 310
 311
 312 </td>
 313
 314 <td>
 315 <p>public</p>
 316
 317
 318 </td>
 319
 320 </tr>
 321
 322 </table>
 323
 324 <h2>
 325 <a name = "link3">Policy definitions.
 326 </a>
 327
 328 </h2>
 329
 330 <table WIDTH = "100%" BORDER = "1">
 331 <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>
 332
 333
 334 <tr>
 335 <td>
 336 <pre><a name = "comb_hash_fn3735929798">comb_hash_fn</a></pre>
 337
 338
 339 </td>
 340
 341 <td>
 342 <pre><a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a></pre>
 343
 344
 345 </td>
 346
 347 <td>
 348 <p>Combining hash functor type.</p>
 349
 350
 351 </td>
 352
 353 </tr>
 354
 355 </table>
 356
 357 <h2>
 358 <a name = "link4">Constructors, destructor, and related.
 359 </a>
 360
 361 </h2>
 362
 363 <table WIDTH = "100%" BORDER = "1">
 364 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 365
 366
 367 <tr>
 368 <td>
 369 <pre>  cc_hash_assoc_cntnr
 370   ()</pre>
 371
 372
 373 </td>
 374
 375 <td>
 376 <p>Default constructor.</p>
 377
 378
 379 </td>
 380
 381 </tr>
 382
 383 <tr>
 384 <td>
 385 <pre>  cc_hash_assoc_cntnr
 386   (<b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn)</pre>
 387
 388
 389 </td>
 390
 391 <td>
 392 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object.</p>
 393
 394
 395 </td>
 396
 397 </tr>
 398
 399 <tr>
 400 <td>
 401 <pre>  cc_hash_assoc_cntnr
 402   (<b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 403     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn)</pre>
 404
 405
 406 </td>
 407
 408 <td>
 409 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object.</p>
 410
 411
 412 </td>
 413
 414 </tr>
 415
 416 <tr>
 417 <td>
 418 <pre>  cc_hash_assoc_cntnr
 419   (<b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 420     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
 421     <b>const</b> <a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a> &amp;r_comb_hash_fn)</pre>
 422
 423
 424 </td>
 425
 426 <td>
 427 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_comb_hash_fn</tt></font> will be copied by the <a href = "#Comb_Hash_Fn3735929702"><tt>Comb_Hash_Fn</tt></a> object of the container object.</p>
 428
 429
 430 </td>
 431
 432 </tr>
 433
 434 <tr>
 435 <td>
 436 <pre>  cc_hash_assoc_cntnr
 437   (<b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 438     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
 439     <b>const</b> <a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a> &amp;r_comb_hash_fn,
 440     <b>const</b> <a href = "#Resize_Policy3735929904">Resize_Policy</a> &amp;r_resize_policy)</pre>
 441
 442
 443 </td>
 444
 445 <td>
 446 <p>Constructor taking some policy objects. <font color = "#666666"><tt>r_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_comb_hash_fn</tt></font> will be copied by the <a href = "#Comb_Hash_Fn3735929702"><tt>Comb_Hash_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_resize_policy</tt></font> will be copied by the <a href = "#Resize_Policy3735929904"><tt>Resize_Policy</tt></a> object of the container object.</p>
 447
 448
 449 </td>
 450
 451 </tr>
 452
 453 <tr>
 454 <td>
 455 <pre><b>template</b>&lt;
 456     <b>class</b> It&gt;
 457   cc_hash_assoc_cntnr
 458   (It first_it,
 459     It last_it)</pre>
 460
 461
 462 </td>
 463
 464 <td>
 465 <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>
 466
 467
 468 </td>
 469
 470 </tr>
 471
 472 <tr>
 473 <td>
 474 <pre><b>template</b>&lt;
 475     <b>class</b> It&gt;
 476   cc_hash_assoc_cntnr
 477   (It first_it,
 478     It last_it,
 479     <b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn)</pre>
 480
 481
 482 </td>
 483
 484 <td>
 485 <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.</p>
 486
 487
 488 </td>
 489
 490 </tr>
 491
 492 <tr>
 493 <td>
 494 <pre><b>template</b>&lt;
 495     <b>class</b> It&gt;
 496   cc_hash_assoc_cntnr
 497   (It first_it,
 498     It last_it,
 499     <b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 500     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn)</pre>
 501
 502
 503 </td>
 504
 505 <td>
 506 <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_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object.</p>
 507
 508
 509 </td>
 510
 511 </tr>
 512
 513 <tr>
 514 <td>
 515 <pre><b>template</b>&lt;
 516     <b>class</b> It&gt;
 517   cc_hash_assoc_cntnr
 518   (It first_it,
 519     It last_it,
 520     <b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 521     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
 522     <b>const</b> <a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a> &amp;r_comb_hash_fn)</pre>
 523
 524
 525 </td>
 526
 527 <td>
 528 <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_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_comb_hash_fn</tt></font> will be copied by the <a href = "#Comb_Hash_Fn3735929702"><tt>Comb_Hash_Fn</tt></a> object of the container object.</p>
 529
 530
 531 </td>
 532
 533 </tr>
 534
 535 <tr>
 536 <td>
 537 <pre><b>template</b>&lt;
 538     <b>class</b> It&gt;
 539   cc_hash_assoc_cntnr
 540   (It first_it,
 541     It last_it,
 542     <b>const</b> <a href = "#Hash_Fn3735929222">Hash_Fn</a> &amp;r_hash_fn,
 543     <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
 544     <b>const</b> <a href = "#Comb_Hash_Fn3735929702">Comb_Hash_Fn</a> &amp;r_comb_hash_fn,
 545     <b>const</b> <a href = "#Resize_Policy3735929904">Resize_Policy</a> &amp;r_resize_policy)</pre>
 546
 547
 548 </td>
 549
 550 <td>
 551 <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_hash_fn</tt></font> will be copied by the <a href = "#Hash_Fn3735929222"><tt>Hash_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_eq_fn</tt></font> will be copied by the <a href = "#Eq_Fn3735929016"><tt>Eq_Fn</tt></a> object of the container object, <font color = "#666666"><tt>r_comb_hash_fn</tt></font> will be copied by the <a href = "#Comb_Hash_Fn3735929702"><tt>Comb_Hash_Fn</tt></a> object of the container object, and <font color = "#666666"><tt>r_resize_policy</tt></font> will be copied by the <a href = "#Resize_Policy3735929904"><tt>Resize_Policy</tt></a> object of the container object.</p>
 552
 553
 554 </td>
 555
 556 </tr>
 557
 558 <tr>
 559 <td>
 560 <pre>  cc_hash_assoc_cntnr
 561   (<b>const</b> <font color = "olive">cc_hash_assoc_cntnr</font> &amp;r_other)</pre>
 562
 563
 564 </td>
 565
 566 <td>
 567 <p>Copy constructor.</p>
 568
 569
 570 </td>
 571
 572 </tr>
 573
 574 <tr>
 575 <td>
 576 <pre><b>virtual</b>
 577   ~cc_hash_assoc_cntnr
 578   ()</pre>
 579
 580
 581 </td>
 582
 583 <td>
 584 <p>Destructor.</p>
 585
 586
 587 </td>
 588
 589 </tr>
 590
 591 <tr>
 592 <td>
 593 <pre><font color = "olive">cc_hash_assoc_cntnr</font> &amp;
 594   <b>operator</b>=
 595   (<b>const</b> <font color = "olive">cc_hash_assoc_cntnr</font> &amp;r_other)</pre>
 596
 597
 598 </td>
 599
 600 <td>
 601 <p>Assignment operator.</p>
 602
 603
 604 </td>
 605
 606 </tr>
 607
 608 <tr>
 609 <td>
 610 <pre><b>void</b>
 611   swap
 612   (<font color = "olive">cc_hash_assoc_cntnr</font> &amp;r_other)</pre>
 613
 614
 615 </td>
 616
 617 <td>
 618 <p>Swaps content.</p>
 619
 620
 621 </td>
 622
 623 </tr>
 624
 625 </table>
 626
 627 <h2>
 628 <a name = "link5">Policy access methods.
 629 </a>
 630
 631 </h2>
 632
 633 <table WIDTH = "100%" BORDER = "1">
 634 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 635
 636
 637 <tr>
 638 <td>
 639 <pre><a href = "#comb_hash_fn3735929798">comb_hash_fn</a> &amp;
 640   get_comb_hash_fn
 641   ()</pre>
 642
 643
 644 </td>
 645
 646 <td>
 647 <p>Access to the <a href = "#comb_hash_fn3735929798"><tt>comb_hash_fn</tt></a> object.</p>
 648
 649
 650 </td>
 651
 652 </tr>
 653
 654 <tr>
 655 <td>
 656 <pre><b>const</b> <a href = "#comb_hash_fn3735929798">comb_hash_fn</a> &amp;
 657   get_comb_hash_fn
 658   () <b>const</b></pre>
 659
 660
 661 </td>
 662
 663 <td>
 664 <p>Const access to the <a href = "#comb_hash_fn3735929798"><tt>comb_hash_fn</tt></a> object.</p>
 665
 666
 667 </td>
 668
 669 </tr>
 670
 671 </table>
 672
 673
 674
 675 </body>
 676
 677 </html>
 678
 679