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

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>order_by_key Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>order_by_key
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>Finds an order corresponding to an entry within the sequence.
  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 Public Types and Constants:
  40
  41
  42 <ol>
  43 <li>
  44 <a href = "#link2">Key-type definitions.
  45 </a>
  46
  47 </li>
  48
  49 <li>
  50 <a href = "#link3">Container definitions.
  51 </a>
  52
  53 </li>
  54
  55 </ol>
  56
  57 </li>
  58
  59 <li>
  60 Public Methods:
  61
  62
  63 <ol>
  64 <li>
  65 <a href = "#link4">Operators.
  66 </a>
  67
  68 </li>
  69
  70 </ol>
  71
  72 </li>
  73
  74 </ol>
  75
  76
  77 <h2>
  78 <a name = "link1">Template parameters.
  79 </a>
  80
  81 </h2>
  82
  83 <table WIDTH = "100%" BORDER = "1">
  84 <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>
  85
  86
  87 <tr>
  88 <td>
  89 <pre><a name = "Cntnr3735929076">Cntnr</a></pre>
  90
  91
  92 </td>
  93
  94 <td>
  95 <p>Container type.</p>
  96
  97
  98 </td>
  99
 100 <td>
 101 -
 102
 103
 104 </td>
 105
 106 </tr>
 107
 108 </table>
 109
 110 <h2>
 111 <a name = "link2">Key-type definitions.
 112 </a>
 113
 114 </h2>
 115
 116 <table WIDTH = "100%" BORDER = "1">
 117 <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>
 118
 119
 120 <tr>
 121 <td>
 122 <pre><a name = "order_statistics_key_type3735929828">order_statistics_key_type</a></pre>
 123
 124
 125 </td>
 126
 127 <td>
 128 <pre><b>typename</b> <a href = "#Cntnr3735929076">Cntnr</a>::key_type</pre>
 129
 130
 131 </td>
 132
 133 <td>
 134 <p>Order-statistics key type.</p>
 135
 136
 137 </td>
 138
 139 </tr>
 140
 141 <tr>
 142 <td>
 143 <pre><a name = "underlying_key_type3735929533">underlying_key_type</a></pre>
 144
 145
 146 </td>
 147
 148 <td>
 149 <pre><b>typename</b> <a href = "#order_statistics_key_type3735929828">order_statistics_key_type</a>::key_type</pre>
 150
 151
 152 </td>
 153
 154 <td>
 155 <p>Underlying key type.</p>
 156
 157
 158 </td>
 159
 160 </tr>
 161
 162 </table>
 163
 164 <h2>
 165 <a name = "link3">Container definitions.
 166 </a>
 167
 168 </h2>
 169
 170 <table WIDTH = "100%" BORDER = "1">
 171 <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>
 172
 173
 174 <tr>
 175 <td>
 176 <pre><a name = "cntnr3735929108">cntnr</a></pre>
 177
 178
 179 </td>
 180
 181 <td>
 182 <pre><a href = "#Cntnr3735929076">Cntnr</a></pre>
 183
 184
 185 </td>
 186
 187 <td>
 188 <p>Container type.</p>
 189
 190
 191 </td>
 192
 193 </tr>
 194
 195 <tr>
 196 <td>
 197 <pre><a name = "size_type3735929547">size_type</a></pre>
 198
 199
 200 </td>
 201
 202 <td>
 203 <pre><b>typename</b> <a href = "#cntnr3735929108">cntnr</a>::size_type</pre>
 204
 205
 206 </td>
 207
 208 <td>
 209 <p>Container's size type.</p>
 210
 211
 212 </td>
 213
 214 </tr>
 215
 216 </table>
 217
 218 <h2>
 219 <a name = "link4">Operators.
 220 </a>
 221
 222 </h2>
 223
 224 <table WIDTH = "100%" BORDER = "1">
 225 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 226
 227
 228 <tr>
 229 <td>
 230 <pre><b>inline</b> <a href = "#size_type3735929547">size_type</a>
 231   <b>operator</b>()
 232   (<b>const</b> <a href = "#Cntnr3735929076">Cntnr</a> &amp;r_c,
 233     <b>const</b> <a href = "#underlying_key_type3735929533">underlying_key_type</a> &amp;r_key) <b>const</b></pre>
 234
 235
 236 </td>
 237
 238 <td>
 239 <p>Returns the order of a key within a sequence. For exapmle, if <font color = "#666666"><tt>r_key</tt></font> is the smallest key in <font color = "#666666"><tt>r_c</tt></font>, this method will return 0; if <font color = "#666666"><tt>r_key</tt></font> is a key between the smallest and next key in <font color = "#666666"><tt>r_c</tt></font>, this method will return 1; if <font color = "#666666"><tt>r_key</tt></font> is a key larger than the largest key in <font color = "#666666"><tt>r_c</tt></font>, this method will return the size of <font color = "#666666"><tt>r_c</tt></font>.</p>
 240
 241
 242 </td>
 243
 244 </tr>
 245
 246 </table>
 247
 248
 249
 250 </body>
 251
 252 </html>
 253
 254