libstdc++-v3/doc/html/ext/pb_ds/direct_mod_range_hashing.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>direct_mod_range_hashing 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>direct_mod_range_hashing</tt> Interface</h1>
  17
  18     <p>A mod range-hashing class (uses the modulo function).</p>
  19
  20     <p>Defined in: <a href=
  21     "../../../../include/ext/pb_ds/hash_policy.hpp"><tt>hash_policy.hpp</tt></a></p>
  22
  23     <h2><a name="link1" id="link1">Template Parameters</a></h2>
  24
  25     <table class="c1" width="100%" border="1" summary=
  26     "Template Parameters">
  27       <tr>
  28         <td width="20%" align="left"><b>Parameter</b></td>
  29
  30         <td width="50%" align="left"><b>Description</b></td>
  31
  32         <td width="30%" align="left"><b>Default Value</b></td>
  33       </tr>
  34
  35       <tr>
  36         <td>
  37           <pre>
  38 <a name="Size_Type42920436" id=
  39 "Size_Type42920436"><b>typename</b> Size_Type </a>
  40 </pre>
  41         </td>
  42
  43         <td>
  44           <p>Size type.</p>
  45         </td>
  46
  47         <td>size_t</td>
  48       </tr>
  49     </table>
  50
  51     <h2><a name="link2" id="link2">Public Types and
  52     Constants</a></h2>
  53
  54     <h3><a name="link3" id="link3">General Definitions</a></h3>
  55
  56     <table class="c1" width="100%" border="1" summary="Types">
  57       <tr>
  58         <td width="30%" align="left"><b>Type</b></td>
  59
  60         <td width="55%" align="left"><b>Definition</b></td>
  61
  62         <td width="15%" align="left"><b>Description</b></td>
  63       </tr>
  64
  65       <tr>
  66         <td>
  67           <pre>
  68 <a name="size_type55424436" id="size_type55424436">size_type</a>
  69 </pre>
  70         </td>
  71
  72         <td>
  73           <pre>
  74 <a href="#Size_Type42920436"><tt>Size_Type</tt></a>
  75 </pre>
  76         </td>
  77
  78         <td>
  79           <p>Size type.</p>
  80         </td>
  81       </tr>
  82     </table>
  83
  84     <h2><a name="link4" id="link4">Public Methods</a></h2>
  85
  86     <h3><a name="link5" id="link5">Constructors, Destructor, and
  87     Related</a></h3>
  88
  89     <table class="c1" width="100%" border="1" summary="Methods">
  90       <tr>
  91         <td width="45%" align="left"><b>Method</b></td>
  92
  93         <td width="55%" align="left"><b>Description</b></td>
  94       </tr>
  95
  96       <tr>
  97         <td>
  98           <pre>
  99 <b>void</b>
 100   swap
 101   (<span class=
 102 "c2"><tt>direct_mod_range_hashing</tt></span> &amp;other)
 103 </pre>
 104         </td>
 105
 106         <td>
 107           <p>Swaps content.</p>
 108         </td>
 109       </tr>
 110     </table>
 111
 112     <h2><a name="link6" id="link6">Protected Methods</a></h2>
 113
 114     <h3><a name="link7" id="link7">Notification Methods</a></h3>
 115
 116     <h3><a name="link8" id="link8">Operators.</a></h3>
 117
 118     <table class="c1" width="100%" border="1" summary="Methods">
 119       <tr>
 120         <td width="45%" align="left"><b>Method</b></td>
 121
 122         <td width="55%" align="left"><b>Description</b></td>
 123       </tr>
 124
 125       <tr>
 126         <td>
 127           <pre>
 128 <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
 129   <b>operator</b>()
 130   (<a href=
 131 "#size_type55424436"><tt>size_type</tt></a> hash) <b>const</b>
 132 </pre>
 133         </td>
 134
 135         <td>
 136           <p>Transforms the hash value <span class=
 137           "c1"><tt>hash</tt></span> into a ranged-hash value (using
 138           a modulo operation).</p>
 139         </td>
 140       </tr>
 141     </table>
 142   </div>
 143 </body>
 144 </html>