libstdc++-v3/docs/html/ext/pb_ds/sample_ranged_hash_fn.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>sample_ranged_hash_fn 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>sample_ranged_hash_fn</tt> Interface</h1>
  17
  18     <p>A sample ranged-hash functor.</p>
  19
  20     <p>This class serves to show the interface a ranged-hash
  21     functor needs to support.</p>
  22
  23     <p>Defined in: <a href=
  24     "../../../../include/ext/pb_ds/detail/hash_fn/sample_ranged_hash_fn.hpp"><tt>sample_ranged_hash_fn.hpp</tt></a></p>
  25
  26     <h2><a name="link1" id="link1">Public Types and
  27     Constants</a></h2>
  28
  29     <h3><a name="link2" id="link2">General definitions.</a></h3>
  30
  31     <table class="c1" width="100%" border="1" summary="Types">
  32       <tr>
  33         <td width="30%" align="left"><b>Type</b></td>
  34
  35         <td width="55%" align="left"><b>Definition</b></td>
  36
  37         <td width="15%" align="left"><b>Description</b></td>
  38       </tr>
  39
  40       <tr>
  41         <td>
  42           <pre>
  43 <a name="size_type55424436" id="size_type55424436">size_type</a>
  44 </pre>
  45         </td>
  46
  47         <td>
  48           <pre>
  49 size_t, e.g.
  50 </pre>
  51         </td>
  52
  53         <td>
  54           <p>Size type.</p>
  55         </td>
  56       </tr>
  57     </table>
  58
  59     <h2><a name="link3" id="link3">Public Methods</a></h2>
  60
  61     <h3><a name="link4" id="link4">Constructors, destructor, and
  62     related.</a></h3>
  63
  64     <table class="c1" width="100%" border="1" summary="Methods">
  65       <tr>
  66         <td width="45%" align="left"><b>Method</b></td>
  67
  68         <td width="55%" align="left"><b>Description</b></td>
  69       </tr>
  70
  71       <tr>
  72         <td>
  73           <pre>
  74   sample_ranged_hash_fn
  75   ()
  76 </pre>
  77         </td>
  78
  79         <td>
  80           <p>Default constructor.</p>
  81
  82           <p>Must be default constructable.</p>
  83         </td>
  84       </tr>
  85
  86       <tr>
  87         <td>
  88           <pre>
  89   sample_ranged_hash_fn
  90   (<b>const</b> sample_ranged_hash_fn &amp;other)
  91 </pre>
  92         </td>
  93
  94         <td>
  95           <p>Copy constructor.</p>
  96
  97           <p>Must be copy constructable.</p>
  98         </td>
  99       </tr>
 100
 101       <tr>
 102         <td>
 103           <pre>
 104 <b>inline</b> <b>void</b>
 105   swap
 106   (sample_ranged_hash_fn &amp;other)
 107 </pre>
 108         </td>
 109
 110         <td>
 111           <p>Swaps content.</p>
 112
 113           <p>Must be swappable (if there is such a word).</p>
 114         </td>
 115       </tr>
 116     </table>
 117
 118     <h2><a name="link5" id="link5">Protected Methods</a></h2>
 119
 120     <h3><a name="link6" id="link6">Notification methods.</a></h3>
 121
 122     <table class="c1" width="100%" border="1" summary="Methods">
 123       <tr>
 124         <td width="45%" align="left"><b>Method</b></td>
 125
 126         <td width="55%" align="left"><b>Description</b></td>
 127       </tr>
 128
 129       <tr>
 130         <td>
 131           <pre>
 132 <b>void</b>
 133   notify_resized
 134   (<a href="#size_type55424436"><tt>size_type</tt></a> size)
 135 </pre>
 136         </td>
 137
 138         <td>
 139           <p>Notifies the policy object that the container's size
 140           has changed to <span class="c1"><tt>size</tt></span>.</p>
 141         </td>
 142       </tr>
 143     </table>
 144
 145     <h3><a name="link7" id="link7">Operators.</a></h3>
 146
 147     <table class="c1" width="100%" border="1" summary="Methods">
 148       <tr>
 149         <td width="45%" align="left"><b>Method</b></td>
 150
 151         <td width="55%" align="left"><b>Description</b></td>
 152       </tr>
 153
 154       <tr>
 155         <td>
 156           <pre>
 157 <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
 158   <b>operator</b>()
 159   (const_key_reference r_key) <b>const</b>
 160 </pre>
 161         </td>
 162
 163         <td>
 164           <p>Transforms <span class="c1"><tt>r_key</tt></span> into
 165           a position within the table.</p>
 166         </td>
 167       </tr>
 168     </table>
 169   </div>
 170 </body>
 171 </html>