aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/docs/html/ext/pb_assoc/interface.html
blob: d5b5eb66f9d2ce2a2fa24c7582b7f32145c23b24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
    <TITLE>Interface</TITLE>
    <META NAME="Generator" content="Microsoft Visual Studio .NET 7.1">
</HEAD>
<BODY>

<H1>Interface</H1>
<p>
    Following is the library's interface:
</p>
<ol>
	<li> <a href = "tutorial.html">Short Tutorial</a> is a short tutorial. </li>
	<li> <a href="#containers">Containers</a>  describes the containers of
the library.
    </li>
    <li>
    <a href="#ds_pol">Data-Type Policies</a> describes data-type policies.
    </li>
    <li>
    <a href="#ds_tag">Data-Structure Tags and Traits</a> describes
    tags and traits identifying the underlying data-structure and its behaviour.
    </li>
    <li>
    <a href="#ms_tag">Mapping-Semantics Tags and Traits</a> describes
    tags and traits identifying the mapping-semantics.
    </li>
    <li>
    <a href = "#ds_policy_classes">Data-Structure Policy Classes</a> describes
    policies for configuring underlying data-structures.
    </li>
    <li>
    <a href="#exceptions">Exceptions</a> Subsection desribes exception classes.
    </li>
</ol>


<hr>



<h2><a name = "containers">Containers</a></h2>

<p>
<a href = "overview.html">Overview</a> and
<a href = "ds_gen.html">Data-Structure Genericity</a> discuss relevant design
points.
</p>

<h6 align = "center">
<a name = "cd">
<img src = "cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
class hierarchy.
</h6>

<ol>
	<li>
		Basic Associative-Containers:
		<ol>
			<li><a href = "basic_assoc_cntnr.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;map&quot; case</li>
			<li><a href = "basic_assoc_cntnr_no_data.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;set&quot; case</li>
			<li><a href = "basic_assoc_cntnr_compound_data.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;multimap&quot; case</li>
		</ol>
	</li>
	<li>
		Hash-Based Associative-Containers:
		<ol>
		<li><a href = "basic_hash_assoc_cntnr.html"><tt>basic_hash_assoc_cntnr</tt></a> - basic hash-based associative-container </li>
		<li><a href = "cc_hash_assoc_cntnr.html"><tt>cc_hash_assoc_cntnr</tt></a> - collision-chaining hash-based associative-container </li>
		<li><a href = "gp_hash_assoc_cntnr.html"><tt>gp_hash_assoc_cntnr</tt></a> - (general) probing hash-based associative-container </li>
		</ol>
	</li>
	<li>
		Tree-Based Associative-Containers:
		<ol>
		<li><a href = "basic_tree_assoc_cntnr.html"><tt>basic_tree_assoc_cntnr</tt></a> - basic tree-based associative-container </li>
		<li><a href = "basic_tree_assoc_cntnr_rev.html"><tt>basic_tree_assoc_cntnr</tt></a> - basic tree-based associative-container with reverse iteration </li>
		<li><a href = "tree_assoc_cntnr.html"><tt>tree_assoc_cntnr</tt></a> - tree-based associative-container </li>
		</ol>
	</li>
	<li>
		List-Based Associative-Contaiers:
	<ol>
		<li><a href = "lu_assoc_cntnr.html"><tt>lu_assoc_cntnr</tt></a> - list-based update-policy associative container</li>
	</ol>
	</li>
</ol>


<hr>


<h2><a name = "ds_pol">Data-Type Policies</a></h2>

<p>
<a href = "overview.html">Overview</a> and
<a href = "ms_gen.html">Mapping-Semantic Genericity</a> discuss relevant design
points.
</p>

<ol>
	<li><a href = "null_data_type.html"><tt>null_data_type</tt></a>
	</li>
	<li><a href = "compound_data_type.html"><tt>compound_data_type</tt></a>
	</li>
</ol>

<hr>




<h2><a name = "ds_tag">Data-Structure Tags and Traits</a></h2>

