old-autovect-branch/libstdc++-v3/docs/html/ext/pb_assoc/order_statistics_key_cmp.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>order_statistics_key_cmp Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>order_statistics_key_cmp
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>A comparison functor. Transforms any comparison functor operating on logical keys to a comparison functor operating on order statistics keys.
  23 </p>
  24
  25 <ol>
  26 <li>
  27 <a href = "../../../../include/ext/pb_assoc/order_statistics_key.hpp"><tt>order_statistics_key.hpp</tt>
  28 </a>
  29
  30 </li>
  31
  32 <li>
  33 <a href = "#link1">Template parameters.
  34 </a>
  35
  36 </li>
  37
  38 <li>
  39 <a href = "#link2">Base classes.
  40 </a>
  41
  42 </li>
  43
  44 <li>
  45 Public Types and Constants:
  46
  47
  48 <ol>
  49 <li>
  50 <a href = "#link3">Policy definitions.
  51 </a>
  52
  53 </li>
  54
  55 <li>
  56 <a href = "#link4">Key-type definitions.
  57 </a>
  58
  59 </li>
  60
  61 </ol>
  62
  63 </li>
  64
  65 <li>
  66 Public Methods:
  67
  68
  69 <ol>
  70 <li>
  71 <a href = "#link5">Constructors, destructor, and related.
  72 </a>
  73
  74 </li>
  75
  76 <li>
  77 <a href = "#link6">Operators.
  78 </a>
  79
  80 </li>
  81
  82 <li>
  83 <a href = "#link7">Policy access methods.
  84 </a>
  85
  86 </li>
  87
  88 </ol>
  89
  90 </li>
  91
  92 </ol>
  93
  94
  95 <h2>
  96 <a name = "link1">Template parameters.
  97 </a>
  98
  99 </h2>
 100
 101 <table WIDTH = "100%" BORDER = "1">
 102 <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>
 103
 104
 105 <tr>
 106 <td>
 107 <pre><a name = "Cmp_Fn3735929122">Cmp_Fn</a></pre>
 108
 109
 110 </td>
 111
 112 <td>
 113 <p>Comparison functor.</p>
 114
 115
 116 </td>
 117
 118 <td>
 119 <pre>std::less&lt;<a href = "#Key3735928856">Key</a>&gt;</pre>
 120
 121
 122 </td>
 123
 124 </tr>
 125
 126 <tr>
 127 <td>
 128 <pre><a name = "Allocator3735929488">Allocator</a></pre>
 129
 130
 131 </td>
 132
 133 <td>
 134 <p>Allocator type.</p>
 135
 136
 137 <p>The allocator is only used for definitions, e.g., size_type, pointer, and reference.</p>
 138
 139
 140 </td>
 141
 142 <td>
 143 <pre>std::allocator&lt;<b>char</b>&gt;</pre>
 144
 145
 146 </td>
 147
 148 </tr>
 149
 150 </table>
 151
 152 <h2>
 153 <a name = "link2">Base classes.
 154 </a>
 155
 156 </h2>
 157
 158 <table WIDTH = "100%" BORDER = "1">
 159 <TR><TD Width = "80%" ALIGN = "left"><b>Class</b></TD><TD Width = "20%" ALIGN = "left"><b>Derivation Type</b></TD></TR>
 160
 161
 162 <tr>
 163 <td>
 164 <pre>std::binary_function&lt;
 165   order_statistics_key&lt;
 166     <b>typename</b> <a href = "#Cmp_Fn3735929122">Cmp_Fn</a>::first_argument_type, <a href = "#Allocator3735929488">Allocator</a>&gt;,
 167   order_statistics_key&lt;
 168     <b>typename</b> <a href = "#Cmp_Fn3735929122">Cmp_Fn</a>::second_argument_type, <a href = "#Allocator3735929488">Allocator</a>&gt;,
 169   <b>bool</b>&gt;</pre>
 170
 171
 172 </td>
 173
 174 <td>
 175 <p>public</p>
 176
 177
 178 </td>
 179
 180 </tr>
 181
 182 </table>
 183
 184 <h2>
 185 <a name = "link3">Policy definitions.
 186 </a>
 187
 188 </h2>
 189
 190 <table WIDTH = "100%" BORDER = "1">
 191 <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>
 192
 193
 194 <tr>
 195 <td>
 196 <pre><a name = "allocator3735929520">allocator</a></pre>
 197
 198
 199 </td>
 200
 201 <td>
 202 <pre><a href = "#Allocator3735929488">Allocator</a></pre>
 203
 204
 205 </td>
 206
 207 <td>
 208 <p>Allocator type.</p>
 209
 210
 211 </td>
 212
 213 </tr>
 214
 215 <tr>
 216 <td>
 217 <pre><a name = "cmp_fn3735929186">cmp_fn</a></pre>
 218
 219
 220 </td>
 221
 222 <td>
 223 <pre><a href = "#Cmp_Fn3735929122">Cmp_Fn</a></pre>
 224
 225
 226 </td>
 227
 228 <td>
 229 <p>Comparison functor type.</p>
 230
 231
 232 </td>
 233
 234 </tr>
 235
 236 </table>
 237
 238 <h2>
 239 <a name = "link4">Key-type definitions.
 240 </a>
 241
 242 </h2>
 243
 244 <table WIDTH = "100%" BORDER = "1">
 245 <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>
 246
 247
 248 <tr>
 249 <td>
 250 <pre><a name = "key_type3735929433">key_type</a></pre>
 251
 252
 253 </td>
 254
 255 <td>
 256 <pre>order_statistics_key&lt;
 257     <b>typename</b> <a href = "#Cmp_Fn3735929122">Cmp_Fn</a>::first_argument_type, <a href = "#Allocator3735929488">Allocator</a>&gt;</pre>
 258
 259
 260 </td>
 261
 262 <td>
 263 <p>Key type.</p>
 264
 265
 266 </td>
 267
 268 </tr>
 269
 270 <tr>
 271 <td>
 272 <pre><a name = "const_key_reference3735929552">const_key_reference</a></pre>
 273
 274
 275 </td>
 276
 277 <td>
 278 <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::<b>template</b> rebind&lt;
 279     <a href = "#key_type3735929433">key_type</a>&gt;::other::const_reference</pre>
 280
 281
 282 </td>
 283
 284 <td>
 285 <p>Const key reference type.</p>
 286
 287
 288 </td>
 289
 290 </tr>
 291
 292 </table>
 293
 294 <h2>
 295 <a name = "link5">Constructors, destructor, and related.
 296 </a>
 297
 298 </h2>
 299
 300 <table WIDTH = "100%" BORDER = "1">
 301 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 302
 303
 304 <tr>
 305 <td>
 306 <pre><b>inline</b>
 307   order_statistics_key_cmp
 308   ()</pre>
 309
 310
 311 </td>
 312
 313 <td>
 314 <p>Default constructor.</p>
 315
 316
 317 </td>
 318
 319 </tr>
 320
 321 <tr>
 322 <td>
 323 <pre><b>inline</b>
 324   order_statistics_key_cmp
 325   (<b>const</b> <a href = "#Cmp_Fn3735929122">Cmp_Fn</a> &amp;r_cmp_fn)</pre>
 326
 327
 328 </td>
 329
 330 <td>
 331 <p>Constructor taking a comparison functor.</p>
 332
 333
 334 </td>
 335
 336 </tr>
 337
 338 </table>
 339
 340 <h2>
 341 <a name = "link6">Operators.
 342 </a>
 343
 344 </h2>
 345
 346 <table WIDTH = "100%" BORDER = "1">
 347 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 348
 349
 350 <tr>
 351 <td>
 352 <pre><b>inline</b> <b>bool</b>
 353   <b>operator</b>()
 354   (<a href = "#const_key_reference3735929552">const_key_reference</a> r_lhs_key,
 355     <a href = "#const_key_reference3735929552">const_key_reference</a> r_rhs_key) <b>const</b></pre>
 356
 357
 358 </td>
 359
 360 <td>
 361 <p>Compares two keys.</p>
 362
 363
 364 </td>
 365
 366 </tr>
 367
 368 </table>
 369
 370 <h2>
 371 <a name = "link7">Policy access methods.
 372 </a>
 373
 374 </h2>
 375
 376 <table WIDTH = "100%" BORDER = "1">
 377 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 378
 379
 380 <tr>
 381 <td>
 382 <pre><b>inline</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;
 383   get_cmp_fn
 384   ()</pre>
 385
 386
 387 </td>
 388
 389 <td>
 390 <p>Access to the comparison functor object used.</p>
 391
 392
 393 </td>
 394
 395 </tr>
 396
 397 <tr>
 398 <td>
 399 <pre><b>inline</b> <b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &amp;
 400   get_cmp_fn
 401   () <b>const</b></pre>
 402
 403
 404 </td>
 405
 406 <td>
 407 <p>Const access to the comparison functor object used.</p>
 408
 409
 410 </td>
 411
 412 </tr>
 413
 414 </table>
 415
 416
 417
 418 </body>
 419
 420 </html>
 421
 422