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>trie::const_node_iterator 10 Interface</title> 11 <meta http-equiv="Content-Type" content= 12 "text/html; charset=us-ascii" /> 13 </head> 14 15<body> 16 <div id="page"> 17 <h1><tt><span class= 18 "c2"><tt>trie</tt></span>::const_node_iterator</tt> 19 Interface</h1> 20 21 <p>Const node iterator.</p> 22 23 <p>This is an "iterator to an iterator" - it iterates over 24 nodes, and de-referencing it returns one of the tree's const 25 iterators</p> 26 27 <h2><a name="link1" id="link1">Public Types and 28 Constants</a></h2> 29 30 <h3><a name="link2" id="link2">General Container 31 Definitions</a></h3> 32 33 <table class="c1" width="100%" border="1" summary="Types"> 34 <tr> 35 <td width="30%" align="left"><b>Type</b></td> 36 37 <td width="55%" align="left"><b>Definition</b></td> 38 39 <td width="15%" align="left"><b>Description</b></td> 40 </tr> 41 42 <tr> 43 <td> 44 <pre> 45<a name="size_type55424436" id="size_type55424436">size_type</a> 46</pre> 47 </td> 48 49 <td> 50 <pre> 51<a href="container_base.html#size_type55424436"><span class= 52"c2"><tt>container_base</tt></span>::size_type</a> 53</pre> 54 </td> 55 56 <td> 57 <p>Size type.</p> 58 </td> 59 </tr> 60 </table> 61 62 <h3><a name="link3" id="link3">Iterator Definitions</a></h3> 63 64 <table class="c1" width="100%" border="1" summary="Types"> 65 <tr> 66 <td width="30%" align="left"><b>Type</b></td> 67 68 <td width="55%" align="left"><b>Definition</b></td> 69 70 <td width="15%" align="left"><b>Description</b></td> 71 </tr> 72 73 <tr> 74 <td> 75 <pre> 76<a name="iterator_category2821876439" id= 77"iterator_category2821876439">iterator_category</a> 78</pre> 79 </td> 80 81 <td> 82 <pre> 83trivial_iterator_tag 84</pre> 85 </td> 86 87 <td> 88 <p>Category.</p> 89 90 <p>This tag identifies that the iterator has none of the 91 STL's iterators' movement abilities.</p> 92 </td> 93 </tr> 94 95 <tr> 96 <td> 97 <pre> 98<a name="difference_type868028452" id= 99"difference_type868028452">difference_type</a> 100</pre> 101 </td> 102 103 <td> 104 <pre class="c2"> 105void 106</pre> 107 </td> 108 109 <td> 110 <p>Difference type.</p> 111 </td> 112 </tr> 113 </table> 114 115 <h3><a name="link4" id="link4">Value-Type Definitions</a></h3> 116 117 <table class="c1" width="100%" border="1" summary="Types"> 118 <tr> 119 <td width="30%" align="left"><b>Type</b></td> 120 121 <td width="55%" align="left"><b>Definition</b></td> 122 123 <td width="15%" align="left"><b>Description</b></td> 124 </tr> 125 126 <tr> 127 <td> 128 <pre> 129<a name="value_type279018186" id= 130"value_type279018186">value_type</a> 131</pre> 132 </td> 133 134 <td> 135 <pre> 136<a href= 137"container_base.html#const_iterator98626788"><span class="c2"><tt>container_base</tt></span>::const_iterator</a> 138</pre> 139 </td> 140 141 <td> 142 <p>Iterator's value type.</p> 143 </td> 144 </tr> 145 146 <tr> 147 <td> 148 <pre> 149<a name="reference54418471" id="reference54418471">reference</a> 150</pre> 151 </td> 152 153 <td> 154 <pre> 155<a href="#value_type279018186"><tt>value_type</tt></a> 156</pre> 157 </td> 158 159 <td> 160 <p>Iterator's reference type.</p> 161 </td> 162 </tr> 163 164 <tr> 165 <td> 166 <pre> 167<a name="const_reference495461441" id= 168"const_reference495461441">const_reference</a> 169</pre> 170 </td> 171 172 <td> 173 <pre> 174<a href="#value_type279018186"><tt>value_type</tt></a> 175</pre> 176 </td> 177 178 <td> 179 <p>Iterator's const <a href= 180 "#reference54418471"><tt>reference</tt></a> type.</p> 181 </td> 182 </tr> 183 184 <tr> 185 <td> 186 <pre> 187<a name="e_access_traits1948190928" id= 188"e_access_traits1948190928">e_access_traits</a> 189</pre> 190 </td> 191 192 <td> 193 <pre> 194<a href= 195"trie.html#e_access_traits1948190928"><span class="c2"><tt>trie</tt></span>::e_access_traits</a> 196</pre> 197 </td> 198 199 <td> 200 <p>Element access traits.</p> 201 </td> 202 </tr> 203 204 <tr> 205 <td> 206 <pre> 207<a name="const_e_iterator2450008044" id= 208"const_e_iterator2450008044">const_e_iterator</a> 209</pre> 210 </td> 211 212 <td> 213 <pre> 214<b>typename</b> <a href= 215"#e_access_traits1948190928"><tt>e_access_traits</tt></a>::const_iterator 216</pre> 217 </td> 218 219 <td> 220 <p>A key's element const iterator.</p> 221 </td> 222 </tr> 223 </table> 224 225 <h3><a name="link5" id="link5">Metadata Definitions</a></h3> 226 227 <p>These are only defined if <a href= 228 "basic_tree.html#Node_Update841554648"><span class="c2"> 229 <tt>basic_tree</tt></span>::Node_Update</a> 230 is not <a href="null_trie_node_update.html"><span class= 231 "c2"><tt>null_trie_node_update</tt></span></a></p> 232 233 <table class="c1" width="100%" border="1" summary="Types"> 234 <tr> 235 <td width="30%" align="left"><b>Type</b></td> 236 237 <td width="55%" align="left"><b>Definition</b></td> 238 239 <td width="15%" align="left"><b>Description</b></td> 240 </tr> 241 242 <tr> 243 <td> 244 <pre> 245<a name="metadata_type2849297114" id= 246"metadata_type2849297114">metadata_type</a> 247</pre> 248 </td> 249 250 <td> 251 <pre> 252<tt><b>typename</b></tt> <a href= 253"basic_tree.html#Node_Update841554648"><span class="c2"><tt>basic_tree</tt></span>::Node_Update</a><tt>::metadata_type</tt> 254</pre> 255 </td> 256 257 <td> 258 <p>Metadata type.</p> 259 </td> 260 </tr> 261 262 <tr> 263 <td> 264 <pre> 265<a name="const_metadata_reference1108857465" id= 266"const_metadata_reference1108857465">const_metadata_reference</a> 267</pre> 268 </td> 269 270 <td> 271 <pre> 272<b>typename</b> Allocator::<b>template</b> rebind< 273 <a href= 274"#metadata_type2849297114"><tt>metadata_type</tt></a>>::other::<a href="#const_reference495461441"><tt>const_reference</tt></a> 275</pre> 276 </td> 277 278 <td> 279 <p>Const metadata <a href= 280 "#reference54418471"><tt>reference</tt></a> type.</p> 281 </td> 282 </tr> 283 </table> 284 285 <h2><a name="link6" id="link6">Public Methods</a></h2> 286 287 <h3><a name="link7" id="link7">Constructors, Destructor, and 288 Related</a></h3> 289 290 <table class="c1" width="100%" border="1" summary="Methods"> 291 <tr> 292 <td width="45%" align="left"><b>Method</b></td> 293 294 <td width="55%" align="left"><b>Description</b></td> 295 </tr> 296 297 <tr> 298 <td> 299 <pre> 300<b>inline</b> 301 const_node_iterator 302 () 303</pre> 304 </td> 305 306 <td> 307 <p>Default constructor.</p> 308 </td> 309 </tr> 310 </table> 311 312 <h3><a name="link8" id="link8">Access Methods</a></h3> 313 314 <table class="c1" width="100%" border="1" summary="Methods"> 315 <tr> 316 <td width="45%" align="left"><b>Method</b></td> 317 318 <td width="55%" align="left"><b>Description</b></td> 319 </tr> 320 321 <tr> 322 <td> 323 <pre> 324<b>inline</b> std::pair< 325 <a href= 326"#const_e_iterator2450008044"><tt>const_e_iterator</tt></a>, 327 <a href= 328"#const_e_iterator2450008044"><tt>const_e_iterator</tt></a>> 329 valid_prefix 330 () <b>const</b> 331</pre> 332 </td> 333 334 <td> 335 <p>Subtree valid prefix.</p> 336 337 <p>Returns the common prefix range of all nodes in this 338 node's subtree.</p> 339 </td> 340 </tr> 341 342 <tr> 343 <td> 344 <pre> 345<b>inline</b> <a href= 346"#const_reference495461441"><tt>const_reference</tt></a> 347 <b>operator</b>* 348 () <b>const</b> 349</pre> 350 </td> 351 352 <td> 353 <p>Const access; returns the const iterator associated 354 with the current leaf.</p> 355 356 <p>Should be called only for leaf nodes.</p> 357 </td> 358 </tr> 359 </table> 360 361 <h3><a name="link9" id="link9">Metadata Access Methods</a></h3> 362 363 <p>These are only defined if <a href= 364 "basic_tree.html#Node_Update841554648"><span class="c2"> 365 <tt>basic_tree</tt></span>::Node_Update</a> 366 is not <a href="null_trie_node_update.html"><span class= 367 "c2"><tt>null_trie_node_update</tt></span></a></p> 368 369 <table class="c1" width="100%" border="1" summary="Methods"> 370 <tr> 371 <td width="45%" align="left"><b>Method</b></td> 372 373 <td width="55%" align="left"><b>Description</b></td> 374 </tr> 375 376 <tr> 377 <td> 378 <pre> 379<b>inline</b> <a href= 380"#const_metadata_reference1108857465"><tt>const_metadata_reference</tt></a> 381 get_metadata 382 () <b>const</b> 383</pre> 384 </td> 385 386 <td> 387 <p>Metadata access.</p> 388 </td> 389 </tr> 390 </table> 391 392 <h3><a name="link10" id="link10">Movement Methods</a></h3> 393 394 <table class="c1" width="100%" border="1" summary="Methods"> 395 <tr> 396 <td width="45%" align="left"><b>Method</b></td> 397 398 <td width="55%" align="left"><b>Description</b></td> 399 </tr> 400 401 <tr> 402 <td> 403 <pre> 404<b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a> 405 num_children 406 () <b>const</b> 407</pre> 408 </td> 409 410 <td> 411 <p>Returns the number of children in the corresponding 412 node.</p> 413 414 <p>If the number of children is 0, then the corresponding 415 node is a leaf; otherwise, it is not a leaf.</p> 416 </td> 417 </tr> 418 419 <tr> 420 <td> 421 <pre> 422<span class="c2"><tt>const_node_iterator</tt></span> 423 get_child 424 (<a href= 425"#size_type55424436"><tt>size_type</tt></a> i) <b>const</b> 426</pre> 427 </td> 428 429 <td> 430 <p>Returns a const node iterator to the corresponding 431 node's <span class="c1"><tt>i</tt></span>-th child.</p> 432 </td> 433 </tr> 434 </table> 435 436 <h3><a name="link11" id="link11">Comparison Methods</a></h3> 437 438 <table class="c1" width="100%" border="1" summary="Methods"> 439 <tr> 440 <td width="45%" align="left"><b>Method</b></td> 441 442 <td width="55%" align="left"><b>Description</b></td> 443 </tr> 444 445 <tr> 446 <td> 447 <pre> 448<b>inline</b> <b>bool</b> 449 <b>operator</b>== 450 (<b>const</b> <span class= 451"c2"><tt>const_node_iterator</tt></span> &other) <b>const</b> 452</pre> 453 </td> 454 455 <td> 456 <p>Compares content to a different iterator object.</p> 457 </td> 458 </tr> 459 460 <tr> 461 <td> 462 <pre> 463<b>inline</b> <b>bool</b> 464 <b>operator</b>!= 465 (<b>const</b> <span class= 466"c2"><tt>const_node_iterator</tt></span> &other) <b>const</b> 467</pre> 468 </td> 469 470 <td> 471 <p>Compares content (negatively) to a different iterator 472 object.</p> 473 </td> 474 </tr> 475 </table> 476 </div> 477</body> 478</html> 479