libstdc++-v3/docs/html/ext/pb_assoc/sample_probe_fn.html

   1
   2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3
   4
   5 <html>
   6 <head>
   7 <title>sample_probe_fn Interface
   8 </title>
   9
  10 </head>
  11
  12 <body>
  13 <h1>
  14 <tt>sample_probe_fn
  15 </tt>
  16
  17  Interface
  18
  19
  20 </h1>
  21
  22 <p>A sample probe policy.
  23 </p>
  24
  25 <p>This class serves to show the interface a probe functor needs to support.
  26 </p>
  27
  28 <ol>
  29 <li>
  30 <a href = "../doc/sample_probe_fn.hpp"><tt>sample_probe_fn.hpp</tt>
  31 </a>
  32
  33 </li>
  34
  35 <li>
  36 Public Methods:
  37
  38
  39 <ol>
  40 <li>
  41 <a href = "#link1">Constructors, destructor, and related.
  42 </a>
  43
  44 </li>
  45
  46 </ol>
  47
  48 </li>
  49
  50 <li>
  51 Protected Methods:
  52
  53
  54 <ol>
  55 <li>
  56 <a href = "#link2">Offset methods.
  57 </a>
  58
  59 </li>
  60
  61 </ol>
  62
  63 </li>
  64
  65 </ol>
  66
  67
  68 <h2>
  69 <a name = "link1">Constructors, destructor, and related.
  70 </a>
  71
  72 </h2>
  73
  74 <table WIDTH = "100%" BORDER = "1">
  75 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
  76
  77
  78 <tr>
  79 <td>
  80 <pre>  sample_probe_fn
  81   ()</pre>
  82
  83
  84 </td>
  85
  86 <td>
  87 <p>Default constructor.</p>
  88
  89
  90 <p>Must be default constructible.</p>
  91
  92
  93 </td>
  94
  95 </tr>
  96
  97 <tr>
  98 <td>
  99 <pre>  sample_probe_fn
 100   (<b>const</b> sample_probe_fn &amp;r_other)</pre>
 101
 102
 103 </td>
 104
 105 <td>
 106 <p>Copy constructor.</p>
 107
 108
 109 <p>Must be copy constructible.</p>
 110
 111
 112 </td>
 113
 114 </tr>
 115
 116 <tr>
 117 <td>
 118 <pre><b>inline</b> <b>void</b>
 119   swap
 120   (sample_probe_fn &amp;r_other)</pre>
 121
 122
 123 </td>
 124
 125 <td>
 126 <p>Swaps content.</p>
 127
 128
 129 <p>Must be swappable (if there is such a word).</p>
 130
 131
 132 </td>
 133
 134 </tr>
 135
 136 </table>
 137
 138 <h2>
 139 <a name = "link2">Offset methods.
 140 </a>
 141
 142 </h2>
 143
 144 <table WIDTH = "100%" BORDER = "1">
 145 <TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
 146
 147
 148 <tr>
 149 <td>
 150 <pre><b>inline</b> size_type
 151   <b>operator</b>()
 152   (const_key_reference r_key,
 153     size_type i) <b>const</b></pre>
 154
 155
 156 </td>
 157
 158 <td>
 159 <p>Returns the <font color = "#666666"><tt>i</tt></font>-th offset from the hash value of some key <font color = "#666666"><tt>r_key</tt></font>.</p>
 160
 161
 162 <p><p><tt>size_type</tt> is the size type on which the functor operates.</p></p>
 163
 164
 165 </td>
 166
 167 </tr>
 168
 169 </table>
 170
 171
 172
 173 </body>
 174
 175 </html>
 176
 177