libstdc++-v3/docs/html/ext/pb_ds/sample_trie_node_update.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_node_update 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_node_update</tt> Interface</h1>
  17
  18     <p>A sample node updater.</p>
  19
  20     <p>This class serves to show the interface a node update
  21     functor needs to support.</p>
  22
  23     <p>Defined in: <a href=
  24     "../../../../include/ext/pb_ds/detail/trie_policy/sample_trie_node_update.hpp"><tt>
  25     sample_trie_node_update.hpp</tt></a></p>
  26
  27     <h2><a name="link1" id="link1">Template Parameters</a></h2>
  28
  29     <table class="c1" width="100%" border="1" summary=
  30     "Template Parameters">
  31       <tr>
  32         <td width="20%" align="left"><b>Parameter</b></td>
  33
  34         <td width="50%" align="left"><b>Description</b></td>
  35
  36         <td width="30%" align="left"><b>Default Value</b></td>
  37       </tr>
  38
  39       <tr>
  40         <td>
  41           <pre>
  42 <a name="Const_Node_Iterator1933878761" id=
  43 "Const_Node_Iterator1933878761"><b>class</b> Const_Node_Iterator</a>
  44 </pre>
  45         </td>
  46
  47         <td>
  48           <p>Const node iterator type.</p>
  49         </td>
  50
  51         <td>-</td>
  52       </tr>
  53
  54       <tr>
  55         <td>
  56           <pre>
  57 <a name="Node_Iterator4206909839" id=
  58 "Node_Iterator4206909839"><b>class</b> Node_Iterator</a>
  59 </pre>
  60         </td>
  61
  62         <td>
  63           <p>Node iterator type.</p>
  64         </td>
  65
  66         <td>-</td>
  67       </tr>
  68
  69       <tr>
  70         <td>
  71           <pre>
  72 <a name="E_Access_Traits686553840" id=
  73 "E_Access_Traits686553840"><b>class</b> E_Access_Traits</a>
  74 </pre>
  75         </td>
  76
  77         <td>
  78           <p>Comparison functor.</p>
  79         </td>
  80
  81         <td>-</td>
  82       </tr>
  83
  84       <tr>
  85         <td>
  86           <pre>
  87 <a name="Allocator35940069" id=
  88 "Allocator35940069"><b>class</b> Allocator</a>
  89 </pre>
  90         </td>
  91
  92         <td>
  93           <p>Allocator type.</p>
  94         </td>
  95
  96         <td>-</td>
  97       </tr>
  98     </table>
  99
 100     <h2><a name="link2" id="link2">Public Types and
 101     Constants</a></h2>
 102
 103     <h3><a name="link3" id="link3">Metadata definitions.</a></h3>
 104
 105     <table class="c1" width="100%" border="1" summary="Types">
 106       <tr>
 107         <td width="30%" align="left"><b>Type</b></td>
 108
 109         <td width="55%" align="left"><b>Definition</b></td>
 110
 111         <td width="15%" align="left"><b>Description</b></td>
 112       </tr>
 113
 114       <tr>
 115         <td>
 116           <pre>
 117 <a name="metadata_type2849297114" id=
 118 "metadata_type2849297114">metadata_type</a>
 119 </pre>
 120         </td>
 121
 122         <td>
 123           <pre>
 124 size_t
 125 </pre>
 126         </td>
 127
 128         <td>
 129           <p>Metadata type.</p>
 130
 131           <p>This can be any type; size_t is merely an example.</p>
 132         </td>
 133       </tr>
 134     </table>
 135
 136     <h2><a name="link4" id="link4">Protected Methods</a></h2>
 137
 138     <h3><a name="link5" id="link5">Conclassors, declassor, and
 139     related.</a></h3>
 140
 141     <table class="c1" width="100%" border="1" summary="Methods">
 142       <tr>
 143         <td width="45%" align="left"><b>Method</b></td>
 144
 145         <td width="55%" align="left"><b>Description</b></td>
 146       </tr>
 147
 148       <tr>
 149         <td>
 150           <pre>
 151   sample_trie_node_update
 152   ()
 153 </pre>
 154         </td>
 155
 156         <td>
 157           <p>Default constructor.</p>
 158
 159           <p>Must be default constructable.</p>
 160         </td>
 161       </tr>
 162     </table>
 163
 164     <h3><a name="link6" id="link6">Operators.</a></h3>
 165
 166     <table class="c1" width="100%" border="1" summary="Methods">
 167       <tr>
 168         <td width="45%" align="left"><b>Method</b></td>
 169
 170         <td width="55%" align="left"><b>Description</b></td>
 171       </tr>
 172
 173       <tr>
 174         <td>
 175           <pre>
 176 <b>inline</b> <b>void</b>
 177   <b>operator</b>()
 178   (node_iterator node_it,
 179     const_node_iterator end_nd_it) <b>const</b>
 180 </pre>
 181         </td>
 182
 183         <td>
 184           <p>Updates the rank of a node through a <span class=
 185           "c1"><tt>node_iterator</tt></span> <span class=
 186           "c1"><tt>node_it</tt></span>; <span class=
 187           "c1"><tt>end_nd_it</tt></span> is the end node
 188           iterator.</p>
 189         </td>
 190       </tr>
 191     </table>
 192   </div>
 193 </body>
 194 </html>