Merge -r 127928:132243 from trunk
[official-gcc.git] / libstdc++-v3 / doc / html / ext / pb_ds / string_trie_e_access_traits.html
blob10fa2af1c9d5864d893663716f8b130075504ca2
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
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" />
9 <title>string_trie_e_access_traits Interface</title>
10 <meta http-equiv="Content-Type" content=
11 "text/html; charset=us-ascii" />
12 </head>
14 <body>
15 <div id="page">
16 <h1><tt>string_trie_e_access_traits</tt> Interface</h1>
18 <p>Element access traits for string types.</p>
20 <p>Defined in: <a href=
21 "../../../../include/ext/pb_ds/trie_policy.hpp"><tt>trie_policy.hpp</tt></a></p>
23 <h2><a name="link1" id="link1">Template Parameters</a></h2>
25 <table class="c1" width="100%" border="1" summary=
26 "Template Parameters">
27 <tr>
28 <td width="20%" align="left"><b>Parameter</b></td>
30 <td width="50%" align="left"><b>Description</b></td>
32 <td width="30%" align="left"><b>Default Value</b></td>
33 </tr>
35 <tr>
36 <td>
37 <pre>
38 <a name="String349403" id="String349403"><b>class</b> String </a>
39 </pre>
40 </td>
42 <td>
43 <p>String type.</p>
44 </td>
46 <td><tt>std::string</tt></td>
47 </tr>
49 <tr>
50 <td>
51 <pre>
52 <a name="Min_E_Val40354618" id=
53 "Min_E_Val40354618"><b>typename</b> </a><a href=
54 "#String349403"><tt>String</tt></a>::value_type Min_E_Val
55 </pre>
56 </td>
58 <td>
59 <p>Minimal element.</p>
60 </td>
62 <td><tt>SCHAR_MIN</tt></td>
63 </tr>
65 <tr>
66 <td>
67 <pre>
68 <a name="Max_E_Val39885868" id=
69 "Max_E_Val39885868"><b>typename</b> </a><a href=
70 "#String349403"><tt>String</tt></a>::value_type Max_E_Val
71 </pre>
72 </td>
74 <td>
75 <p>Maximal element.</p>
76 </td>
78 <td><tt>SCHAR_MAX</tt></td>
79 </tr>
81 <tr>
82 <td>
83 <pre>
84 <a name="Reverse1686776" id=
85 "Reverse1686776"><b>bool</b> Reverse </a>
86 </pre>
87 </td>
89 <td>
90 <p>Indicates whether reverse iteration should be
91 used.</p>
92 </td>
94 <td><tt><b>false</b></tt></td>
95 </tr>
97 <tr>
98 <td>
99 <pre>
100 <a name="Allocator35940069" id=
101 "Allocator35940069"><b>class</b> Allocator </a>
102 </pre>
103 </td>
105 <td>
106 <p>Allocator type.</p>
107 </td>
109 <td>
110 <pre>
111 std::allocator&lt;<b>char</b>&gt;
112 </pre>
113 </td>
114 </tr>
115 </table>
117 <h2><a name="link2" id="link2">Public Types and
118 Constants</a></h2>
120 <h3><a name="link3" id="link3">General Definitions</a></h3>
122 <table class="c1" width="100%" border="1" summary="Types">
123 <tr>
124 <td width="30%" align="left"><b>Type</b></td>
126 <td width="55%" align="left"><b>Definition</b></td>
128 <td width="15%" align="left"><b>Description</b></td>
129 </tr>
131 <tr>
132 <td>
133 <pre>
134 <a name="size_type55424436" id="size_type55424436">size_type</a>
135 </pre>
136 </td>
138 <td>
139 <pre>
140 <b>typename</b> <a href=
141 "#Allocator35940069"><tt>Allocator</tt></a>::size_type
142 </pre>
143 </td>
145 <td>
146 <p>Size type.</p>
147 </td>
148 </tr>
149 </table>
151 <h3><a name="link4" id="link4">Key-Type Definitions</a></h3>
153 <table class="c1" width="100%" border="1" summary="Types">
154 <tr>
155 <td width="30%" align="left"><b>Type</b></td>
157 <td width="55%" align="left"><b>Definition</b></td>
159 <td width="15%" align="left"><b>Description</b></td>
160 </tr>
162 <tr>
163 <td>
164 <pre>
165 <a name="key_type10393186" id="key_type10393186">key_type</a>
166 </pre>
167 </td>
169 <td>
170 <pre>
171 <a href="#String349403"><tt>String</tt></a>
172 </pre>
173 </td>
175 <td>
176 <p>Key type.</p>
177 </td>
178 </tr>
180 <tr>
181 <td>
182 <pre>
183 <a name="const_key_reference3185471705" id=
184 "const_key_reference3185471705">const_key_reference</a>
185 </pre>
186 </td>
188 <td>
189 <pre>
190 <b>typename</b> <a href=
191 "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
192 <a href=
193 "#key_type10393186"><tt>key_type</tt></a>&gt;::other::const_reference
194 </pre>
195 </td>
197 <td>
198 <p>Const key reference type.</p>
199 </td>
200 </tr>
201 </table>
203 <h3><a name="link5" id="link5">Element-Type
204 Definitions</a></h3>
206 <table class="c1" width="100%" border="1" summary="Types">
207 <tr>
208 <td width="30%" align="left"><b>Type</b></td>
210 <td width="55%" align="left"><b>Definition</b></td>
212 <td width="15%" align="left"><b>Description</b></td>
213 </tr>
215 <tr>
216 <td>
217 <pre>
218 <a name="reverse2186776" id="reverse2186776">reverse</a>
219 </pre>
220 </td>
222 <td>
223 <pre>
224 <a href="#Reverse1686776"><tt>Reverse</tt></a>
225 </pre>
226 </td>
228 <td>
229 <p><a href="#Reverse1686776"><tt>Reverse</tt></a>
230 iteration indicator.</p>
231 </td>
232 </tr>
234 <tr>
235 <td>
236 <pre>
237 <a name="const_iterator98626788" id=
238 "const_iterator98626788">const_iterator</a>
239 </pre>
240 </td>
242 <td>
243 <pre>
244 <b>typename</b> __gnu_pbds::detail::__conditional_type&lt;
245 <a href="#Reverse1686776"><tt>Reverse</tt></a>,
246 <b>typename</b> <a href=
247 "#String349403"><tt>String</tt></a>::const_reverse_iterator,
248 <b>typename</b> <a href=
249 "#String349403"><tt>String</tt></a>::const_iterator&gt;::__type
250 </pre>
251 </td>
253 <td>
254 <p>Element <tt><b>const</b></tt> iterator type.</p>
255 </td>
256 </tr>
258 <tr>
259 <td>
260 <pre>
261 <a name="e_type393186" id="e_type393186">e_type</a>
262 </pre>
263 </td>
265 <td>
266 <pre>
267 <b>typename</b> std::iterator_traits&lt;<a href=
268 "#const_iterator98626788"><tt>const_iterator</tt></a>&gt;::value_type
269 </pre>
270 </td>
272 <td>
273 <p>Element type.</p>
274 </td>
275 </tr>
277 <tr>
278 <td>
279 <pre>
280 <a name="min_e_val52875418" id="min_e_val52875418">min_e_val</a>
281 </pre>
282 </td>
284 <td>
285 <pre>
286 <a href="#Min_E_Val40354618"><tt>Min_E_Val</tt></a>
287 </pre>
288 </td>
290 <td>
291 <p>Minimal element.</p>
292 </td>
293 </tr>
295 <tr>
296 <td>
297 <pre>
298 <a name="max_e_val52406668" id="max_e_val52406668">max_e_val</a>
299 </pre>
300 </td>
302 <td>
303 <pre>
304 <a href="#Max_E_Val39885868"><tt>Max_E_Val</tt></a>
305 </pre>
306 </td>
308 <td>
309 <p>Maximal element.</p>
310 </td>
311 </tr>
313 <tr>
314 <td>
315 <pre>
316 <a name="max_size10483336" id="max_size10483336">max_size</a>
317 </pre>
318 </td>
320 <td>
321 <pre>
322 <a href="#max_e_val52406668"><tt>max_e_val</tt></a> - <a href=
323 "#min_e_val52875418"><tt>min_e_val</tt></a> + 1
324 </pre>
325 </td>
327 <td>
328 <p>Number of distinct elements.</p>
329 </td>
330 </tr>
331 </table>
333 <h2><a name="link6" id="link6">Public Methods</a></h2>
335 <h3><a name="link7" id="link7">Access Methods</a></h3>
337 <table class="c1" width="100%" border="1" summary="Methods">
338 <tr>
339 <td width="45%" align="left"><b>Method</b></td>
341 <td width="55%" align="left"><b>Description</b></td>
342 </tr>
344 <tr>
345 <td>
346 <pre>
347 <b>inline</b> <b>static</b> <a href=
348 "#const_iterator98626788"><tt>const_iterator</tt></a>
349 begin
350 (<a href=
351 "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key)
352 </pre>
353 </td>
355 <td>
356 <p>Returns a <a href=
357 "#const_iterator98626788"><tt>const_iterator</tt></a> to
358 the first element of <span class=
359 "c1"><tt>r_key</tt></span>.</p>
360 </td>
361 </tr>
363 <tr>
364 <td>
365 <pre>
366 <b>inline</b> <b>static</b> <a href=
367 "#const_iterator98626788"><tt>const_iterator</tt></a>
369 (<a href=
370 "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key)
371 </pre>
372 </td>
374 <td>
375 <p>Returns a <a href=
376 "#const_iterator98626788"><tt>const_iterator</tt></a> to
377 the after-last element of <span class=
378 "c1"><tt>r_key</tt></span>.</p>
379 </td>
380 </tr>
382 <tr>
383 <td>
384 <pre>
385 <b>inline</b> <b>static</b> <a href=
386 "#size_type55424436"><tt>size_type</tt></a>
387 e_pos
388 (<a href="#e_type393186"><tt>e_type</tt></a> e)
389 </pre>
390 </td>
392 <td>
393 <p>Maps an <span class="c1"><tt>e</tt></span>element to a
394 position.</p>
395 </td>
396 </tr>
397 </table>
398 </div>
399 </body>
400 </html>