libstdc++-v3/docs/html/ext/pb_ds/sample_tree_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_tree_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_tree_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/tree_policy/sample_tree_node_update.hpp"><tt>
  25     sample_tree_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="Cmp_Fn294335" id="Cmp_Fn294335"><b>class</b> Cmp_Fn</a>
  73 </pre>
  74         </td>
  75
  76         <td>
  77           <p>Comparison functor.</p>
  78         </td>
  79
  80         <td>-</td>
  81       </tr>
  82
  83       <tr>
  84         <td>
  85           <pre>
  86 <a name="Allocator35940069" id=
  87 "Allocator35940069"><b>class</b> Allocator</a>
  88 </pre>
  89         </td>
  90
  91         <td>
  92           <p>Allocator type.</p>
  93         </td>
  94
  95         <td>-</td>
  96       </tr>
  97     </table>
  98
  99     <h2><a name="link2" id="link2">Public Types and
 100     Constants</a></h2>
 101
 102     <h3><a name="link3" id="link3">Metadata definitions.</a></h3>
 103
 104     <table class="c1" width="100%" border="1" summary="Types">
 105       <tr>
 106         <td width="30%" align="left"><b>Type</b></td>
 107
 108         <td width="55%" align="left"><b>Definition</b></td>
 109
 110         <td width="15%" align="left"><b>Description</b></td>
 111       </tr>
 112
 113       <tr>
 114         <td>
 115           <pre>
 116 <a name="metadata_type2849297114" id=
 117 "metadata_type2849297114">metadata_type</a>
 118 </pre>
 119         </td>
 120
 121         <td>
 122           <pre>
 123 size_t
 124 </pre>
 125         </td>
 126
 127         <td>
 128           <p>Metadata type.</p>
 129
 130           <p>This can be any type; size_t is merely an example.</p>
 131         </td>
 132       </tr>
 133     </table>
 134
 135     <h2><a name="link4" id="link4">Protected Methods</a></h2>
 136
 137     <h3><a name="link5" id="link5">Conclassors, declassor, and
 138     related.</a></h3>
 139
 140     <table class="c1" width="100%" border="1" summary="Methods">
 141       <tr>
 142         <td width="45%" align="left"><b>Method</b></td>
 143
 144         <td width="55%" align="left"><b>Description</b></td>
 145       </tr>
 146
 147       <tr>
 148         <td>
 149           <pre>
 150   sample_tree_node_update
 151   ()
 152 </pre>
 153         </td>
 154
 155         <td>
 156           <p>Default constructor.</p>
 157
 158           <p>Must be default constructable.</p>
 159         </td>
 160       </tr>
 161     </table>
 162
 163     <h3><a name="link6" id="link6">Operators.</a></h3>
 164
 165     <table class="c1" width="100%" border="1" summary="Methods">
 166       <tr>
 167         <td width="45%" align="left"><b>Method</b></td>
 168
 169         <td width="55%" align="left"><b>Description</b></td>
 170       </tr>
 171
 172       <tr>
 173         <td>
 174           <pre>
 175 <b>inline</b> <b>void</b>
 176   <b>operator</b>()
 177   (node_iterator node_it,
 178     const_node_iterator end_nd_it) <b>const</b>
 179 </pre>
 180         </td>
 181
 182         <td>
 183           <p>Updates the rank of a node through a <span class=
 184           "c1"><tt>node_iterator</tt></span> <span class=
 185           "c1"><tt>node_it</tt></span>; <span class=
 186           "c1"><tt>end_nd_it</tt></span> is the end node
 187           iterator.</p>
 188         </td>
 189       </tr>
 190     </table>
 191   </div>
 192 </body>
 193 </html>