gomp-20050608-branch/libstdc++-v3/docs/html/ext/pb_assoc/counter_update_policy.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>counter_update_policy Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>counter_update_policy
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>A list-update policy that moves elements to the front of the list based on the counter algorithm.
  23 </p>
  24
  25 <p>This class is likely to slightly change interface when random number generators become part of the C++ standard.
  26 </p>
  27
  28 <ol>
  29 <li>
  30 <a href = "../../../../include/ext/pb_assoc/counter_update_policy.hpp"><tt>counter_update_policy.hpp</tt>
  31 </a>
  32
  33 </li>
  34
  35 <li>
  36 <a href = "#link1">Template parameters.
  37 </a>
  38
  39 </li>
  40
  41 <li>
  42 Public Types and Constants:
  43
  44
  45 <ol>
  46 <li>
  47 <a href = "#link2">Size definitions.
  48 </a>
  49
  50 </li>
  51
  52 </ol>
  53
  54 </li>
  55
  56 <li>
  57 Public Methods:
  58
  59
  60 <ol>
  61 <li>
  62 <a href = "#link3">Constructors, destructor, and related.
  63 </a>
  64
  65 </li>
  66
  67 <li>
  68 <a href = "#link4">Information methods.
  69 </a>
  70
  71 </li>
  72
  73 </ol>
  74
  75 </li>
  76
  77 <li>
  78 Protected Types and Constants:
  79
  80
  81 <ol>
  82 <li>
  83 <a href = "#link5">Metadata definitions.
  84 </a>
  85
  86 </li>
  87
  88 </ol>
  89
  90 </li>
  91
  92 <li>
  93 Protected Methods:
  94
  95
  96 <ol>
  97 <li>
  98 <a href = "#link6">Metadata operations.
  99 </a>
 100
 101 </li>
 102
 103 </ol>
 104
 105 </li>
 106
 107 </ol>
 108
 109
 110 <h2>
 111 <a name = "link1">Template parameters.
 112 </a>
 113
 114 </h2>
 115
 116 <table WIDTH = "100%" BORDER = "1">
 117 <TR><TD Width = "20%" ALIGN = "left"><b>Parameter</b></TD><TD Width = "50%" ALIGN = "left"><b>Description</b></TD><TD Width = "30%" ALIGN = "left"><b>Default Value</b></TD></TR>
 118
 119
 120 <tr>
 121 <td>
 122 <pre><a name = "Size_Type3735929483">Size_Type</a></pre>
 123
 124
 125 </td>
 126
 127 <td>
 128 <p>Size type.</p>
 129
 130
 131 </td>
 132
 133 <td>
 134 size_t
 135
 136
 137 </td>
 138
 139 </tr>
 140
 141 <tr>
 142 <td>
 143 <pre><a name = "Metadata_Reference3735929465">Metadata_Reference</a></pre>
 144
 145
 146 </td>
 147
 148 <td>
 149 <p>Metadata reference type.</p>
 150
 151
 152 </td>
 153
 154 <td>
 155 <pre>std::allocator&lt;
 156   <a href = "counter_update_metadata.html"><tt>counter_update_metadata</tt></a>&gt;::
 157     reference
 158
 159
 160 </td>
 161
 162 </tr>
 163
 164 </table>
 165
 166 <h2>
 167 <a name = "link2">Size definitions.
 168 </a>
 169
 170 </h2>
 171
 172 <table WIDTH = "100%" BORDER = "1">
 173 <TR><TD Width = "30%" ALIGN = "left"><b>Type</b></TD><TD Width = "55%" ALIGN = "left"><b>Definition</b></TD><TD Width = "15%" ALIGN = "left"><b>Description</b></TD></TR>
 174
 175
 176 <tr>
 177 <td>
 178 <pre><a name = "size_type3735929547">size_type</a></pre>
 179
 180
 181 </td>
 182
 183 <td>
 184 <pre><a href = "#Size_Type3735929483">Size_Type</a></pre>
 185
 186
 187 </td>
 188
 189 <td>
 190 <p>Size type used for counting the number of times each node is accessed until the count is reset to 0 and the node moved to the front of the list.</p>
 191
 192
 193 </td>
 194
 195 </tr>
 196
 197 </table>
 198
 199 <h2>
 200 <a name = "link3">Constructors, destructor, and related.
 201 </a>
 202
 203 </h2>
 204
 205 <table WIDTH = "100%" BORDER = "1">
 206 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 207
 208
 209 <tr>
 210 <td>
 211 <pre>  counter_update_policy
 212   (<a href = "#size_type3735929547">size_type</a> max_count = 5)</pre>
 213
 214
 215 </td>
 216
 217 <td>
 218 <p>Constructor. <font color = "#666666"><tt>max_count</tt></font> determines the the number of times each node is accessed until the count is reset to 0 and the node moved to the front of the list.</p>
 219
 220
 221 </td>
 222
 223 </tr>
 224
 225 <tr>
 226 <td>
 227 <pre><b>void</b>
 228   swap
 229   (<font color = "olive">counter_update_policy</font> &amp;r_other)</pre>
 230
 231
 232 </td>
 233
 234 <td>
 235 <p>Swaps content.</p>
 236
 237
 238 </td>
 239
 240 </tr>
 241
 242 </table>
 243
 244 <h2>
 245 <a name = "link4">Information methods.
 246 </a>
 247
 248 </h2>
 249
 250 <table WIDTH = "100%" BORDER = "1">
 251 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 252
 253
 254 <tr>
 255 <td>
 256 <pre><b>inline</b>
 257   <a href = "#size_type3735929547">size_type</a>
 258   get_max_count
 259   () <b>const</b></pre>
 260
 261
 262 </td>
 263
 264 <td>
 265 <p>Returns the max count of each metadata (number of times it is accessed until moved to the front of the list).</p>
 266
 267
 268 </td>
 269
 270 </tr>
 271
 272 </table>
 273
 274 <h2>
 275 <a name = "link5">Metadata definitions.
 276 </a>
 277
 278 </h2>
 279
 280 <table WIDTH = "100%" BORDER = "1">
 281 <TR><TD Width = "30%" ALIGN = "left"><b>Type</b></TD><TD Width = "55%" ALIGN = "left"><b>Definition</b></TD><TD Width = "15%" ALIGN = "left"><b>Description</b></TD></TR>
 282
 283
 284 <tr>
 285 <td>
 286 <pre><a name = "metadata_type3735929937">metadata_type</a></pre>
 287
 288
 289 </td>
 290
 291 <td>
 292 <pre><a href = "counter_update_metadata.html"><tt>counter_update_metadata</tt></a></pre>
 293
 294
 295 </td>
 296
 297 <td>
 298 <p>Metadata on which this functor operates.</p>
 299
 300
 301 </td>
 302
 303 </tr>
 304
 305 <tr>
 306 <td>
 307 <pre><a name = "metadata_reference3735929497">metadata_reference</a></pre>
 308
 309
 310 </td>
 311
 312 <td>
 313 <pre><a href = "#Metadata_Reference3735929465">Metadata_Reference</a></pre>
 314
 315
 316 </td>
 317
 318 <td>
 319 <p>Reference to metadata on which this functor operates.</p>
 320
 321
 322 </td>
 323
 324 </tr>
 325
 326 </table>
 327
 328 <h2>
 329 <a name = "link6">Metadata operations.
 330 </a>
 331
 332 </h2>
 333
 334 <table WIDTH = "100%" BORDER = "1">
 335 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 336
 337
 338 <tr>
 339 <td>
 340 <pre><a href = "#metadata_type3735929937">metadata_type</a>
 341   <b>operator</b>()
 342   () <b>const</b></pre>
 343
 344
 345 </td>
 346
 347 <td>
 348 <p>Creates a metadata object.</p>
 349
 350
 351 </td>
 352
 353 </tr>
 354
 355 <tr>
 356 <td>
 357 <pre><b>bool</b>
 358   <b>operator</b>()
 359   (<a href = "#metadata_reference3735929497">metadata_reference</a> r_data) <b>const</b></pre>
 360
 361
 362 </td>
 363
 364 <td>
 365 <p>Decides whether a metadata object should be moved to the front of the list.</p>
 366
 367
 368 </td>
 369
 370 </tr>
 371
 372 </table>
 373
 374
 375
 376 </body>
 377
 378 </html>
 379
 380