libstdc++-v3/docs/html/ext/pb_ds/counter_lu_policy.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>counter_lu_policy 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>counter_lu_policy</tt> Interface</h1>
  17
  18     <p>A list-update policy that moves elements to the front of the
  19     list based on the counter algorithm.</p>
  20
  21     <p>Defined in: <a href=
  22     "../../../../include/ext/pb_ds/list_update_policy.hpp"><tt>list_update_policy.hpp</tt></a></p>
  23
  24     <h2><a name="link1" id="link1">Template Parameters</a></h2>
  25
  26     <table class="c1" width="100%" border="1" summary=
  27     "Template Parameters">
  28       <tr>
  29         <td width="20%" align="left"><b>Parameter</b></td>
  30
  31         <td width="50%" align="left"><b>Description</b></td>
  32
  33         <td width="30%" align="left"><b>Default Value</b></td>
  34       </tr>
  35
  36       <tr>
  37         <td>
  38           <pre>
  39 <a name="Max_Count39887466" id=
  40 "Max_Count39887466">size_t Max_Count </a>
  41 </pre>
  42         </td>
  43
  44         <td>
  45           <p>Maximum count.</p>
  46
  47           <p>When some element is accessed this number of times, it
  48           will be moved to the front of the list.</p>
  49         </td>
  50
  51         <td>5</td>
  52       </tr>
  53
  54       <tr>
  55         <td>
  56           <pre>
  57 <a name="Allocator35940069" id=
  58 "Allocator35940069"><b>class</b> Allocator </a>
  59 </pre>
  60         </td>
  61
  62         <td>
  63           <p>Allocator type.</p>
  64
  65           <p>This is used only for definitions, e.g., the size
  66           type.</p>
  67         </td>
  68
  69         <td>
  70           <pre>
  71 std::allocator&lt;<b>char</b>&gt;
  72 </pre>
  73         </td>
  74       </tr>
  75     </table>
  76
  77     <h2><a name="link2" id="link2">Public Types and
  78     Constants</a></h2>
  79
  80     <h3><a name="link3" id="link3">Policy Definitions</a></h3>
  81
  82     <table class="c1" width="100%" border="1" summary="Types">
  83       <tr>
  84         <td width="30%" align="left"><b>Type</b></td>
  85
  86         <td width="55%" align="left"><b>Definition</b></td>
  87
  88         <td width="15%" align="left"><b>Description</b></td>
  89       </tr>
  90
  91       <tr>
  92         <td>
  93           <pre>
  94 <a name="allocator48440069" id="allocator48440069">allocator</a>
  95 </pre>
  96         </td>
  97
  98         <td>
  99           <pre>
 100 <a href="#Allocator35940069"><tt>Allocator</tt></a>
 101 </pre>
 102         </td>
 103
 104         <td>
 105           <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
 106           type.</p>
 107         </td>
 108       </tr>
 109
 110       <tr>
 111         <td>
 112           <pre>
 113 <a name="max_count52407466" id="max_count52407466">max_count</a>
 114 </pre>
 115         </td>
 116
 117         <td>
 118           <pre>
 119 <a href="#Max_Count39887466"><tt>Max_Count</tt></a>
 120 }
 121 </pre>
 122         </td>
 123
 124         <td>
 125           <p>Maximum count.</p>
 126         </td>
 127       </tr>
 128     </table>
 129
 130     <h3><a name="link4" id="link4">General Definitions</a></h3>
 131
 132     <table class="c1" width="100%" border="1" summary="Types">
 133       <tr>
 134         <td width="30%" align="left"><b>Type</b></td>
 135
 136         <td width="55%" align="left"><b>Definition</b></td>
 137
 138         <td width="15%" align="left"><b>Description</b></td>
 139       </tr>
 140
 141       <tr>
 142         <td>
 143           <pre>
 144 <a name="size_type55424436" id="size_type55424436">size_type</a>
 145 </pre>
 146         </td>
 147
 148         <td>
 149           <pre>
 150 <b>typename</b> <a href=
 151 "#allocator48440069"><tt>allocator</tt></a>::size_type
 152 </pre>
 153         </td>
 154
 155         <td>
 156           <p>Size type.</p>
 157         </td>
 158       </tr>
 159     </table>
 160
 161     <h3><a name="link5" id="link5">Metadata-Type
 162     Definitions</a></h3>
 163
 164     <table class="c1" width="100%" border="1" summary="Types">
 165       <tr>
 166         <td width="30%" align="left"><b>Type</b></td>
 167
 168         <td width="55%" align="left"><b>Definition</b></td>
 169
 170         <td width="15%" align="left"><b>Description</b></td>
 171       </tr>
 172
 173       <tr>
 174         <td>
 175           <pre>
 176 <a name="metadata_type2849297114" id=
 177 "metadata_type2849297114">metadata_type</a>
 178 </pre>
 179         </td>
 180
 181         <td>
 182           <pre>
 183 Some class containing a counter.
 184 </pre>
 185         </td>
 186
 187         <td>
 188           <p>Metadata on which this functor operates.</p>
 189         </td>
 190       </tr>
 191
 192       <tr>
 193         <td>
 194           <pre>
 195 <a name="metadata_reference583863863" id=
 196 "metadata_reference583863863">metadata_reference</a>
 197 </pre>
 198         </td>
 199
 200         <td>
 201           <pre>
 202 <b>typename</b> <a href=
 203 "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
 204     <a href=
 205 "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::reference
 206 </pre>
 207         </td>
 208
 209         <td>
 210           <p>Reference to metadata on which this functor
 211           operates.</p>
 212         </td>
 213       </tr>
 214     </table>
 215
 216     <h2><a name="link6" id="link6">Public Methods</a></h2>
 217
 218     <h3><a name="link7" id="link7">Metadata Methods</a></h3>
 219
 220     <table class="c1" width="100%" border="1" summary="Methods">
 221       <tr>
 222         <td width="45%" align="left"><b>Method</b></td>
 223
 224         <td width="55%" align="left"><b>Description</b></td>
 225       </tr>
 226
 227       <tr>
 228         <td>
 229           <pre>
 230 <a href="#metadata_type2849297114"><tt>metadata_type</tt></a>
 231   <b>operator</b>()
 232   () <b>const</b>
 233 </pre>
 234         </td>
 235
 236         <td>
 237           <p>Creates a metadata object.</p>
 238         </td>
 239       </tr>
 240
 241       <tr>
 242         <td>
 243           <pre>
 244 <b>bool</b>
 245   <b>operator</b>()
 246   (<a href=
 247 "#metadata_reference583863863"><tt>metadata_reference</tt></a> r_metadata) <b>const</b>
 248 </pre>
 249         </td>
 250
 251         <td>
 252           <p>Decides whether a metadata object should be moved to
 253           the front of the list.</p>
 254         </td>
 255       </tr>
 256     </table>
 257   </div>
 258 </body>
 259 </html>