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>basic_hash_table 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>basic_hash_table</tt> Interface</h1>
17
18    <p>An abstract basic hash-based associative container.</p>
19
20    <p>Defined in: <a href=
21    "http://gcc.gnu.org/viewcvs/*checkout*/trunk/libstdc%2B%2B-v3/include/ext/pb_ds/assoc_container.hpp"><tt>assoc_container.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="Key2501" id="Key2501"><b>typename</b> Key</a>
39</pre>
40        </td>
41
42        <td>
43          <p>Key type.</p>
44        </td>
45
46        <td>-</td>
47      </tr>
48
49      <tr>
50        <td>
51          <pre>
52<a name="Mapped318655" id="Mapped318655"><b>typename</b> Mapped</a>
53</pre>
54        </td>
55
56        <td>
57          <p>Mapped type.</p>
58        </td>
59
60        <td>-</td>
61      </tr>
62
63      <tr>
64        <td>
65          <pre>
66<a name="Hash_Fn1515835" id=
67"Hash_Fn1515835"><b>class</b> Hash_Fn</a>
68</pre>
69        </td>
70
71        <td>
72          <p>Hash functor.</p>
73        </td>
74
75        <td>-</td>
76      </tr>
77
78      <tr>
79        <td>
80          <pre>
81<a name="Eq_Fn60085" id="Eq_Fn60085"><b>class</b> Eq_Fn</a>
82</pre>
83        </td>
84
85        <td>
86          <p>Equivalence functor.</p>
87        </td>
88
89        <td>-</td>
90      </tr>
91
92      <tr>
93        <td>
94          <pre>
95<a name="Resize_Policy566860465" id=
96"Resize_Policy566860465"><b>class</b> Resize_Policy</a>
97</pre>
98        </td>
99
100        <td>
101          <p>Resize policy.</p>
102        </td>
103
104        <td>-</td>
105      </tr>
106
107      <tr>
108        <td>
109          <pre>
110<a name="Store_Hash218262104" id=
111"Store_Hash218262104"><b>bool</b> Store_Hash</a>
112</pre>
113        </td>
114
115        <td>
116          <p>Indicates whether the hash value will be stored along
117          with each key.</p>
118        </td>
119
120        <td>-</td>
121      </tr>
122
123      <tr>
124        <td>
125          <pre>
126<a name="Tag278938" id="Tag278938"><b>class</b> Tag</a>
127</pre>
128        </td>
129
130        <td>
131          <p>Mapped-structure tag.</p>
132        </td>
133
134        <td>-</td>
135      </tr>
136
137      <tr>
138        <td>
139          <pre>
140<a name="Allocator35940069" id=
141"Allocator35940069"><b>class</b> Allocator</a>
142</pre>
143        </td>
144
145        <td>
146          <p>Allocator type.</p>
147        </td>
148
149        <td>-</td>
150      </tr>
151    </table>
152
153    <h2><a name="link2" id="link2">Base Classes</a></h2>
154
155    <table class="c1" width="100%" border="1" summary="Bases">
156      <tr>
157        <td width="80%" align="left"><b>Class</b></td>
158
159        <td width="20%" align="left"><b>Derivation Type</b></td>
160      </tr>
161
162      <tr>
163        <td>
164          <pre>
165<a href="#Resize_Policy566860465"><tt>Resize_Policy</tt></a>
166</pre>
167        </td>
168
169        <td>
170          <p>public</p>
171        </td>
172      </tr>
173
174      <tr>
175        <td>
176          <pre>
177<a href="container_base.html"><span class=
178"c2"><tt>container_base</tt></span></a>
179</pre>
180        </td>
181
182        <td>
183          <p>public</p>
184        </td>
185      </tr>
186    </table>
187
188    <h2><a name="link3" id="link3">Public Types and
189    Constants</a></h2>
190
191    <h3><a name="link4" id="link4">Policy Definitions</a></h3>
192
193    <table class="c1" width="100%" border="1" summary="Types">
194      <tr>
195        <td width="30%" align="left"><b>Type</b></td>
196
197        <td width="55%" align="left"><b>Definition</b></td>
198
199        <td width="15%" align="left"><b>Description</b></td>
200      </tr>
201
202      <tr>
203        <td>
204          <pre>
205<a name="hash_fn2015995" id="hash_fn2015995">hash_fn</a>
206</pre>
207        </td>
208
209        <td>
210          <pre>
211<a href="#Hash_Fn1515835"><tt>Hash_Fn</tt></a>
212</pre>
213        </td>
214
215        <td>
216          <p>Hash functor type.</p>
217        </td>
218      </tr>
219
220      <tr>
221        <td>
222          <pre>
223<a name="eq_fn80245" id="eq_fn80245">eq_fn</a>
224</pre>
225        </td>
226
227        <td>
228          <pre>
229<a href="#Eq_Fn60085"><tt>Eq_Fn</tt></a>
230</pre>
231        </td>
232
233        <td>
234          <p>Equivalence functor type.</p>
235        </td>
236      </tr>
237
238      <tr>
239        <td>
240          <pre>
241<a name="resize_policy4084493169" id=
242"resize_policy4084493169">resize_policy</a>
243</pre>
244        </td>
245
246        <td>
247          <pre>
248<a href="#Resize_Policy566860465"><tt>Resize_Policy</tt></a>
249</pre>
250        </td>
251
252        <td>
253          <p>Resize policy type.</p>
254        </td>
255      </tr>
256
257      <tr>
258        <td>
259          <pre>
260<a name="store_hash280766104" id=
261"store_hash280766104">store_hash</a>
262</pre>
263        </td>
264
265        <td>
266          <pre>
267<a href="#Store_Hash218262104"><tt>Store_Hash</tt></a>
268</pre>
269        </td>
270
271        <td>
272          <p>Indicates whether a hash value is stored with each
273          entry.</p>
274        </td>
275      </tr>
276    </table>
277
278    <h2><a name="link5" id="link5">Public Methods</a></h2>
279
280    <h3><a name="link6" id="link6">Constructors, Destructor, and
281    Related</a></h3>
282
283    <table class="c1" width="100%" border="1" summary="Methods">
284      <tr>
285        <td width="45%" align="left"><b>Method</b></td>
286
287        <td width="55%" align="left"><b>Description</b></td>
288      </tr>
289
290      <tr>
291        <td>
292          <pre>
293<b>virtual</b> 
294  ~basic_hash_table
295  ()
296</pre>
297        </td>
298
299        <td>
300          <p>Destructor.</p>
301        </td>
302      </tr>
303    </table>
304
305    <h3><a name="link7" id="link7">Policy Access Methods</a></h3>
306
307    <table class="c1" width="100%" border="1" summary="Methods">
308      <tr>
309        <td width="45%" align="left"><b>Method</b></td>
310
311        <td width="55%" align="left"><b>Description</b></td>
312      </tr>
313
314      <tr>
315        <td>
316          <pre>
317<a href="#hash_fn2015995"><tt>hash_fn</tt></a> &amp;
318  get_hash_fn
319  ()
320</pre>
321        </td>
322
323        <td>
324          <p>Access to the <a href=
325          "#hash_fn2015995"><tt>hash_fn</tt></a> object.</p>
326        </td>
327      </tr>
328
329      <tr>
330        <td>
331          <pre>
332<b>const</b> <a href="#hash_fn2015995"><tt>hash_fn</tt></a> &amp;
333  get_hash_fn
334  () <b>const</b>
335</pre>
336        </td>
337
338        <td>
339          <p>Const access to the <a href=
340          "#hash_fn2015995"><tt>hash_fn</tt></a> object.</p>
341        </td>
342      </tr>
343
344      <tr>
345        <td>
346          <pre>
347<a href="#eq_fn80245"><tt>eq_fn</tt></a> &amp;
348  get_eq_fn
349  ()
350</pre>
351        </td>
352
353        <td>
354          <p>Access to the <a href="#eq_fn80245"><tt>eq_fn</tt></a>
355          object.</p>
356        </td>
357      </tr>
358
359      <tr>
360        <td>
361          <pre>
362<b>const</b> <a href="#eq_fn80245"><tt>eq_fn</tt></a> &amp;
363  get_eq_fn
364  () <b>const</b>
365</pre>
366        </td>
367
368        <td>
369          <p>Const access to the <a href=
370          "#eq_fn80245"><tt>eq_fn</tt></a> object.</p>
371        </td>
372      </tr>
373
374      <tr>
375        <td>
376          <pre>
377<a href="#resize_policy4084493169"><tt>resize_policy</tt></a> &amp;
378  get_resize_policy
379  ()
380</pre>
381        </td>
382
383        <td>
384          <p>Access to the <a href=
385          "#resize_policy4084493169"><tt>resize_policy</tt></a>
386          object.</p>
387        </td>
388      </tr>
389
390      <tr>
391        <td>
392          <pre>
393<b>const</b> <a href=
394"#resize_policy4084493169"><tt>resize_policy</tt></a> &amp;
395  get_resize_policy
396  () <b>const</b>
397</pre>
398        </td>
399
400        <td>
401          <p>Const access to the <a href=
402          "#resize_policy4084493169"><tt>resize_policy</tt></a>
403          object.</p>
404        </td>
405      </tr>
406    </table>
407
408    <h2><a name="link8" id="link8">Private Methods</a></h2>
409
410    <h3><a name="link9" id="link9">Resize Methods</a></h3>
411
412    <table class="c1" width="100%" border="1" summary="Methods">
413      <tr>
414        <td width="45%" align="left"><b>Method</b></td>
415
416        <td width="55%" align="left"><b>Description</b></td>
417      </tr>
418
419      <tr>
420        <td>
421          <pre>
422<b>virtual</b> <b>void</b> 
423  do_resize
424  (size_type new_size)
425</pre>
426        </td>
427
428        <td>
429          <p>Resizes the container object to <span class=
430          "c1"><tt>new_size</tt></span>.</p>
431        </td>
432      </tr>
433    </table>
434  </div>
435</body>
436</html>
437