1
2<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
4
5<html>
6<head>
7<title>lu_assoc_cntnr Interface
8</title>
9
10</head>
11
12<body>
13<h1>
14<tt>lu_assoc_cntnr
15</tt>
16
17 Interface
18
19
20</h1>
21
22<p>A list-update 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</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 = "Eq_Fn3735929016">Eq_Fn</a></pre>
138
139
140</td>
141
142<td>
143<p>Equivalence functor.</p>
144
145
146</td>
147
148<td>
149<pre>std::equal_to&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>
150
151
152</td>
153
154</tr>
155
156<tr>
157<td>
158<pre><a name = "Update_Policy3735929889">Update_Policy</a></pre>
159
160
161</td>
162
163<td>
164<p>Update policy (determines when an element will be moved to the front of the list.</p>
165
166
167</td>
168
169<td>
170<a href = "move_to_front_update_policy.html"><tt>move_to_front_update_policy</tt></a>
171
172
173</td>
174
175</tr>
176
177<tr>
178<td>
179<pre><a name = "Allocator3735929488">Allocator</a></pre>
180
181
182</td>
183
184<td>
185<p>Allocator type.</p>
186
187
188</td>
189
190<td>
191<pre>std::allocator&lt;<b>char</b>&gt;</pre>
192
193
194</td>
195
196</tr>
197
198</table>
199
200<h2>
201<a name = "link2">Base classes.
202</a>
203
204</h2>
205
206<table WIDTH = "100%" BORDER = "1">
207<TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
208
209
210<tr>
211<td>
212<pre><a href = "#Update_Policy3735929889">Update_Policy</a></pre>
213
214
215</td>
216
217<td>
218<p>public</p>
219
220
221</td>
222
223</tr>
224
225</table>
226
227<h2>
228<a name = "link3">Policy definitions.
229</a>
230
231</h2>
232
233<table WIDTH = "100%" BORDER = "1">
234<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>
235
236
237<tr>
238<td>
239<pre><a name = "eq_fn3735929080">eq_fn</a></pre>
240
241
242</td>
243
244<td>
245<pre><a href = "#Eq_Fn3735929016">Eq_Fn</a></pre>
246
247
248</td>
249
250<td>
251<p>Equivalence functor type.</p>
252
253
254</td>
255
256</tr>
257
258<tr>
259<td>
260<pre><a name = "allocator3735929520">allocator</a></pre>
261
262
263</td>
264
265<td>
266<pre><a href = "#Allocator3735929488">Allocator</a></pre>
267
268
269</td>
270
271<td>
272<p>Allocator type.</p>
273
274
275</td>
276
277</tr>
278
279<tr>
280<td>
281<pre><a name = "update_policy3735929953">update_policy</a></pre>
282
283
284</td>
285
286<td>
287<pre><a href = "#Update_Policy3735929889">Update_Policy</a></pre>
288
289
290</td>
291
292<td>
293<p>List update policy type.</p>
294
295
296</td>
297
298</tr>
299
300</table>
301
302<h2>
303<a name = "link4">Constructors, destructor, and related.
304</a>
305
306</h2>
307
308<table WIDTH = "100%" BORDER = "1">
309<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
310
311
312<tr>
313<td>
314<pre>  lu_assoc_cntnr
315  ()</pre>
316
317
318</td>
319
320<td>
321<p>Default constructor.</p>
322
323
324</td>
325
326</tr>
327
328<tr>
329<td>
330<pre>  lu_assoc_cntnr
331  (<b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn)</pre>
332
333
334</td>
335
336<td>
337<p>Constructor taking some policy objects. <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>
338
339
340</td>
341
342</tr>
343
344<tr>
345<td>
346<pre>  lu_assoc_cntnr
347  (<b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
348    <b>const</b> <a href = "#Update_Policy3735929889">Update_Policy</a> &amp;r_update_policy)</pre>
349
350
351</td>
352
353<td>
354<p>Constructor taking some policy objects. <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_update_policy</tt></font> will be copied by the <a href = "#Update_Policy3735929889"><tt>Update_Policy</tt></a> object of the container object.</p>
355
356
357</td>
358
359</tr>
360
361<tr>
362<td>
363<pre><b>template</b>&lt;<b>class</b> It&gt;
364  lu_assoc_cntnr
365  (It first_it, It last_it)</pre>
366
367
368</td>
369
370<td>
371<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>
372
373
374</td>
375
376</tr>
377
378<tr>
379<td>
380<pre><b>template</b>&lt;<b>class</b> It&gt;
381  lu_assoc_cntnr
382  (It first_it, It last_it,
383    <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn)</pre>
384
385
386</td>
387
388<td>
389<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>
390
391
392</td>
393
394</tr>
395
396<tr>
397<td>
398<pre><b>template</b>&lt;<b>class</b> It&gt;
399  lu_assoc_cntnr
400  (It first_it, It last_it,
401    <b>const</b> <a href = "#Eq_Fn3735929016">Eq_Fn</a> &amp;r_eq_fn,
402    <b>const</b> <a href = "#Update_Policy3735929889">Update_Policy</a> &amp;r_update_policy)</pre>
403
404
405</td>
406
407<td>
408<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>
409
410
411</td>
412
413</tr>
414
415<tr>
416<td>
417<pre>  lu_assoc_cntnr
418  (<b>const</b> <font color = "olive">lu_assoc_cntnr</font> &amp;r_other)</pre>
419
420
421</td>
422
423<td>
424<p>Copy constructor.</p>
425
426
427</td>
428
429</tr>
430
431<tr>
432<td>
433<pre><b>virtual</b>
434  ~lu_assoc_cntnr
435  ()</pre>
436
437
438</td>
439
440<td>
441<p>Destructor.</p>
442
443
444</td>
445
446</tr>
447
448<tr>
449<td>
450<pre><font color = "olive">lu_assoc_cntnr</font> &amp;
451  <b>operator</b>=
452  (<b>const</b> <font color = "olive">lu_assoc_cntnr</font> &amp;r_other)</pre>
453
454
455</td>
456
457<td>
458<p>Assignment operator.</p>
459
460
461</td>
462
463</tr>
464
465<tr>
466<td>
467<pre><b>void</b>
468  swap
469  (<font color = "olive">lu_assoc_cntnr</font> &amp;r_other)</pre>
470
471
472</td>
473
474<td>
475<p>Swaps content.</p>
476
477
478</td>
479
480</tr>
481
482</table>
483
484<h2>
485<a name = "link5">Policy access methods.
486</a>
487
488</h2>
489
490<table WIDTH = "100%" BORDER = "1">
491<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
492
493
494<tr>
495<td>
496<pre><a href = "#eq_fn3735929080">eq_fn</a> &amp;
497  get_eq_fn
498  ()</pre>
499
500
501</td>
502
503<td>
504<p>Access to the <a href = "#eq_fn3735929080"><tt>eq_fn</tt></a> object.</p>
505
506
507</td>
508
509</tr>
510
511<tr>
512<td>
513<pre><b>const</b> <a href = "#eq_fn3735929080">eq_fn</a> &amp;
514  get_eq_fn
515  () <b>const</b></pre>
516
517
518</td>
519
520<td>
521<p>Const access to the <a href = "#eq_fn3735929080"><tt>eq_fn</tt></a> object.</p>
522
523
524</td>
525
526</tr>
527
528<tr>
529<td>
530<pre><a href = "#update_policy3735929953">update_policy</a> &amp;
531  get_update_policy
532  ()</pre>
533
534
535</td>
536
537<td>
538<p>Access to the <a href = "#update_policy3735929953"><tt>update_policy</tt></a> object.</p>
539
540
541</td>
542
543</tr>
544
545<tr>
546<td>
547<pre><b>const</b> <a href = "#update_policy3735929953">update_policy</a> &amp;
548  get_update_policy
549  () <b>const</b></pre>
550
551
552</td>
553
554<td>
555<p>Const access to the <a href = "#update_policy3735929953"><tt>update_policy</tt></a> object.</p>
556
557
558</td>
559
560</tr>
561
562</table>
563
564
565
566</body>
567
568</html>
569
570
571