<p>

</p>

<h3>Data-Structure Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "ds_tag_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Data-Structure Tag class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_ds_tag.html"><tt>basic_ds_tag</tt></a></li>
	<li> <a href = "basic_hash_ds_tag.html"><tt>basic_hash_ds_tag</tt></a></li>
	<li> <a href = "cc_hash_ds_tag.html"><tt>cc_hash_ds_tag</tt></a></li>
	<li> <a href = "gp_hash_ds_tag.html"><tt>gp_hash_ds_tag</tt></a></li>
	<li> <a href = "basic_tree_ds_tag.html"><tt>basic_tree_ds_tag</tt></a></li>
	<li> <a href = "rb_tree_ds_tag.html"><tt>rb_tree_ds_tag</tt></a></li>
	<li> <a href = "splay_tree_ds_tag.html"><tt>splay_tree_ds_tag</tt></a></li>
	<li> <a href = "ov_tree_ds_tag.html"><tt>ov_tree_ds_tag</tt></a></li>
	<li> <a href = "lu_ds_tag.html"><tt>lu_ds_tag</tt></a></li>
	<li> <a href = "compound_ds_tag.html"><tt>compound_ds_tag</tt></a></li>
</ol>


<h3>Invalidation-Guarantee Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "invalidation_guarantee_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Invalidation guarantees class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_invalidation_guarantee.html"><tt>basic_invalidation_guarantee</tt></a></li>
	<li> <a href = "find_invalidation_guarantee.html"><tt>find_invalidation_guarantee</tt></a></li>
	<li> <a href = "range_invalidation_guarantee.html"><tt>range_invalidation_guarantee</tt></a></li>
</ol>

<h3>Data-Structure Traits</h3>

<ol>
	<li> <a href = "ds_traits.html"><tt>ds_traits</tt></a></li>
</ol>


<hr>


<h2><a name = "ms_tag">Mapping-Semantics Tags and Traits</a></h2>

<p>

</p>

<h3>Mapping-Semantics Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "ms_tag_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Mapping-Semantics Tag class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_ms_tag.html"><tt>basic_ms_tag</tt></a></li>
	<li> <a href = "data_enabled_ms_tag.html"><tt>data_enabled_ms_tag</tt></a></li>
	<li> <a href = "compound_data_enabled_ms_tag.html"><tt>compound_data_enabled_ms_tag</tt></a></li>
</ol>


<h3>Mapping-Semantics Traits</h3>

<ol>
	<li> <a href = "ms_traits.html"><tt>ms_traits</tt></a></li>
</ol>


<hr>


<h2><a name="ds_policy_classes">Data-Structure Policy Classes</a></h2>


<h3>Hash-Related Policies</h3>

<p>
</p><a href = "hash_based_containers.html">Hash-Based Containers</a> describes
relevant design points.
</p>

<h4>Hash and Probe Policies</h4>
<ol>
    <li> Hash Functions:
        <ol>
            <li> <a href="null_hash_fn.html"><tt>null_hash_fn</tt></a></li>
        </ol>
    </li>
    <li> Range-Hashing Functions:
    <ol>
        <li><a href="sample_range_hashing.html">Interface of a Range-Hashing Function</a></li>
        <li> <a href="direct_mask_range_hashing.html"><tt>direct_mask_range_hashing</tt></a></li>
        <li> <a href="direct_mod_range_hashing.html"><tt>direct_mod_range_hashing</tt></a></li>
    </ol>
    </li>
    <li> Probe Functions:
    <ol>
        <li> <a href="sample_probe_fn.html">Interface of a Probe Function</a></li>
        <li> <a href="linear_probe_fn.html"><tt>linear_probe_fn</tt></a></li>
        <li> <a href="quadratic_probe_fn.html"><tt>quadratic_probe_fn</tt></a></li>
        <li> <a href="null_probe_fn.html"><tt>null_probe_fn</tt></a></li>
    </ol>
    </li>
    <li> Ranged-Hash Functions:
        <ol>
            <li><a href="ranged_hash_fn.html">Interface of a Ranged-Hash Function</a></li>
        </ol>
    </li>
    <li> Ranged-Probe Functions:
        <ol>
            <li> <a href="ranged_probe_fn.html">Interface of a Ranged-Probe function</a></li>
        </ol>
    </li>
