libstdc++-v3/doc/html/ext/pb_ds/sample_trie_e_access_traits.html

   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>sample_trie_e_access_traits 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>sample_trie_e_access_traits</tt> Interface</h1>
  17
  18     <p>A sample trie element-access traits.</p>
  19
  20     <p>This class serves to show the interface an element- access
  21     traits class needs to support.</p>
  22
  23     <p>Defined in: <a href=
  24     "../../../../include/ext/pb_ds/detail/trie_policy/sample_trie_e_access_traits.hpp">
  25     <tt>sample_trie_e_access_traits.hpp</tt></a></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 definitions.</a></h3>
  31
  32     <table class="c1" width="100%" border="1" summary="Types">
  33       <tr>
  34         <td width="30%" align="left"><b>Type</b></td>
  35
  36         <td width="55%" align="left"><b>Definition</b></td>
  37
  38         <td width="15%" align="left"><b>Description</b></td>
  39       </tr>
  40
  41       <tr>
  42         <td>
  43           <pre>
  44 <a name="size_type55424436" id="size_type55424436">size_type</a>
  45 </pre>
  46         </td>
  47
  48         <td>
  49           <pre>
  50 size_t, e.g.
  51 </pre>
  52         </td>
  53
  54         <td>
  55           <p>Size type.</p>
  56         </td>
  57       </tr>
  58
  59       <tr>
  60         <td>
  61           <pre>
  62 <a name="key_type10393186" id="key_type10393186">key_type</a>
  63 </pre>
  64         </td>
  65
  66         <td>
  67           <pre>
  68 std::string, e.g.
  69 </pre>
  70         </td>
  71
  72         <td>
  73           <p>Key type.</p>
  74         </td>
  75       </tr>
  76
  77       <tr>
  78         <td>
  79           <pre>
  80 <a name="const_key_reference3185471705" id=
  81 "const_key_reference3185471705">const_key_reference</a>
  82 </pre>
  83         </td>
  84
  85         <td>
  86           <pre>
  87 const string &amp;, e.g.
  88 </pre>
  89         </td>
  90
  91         <td>
  92           <p>Const key reference type.</p>
  93         </td>
  94       </tr>
  95     </table>
  96
  97     <h3><a name="link3" id="link3">Element definitions.</a></h3>
  98
  99     <table class="c1" width="100%" border="1" summary="Types">
 100       <tr>
 101         <td width="30%" align="left"><b>Type</b></td>
 102
 103         <td width="55%" align="left"><b>Definition</b></td>
 104
 105         <td width="15%" align="left"><b>Description</b></td>
 106       </tr>
 107
 108       <tr>
 109         <td>
 110           <pre>
 111 <a name="const_iterator98626788" id=
 112 "const_iterator98626788">const_iterator</a>
 113 </pre>
 114         </td>
 115
 116         <td>
 117           <pre>
 118 string::const_iterator, e.g.
 119 </pre>
 120         </td>
 121
 122         <td>
 123           <p>Element <tt><b>const</b></tt> iterator type.</p>
 124         </td>
 125       </tr>
 126
 127       <tr>
 128         <td>
 129           <pre>
 130 <a name="e_type393186" id="e_type393186">e_type</a>
 131 </pre>
 132         </td>
 133
 134         <td>
 135           <pre>
 136 char, e.g.
 137 </pre>
 138         </td>
 139
 140         <td>
 141           <p>Element type.</p>
 142         </td>
 143       </tr>
 144
 145       <tr>
 146         <td>
 147           <pre>
 148 <a name="max_size10483336" id="max_size10483336">max_size</a>
 149 </pre>
 150         </td>
 151
 152         <td>
 153           <pre>
 154 4, e.g.
 155 </pre>
 156         </td>
 157
 158         <td>
 159           <p>Number of distinct elements.</p>
 160         </td>
 161       </tr>
 162     </table>
 163
 164     <h2><a name="link4" id="link4">Public Methods</a></h2>
 165
 166     <h3><a name="link5" id="link5">Access methods.</a></h3>
 167
 168     <table class="c1" width="100%" border="1" summary="Methods">
 169       <tr>
 170         <td width="45%" align="left"><b>Method</b></td>
 171
 172         <td width="55%" align="left"><b>Description</b></td>
 173       </tr>
 174
 175       <tr>
 176         <td>
 177           <pre>
 178 <b>inline</b> <b>static</b> <a href=
 179 "#const_iterator98626788"><tt>const_iterator</tt></a>
 180   begin
 181   (<a href=
 182 "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key)
 183 </pre>
 184         </td>
 185
 186         <td>
 187           <p>Returns a <a href=
 188           "#const_iterator98626788"><tt>const_iterator</tt></a> to
 189           the first element of <span class=
 190           "c1"><tt>r_key</tt></span>.</p>
 191         </td>
 192       </tr>
 193
 194       <tr>
 195         <td>
 196           <pre>
 197 <b>inline</b> <b>static</b> <a href=
 198 "#const_iterator98626788"><tt>const_iterator</tt></a>
 199   end
 200   (<a href=
 201 "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key)
 202 </pre>
 203         </td>
 204
 205         <td>
 206           <p>Returns a <a href=
 207           "#const_iterator98626788"><tt>const_iterator</tt></a> to
 208           the after-last element of <span class=
 209           "c1"><tt>r_key</tt></span>.</p>
 210         </td>
 211       </tr>
 212
 213       <tr>
 214         <td>
 215           <pre>
 216 <b>inline</b> <b>static</b> <a href=
 217 "#size_type55424436"><tt>size_type</tt></a>
 218   e_pos
 219   (<a href="#e_type393186"><tt>e_type</tt></a> e)
 220 </pre>
 221         </td>
 222
 223         <td>
 224           <p>Maps an <span class="c1"><tt>element</tt></span> to a
 225           position.</p>
 226         </td>
 227       </tr>
 228     </table>
 229   </div>
 230 </body>
 231 </html>