1
2<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
4
5<html>
6<head>
7<title>basic_hash_assoc_cntnr Interface
8</title>
9
10</head>
11
12<body>
13<h1>
14<tt>basic_hash_assoc_cntnr
15</tt>
16
17 Interface
18
19
20</h1>
21
22<p>A basic 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>
45Public 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>
60Public 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<li>
81Protected Methods:
82
83
84<ol>
85<li>
86<a href = "#link6">Resize methods.
87</a>
88
89</li>
90
91</ol>
92
93</li>
94
95</ol>
96
97
98<h2>
99<a name = "link1">Template parameters.
100</a>
101
102</h2>
103
104<table WIDTH = "100%" BORDER = "1">
105<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>
106
107
108<tr>
109<td>
110<pre><a name = "Key3735928856">Key</a></pre>
111
112
113</td>
114
115<td>
116<p>Key type.</p>
117
118
119</td>
120
121<td>
122-
123
124
125</td>
126
127</tr>
128
129<tr>
130<td>
131<pre><a name = "Data3735928937">Data</a></pre>
132
133
134</td>
135
136<td>
137<p>Data 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 = "Hash_Fn3735929222">Hash_Fn</a></pre>
153
154
155</td>
156
157<td>
158<p>Hash functor.</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 = "Eq_Fn3735929016">Eq_Fn</a></pre>
174
175
176</td>
177
178<td>
179<p>Equivalence 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 = "Resize_Policy3735929904">Resize_Policy</a></pre>
195
196
197</td>
198
199<td>
200<p>Resize policy.</p>
201
202
203</td>
204
205<td>
206-
207
208
209</td>
210
211</tr>
212
213<tr>
214<td>
215<pre><a name = "Store_Hash3735929567">Store_Hash</a></pre>
216
217
218</td>
219
220<td>
221<p>Indicates whether the hash value will be stored along with each key.</p>
222
223
224</td>
225
226<td>
227-
228
229
230</td>
231
232</tr>
233
234<tr>
235<td>
236<pre><a name = "DS_Tag,3735929133">DS_Tag,</a></pre>
237
238
239</td>
240
241<td>
242<p>Data-structure tag.</p>
243
244
245</td>
246
247<td>
248-
249
250
251</td>
252
253</tr>
254
255<tr>
256<td>
257<pre><a name = "Allocator3735929488">Allocator</a></pre>
258
259
260</td>
261
262<td>
263<p>Allocator type.</p>
264
265
266</td>
267
268<td>
269-
270
271
272</td>
273
274</tr>
275
276</table>
277
278<h2>
279<a name = "link2">Base classes.
280</a>
281
282</h2>
283
284<table WIDTH = "100%" BORDER = "1">
285<TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
286
287
288<tr>
289<td>
290<pre><a href = "#Resize_Policy3735929904">Resize_Policy</a></pre>
291
292
293</td>
294
295<td>
296<p>public</p>
297
298
299</td>
300
301</tr>
302
303<tr>
304<td>
305<pre><a href = "#Hash_Fn3735929222">Hash_Fn</a></pre>
306
307
308</td>
309
310<td>
311<p>public</p>
312
313
314</td>
315
316</tr>
317
318<tr>
319<td>
320<pre>Depending on <a href = "#Data3735928937">Data</a>:<ol>	<li> <a href = "null_data_type.html"><tt>null_data_type</tt></a> - <a href = "basic_assoc_cntnr_no_data.html"><tt>basic_assoc_cntnr</tt></a> &quot;set&quot; specialization </li>	<li> <a href = "compound_data_type.html"><tt>compound_data_type</tt></a><tt>&lt;Container&gt;</tt> - <a href = "basic_assoc_cntnr_compound_data.html"><tt>basic_assoc_cntnr</tt></a> &quot;multimap&quot; specialization </li>	<li> Other - <a href = "basic_assoc_cntnr.html"><tt>basic_assoc_cntnr</tt></a> &quot;map&quot; specialization </li></ol></pre>
321
322
323</td>
324
325<td>
326<p>public</p>
327
328
329</td>
330
331</tr>
332
333</table>
334
335<h2>
336<a name = "link3">Policy definitions.
337</a>
338
339</h2>
340
341<table WIDTH = "100%" BORDER = "1">
342<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>
343
344
345<tr>
346<td>
347<pre><a name = "hash_fn3735929286">hash_fn</a></pre>
348
349
350</td>
351
352<td>
353<pre><a href = "#Hash_Fn3735929222">Hash_Fn</a></pre>
354
355
356</td>
357
358<td>
359<p>Hash functor type.</p>
360
361
362</td>
363
364</tr>
365
366<tr>
367<td>
368<pre><a name = "eq_fn3735929080">eq_fn</a></pre>
369
370
371</td>
372
373<td>
374<pre><a href = "#Eq_Fn3735929016">Eq_Fn</a></pre>
375
376
377</td>
378
379<td>
380<p>Equivalence functor type.</p>
381
382
383</td>
384
385</tr>
386
387<tr>
388<td>
389<pre><a name = "resize_policy3735929968">resize_policy</a></pre>
390
391
392</td>
393
394<td>
395<pre><a href = "#Resize_Policy3735929904">Resize_Policy</a></pre>
396
397
398</td>
399
400<td>
401<p>Resize policy type.</p>
402
403
404</td>
405
406</tr>
407
408<tr>
409<td>
410<pre><a name = "store_hash3735929631">store_hash</a></pre>
411
412
413</td>
414
415<td>
416<pre><a href = "#Store_Hash3735929567">Store_Hash</a></pre>
417
418
419</td>
420
421<td>
422<p>Indicates whether a hash value is stored with each entry.</p>
423
424
425</td>
426
427</tr>
428
429</table>
430
431<h2>
432<a name = "link4">Constructors, destructor, and related.
433</a>
434
435</h2>
436
437<table WIDTH = "100%" BORDER = "1">
438<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
439
440
441<tr>
442<td>
443<pre><b>virtual</b>
444  ~basic_hash_assoc_cntnr
445  ()</pre>
446
447
448</td>
449
450<td>
451<p>Destructor.</p>
452
453
454</td>
455
456</tr>
457
458</table>
459
460<h2>
461<a name = "link5">Policy access methods.
462</a>
463
464</h2>
465
466<table WIDTH = "100%" BORDER = "1">
467<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
468
469
470<tr>
471<td>
472<pre><a href = "#hash_fn3735929286">hash_fn</a> &amp;
473  get_hash_fn
474  ()</pre>
475
476
477</td>
478
479<td>
480<p>Access to the <a href = "#hash_fn3735929286"><tt>hash_fn</tt></a> object.</p>
481
482
483</td>
484
485</tr>
486
487<tr>
488<td>
489<pre><b>const</b> <a href = "#hash_fn3735929286">hash_fn</a> &amp;
490  get_hash_fn
491  () <b>const</b></pre>
492
493
494</td>
495
496<td>
497<p>Const access to the <a href = "#hash_fn3735929286"><tt>hash_fn</tt></a> object.</p>
498
499
500</td>
501
502</tr>
503
504<tr>
505<td>
506<pre><a href = "#eq_fn3735929080">eq_fn</a> &amp;
507  get_eq_fn
508  ()</pre>
509
510
511</td>
512
513<td>
514<p>Access to the <a href = "#eq_fn3735929080"><tt>eq_fn</tt></a> object.</p>
515
516
517</td>
518
519</tr>
520
521<tr>
522<td>
523<pre><b>const</b> <a href = "#eq_fn3735929080">eq_fn</a> &amp;
524  get_eq_fn
525  () <b>const</b></pre>
526
527
528</td>
529
530<td>
531<p>Const access to the <a href = "#eq_fn3735929080"><tt>eq_fn</tt></a> object.</p>
532
533
534</td>
535
536</tr>
537
538<tr>
539<td>
540<pre><a href = "#Resize_Policy3735929904">Resize_Policy</a> &amp;
541  get_resize_policy
542  ()</pre>
543
544
545</td>
546
547<td>
548<p>Access to the <a href = "#resize_policy3735929968"><tt>resize_policy</tt></a> object.</p>
549
550
551</td>
552
553</tr>
554
555<tr>
556<td>
557<pre><b>const</b> <a href = "#resize_policy3735929968">resize_policy</a> &amp;
558  get_resize_policy
559  () <b>const</b></pre>
560
561
562</td>
563
564<td>
565<p>Const access to the <a href = "#resize_policy3735929968"><tt>resize_policy</tt></a> object.</p>
566
567
568</td>
569
570</tr>
571
572</table>
573
574<h2>
575<a name = "link6">Resize methods.
576</a>
577
578</h2>
579
580<table WIDTH = "100%" BORDER = "1">
581<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
582
583
584<tr>
585<td>
586<pre><b>virtual</b> <b>void</b>
587  do_resize
588  (size_type new_size)</pre>
589
590
591</td>
592
593<td>
594<p>Resizes the container object to <font color = "#666666"><tt>new_size</tt></font>.</p>
595
596
597</td>
598
599</tr>
600
601</table>
602
603
604
605</body>
606
607</html>
608
609
610