</ol>



<h4>Resize Policies</h4>

<h6 align = "center">
<a name = "resize_policy_cd">
<img src = "resize_policy_cd.jpg" width = "70%" alt = "no image">
</a>
</h6>
<h6 align = "center">
Resize policy class diagram.
</h6>

<ol>
    <li> Resize Policies:
        <ol>
            <li> <a href="sample_resize_policy.html">Interface of a Resize Policy</a>
            <li> <a href="hash_standard_resize_policy.html"><tt>hash_standard_resize_policy</tt></a></li>
        </ol>
    </li>
    <li> Size Policies:
    <ol>
        <li> <a href="sample_size_policy.html">Interface of a Size Policy</a></li>
        <li> <a href="hash_exponential_size_policy.html"><tt>hash_exponential_size_policy</tt></a></li>
        <li> <a href="hash_prime_size_policy.html"><tt>hash_prime_size_policy</tt></a></li>
    </ol>
    </li>
    <li> Trigger Policies:
    <ol>
        <li><a href="sample_resize_trigger.html">Interface of a Trigger Policy</a></li>
        <li> <a href="hash_load_check_resize_trigger.html"><tt>hash_load_check_resize_trigger</tt></a></li>
        <li> <a href="cc_hash_max_collision_check_resize_trigger.html"><tt>cc_hash_max_collision_check_resize_trigger</tt></a></li>
    </ol>
    </li>
</ol>



<h3>Tree Node-Update Policies</h3>
<ol>
    <li> <a href = "node_invariants.html">Design of Node Update Policies</a></li>
    <li> <a href="sample_node_updator.html">Interface of a Node Updator Policy</a></li>
    <li> Order-Statistics (Finding Entries by Key Order):
        <ol>
            <li> <a href="order_statistics_key.html"><tt>order_statistics_key</tt></a></li>
            <li> <a href="order_statistics_key_cmp.html"><tt>order_statistics_key_cmp</tt></a></li>
            <li> <a href="order_statistics_node_updator.html"><tt>order_statistics_node_updator</tt></a></li>
            <li> <a href="find_by_order.html"><tt>find_by_order</tt></a></li>
            <li> <a href="order_by_key.html"><tt>order_by_key</tt></a></li>
        </ol>
    </li>
    <li> <a href="null_node_updator.html"><tt>null_node_updator</tt></a></li>
</ol>


<h3>List Update Policies</h3>
<ol>
    <li> <a href = "list_updates.html">Design of List Update Policies</a> </li>
    <li> <a href = "sample_update_policy.html">Interface of a List Update Policy</a> </li>
    <li> Move-to-Front:
        <ol>
            <li> <a href="move_to_front_update_metadata.html"><tt>move_to_front_update_metadata</tt></a></li>
            <li> <a href="move_to_front_update_policy.html"><tt>move_to_front_update_policy</tt></a></li>
        </ol>
    </li>
    <li> Counter:
        <ol>
            <li> <a href="counter_update_metadata.html"><tt>counter_update_metadata</tt></a></li>
            <li> <a href="counter_update_policy.html"><tt>counter_update_policy</tt></a></li>
        </ol>
    </li>
</ol>


<hr>




<h2><a name="exceptions">Exceptions</a></h2>
<ol>
	<li> <a href="pb_assoc_ex.html"><tt>pb_assoc_ex</tt></a></li>
    <li> <a href="cannot_insert.html"><tt>cannot_insert</tt></a></li>
    <li> <a href="cannot_join.html"><tt>cannot_join</tt></a></li>
    <li> <a href="cannot_resize.html"><tt>cannot_resize</tt></a></li>
</ol>


</BODY>
</HTML>