class__hashp.html

A Set of Simple C++ Hash Templates

<div class="memdoc">

<p>
Compares a T type against an KEY_TYPE type. 
<p>
The implementation should be a simple comparison operation between the key in ref1 and the key that is ref2. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ref1</em>&nbsp;</td><td>A type T reference </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ref2</em>&nbsp;</td><td>A type KEY_TYPE reference </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if ref1 contains ref2 or FALSE otherwise </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd><b>Do not neglect to include the COMPAREREFERENCESPREATTRIBUTES and COMPAREREFERENCESPOSTATTRIBUTES parts.</b> If you do, you probably won't get a compile or linker error, but your program could behave unpredictably. </dd></dl>

</div>
</div><p>
<a class="anchor" name="5e4e2a94d9a033bac864588b4abe8488"></a><!-- doxytag: member="_HashP::erase" ref="5e4e2a94d9a033bac864588b4abe8488" args="(KEY_TYPE r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename KEY_TYPE&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::erase           </td>
          <td>(</td>
          <td class="paramtype">KEY_TYPE&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Erases an element from the table. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>A key of the element to erase </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="f66e108d50b7fda46362f051567beb2d"></a><!-- doxytag: member="_HashP::Get" ref="f66e108d50b7fda46362f051567beb2d" args="(KEY_TYPE ref)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename KEY_TYPE&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T * <a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::Get           </td>
          <td>(</td>
          <td class="paramtype">KEY_TYPE&nbsp;</td>
          <td class="paramname"> <em>ref</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get an element from the table. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ref</em>&nbsp;</td><td>The key used to find the element </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the element sought, or NULL if not found. </dd></dl>

<p>
Reimplemented in <a class="el" href="class__Hash.html#1364a81d9020ce40838ac0e9a2147ca2">_Hash&lt; T, KEY_TYPE &gt;</a>.
</div>
</div><p>
<a class="anchor" name="3ee36fa83d4d6370c6713bdc0a43bcf0"></a><!-- doxytag: member="_HashP::Find" ref="3ee36fa83d4d6370c6713bdc0a43bcf0" args="(KEY_TYPE ref) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename KEY_TYPE&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T * <a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::Find           </td>
          <td>(</td>
          <td class="paramtype">KEY_TYPE&nbsp;</td>
          <td class="paramname"> <em>ref</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Identical <a class="el" href="class__HashP.html#f66e108d50b7fda46362f051567beb2d">Get(KEY_TYPE)</a>. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer to an element if found, or NULL otherwise </dd></dl>

</div>
</div><p>
<a class="anchor" name="a47d77bd974a16bea038e41850a660fd"></a><!-- doxytag: member="_HashP::IsAdded" ref="a47d77bd974a16bea038e41850a660fd" args="(KEY_TYPE ref) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename KEY_TYPE = const char *&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::IsAdded           </td>
          <td>(</td>
          <td class="paramtype">KEY_TYPE&nbsp;</td>
          <td class="paramname"> <em>ref</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Has an element been added? 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if the specified element was found, or FALSE otherwise </dd></dl>

</div>
</div><p>
<a class="anchor" name="c02c81c0f04e0e4d5edce2518f5764df"></a><!-- doxytag: member="_HashP::SeekIterator" ref="c02c81c0f04e0e4d5edce2518f5764df" args="(phashelementlist &amp;plist, KEY_TYPE)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename KEY_TYPE&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::<a class="el" href="class____hash_1_1listelement.html">listelement</a> * <a class="el" href="class__HashP.html">_HashP</a>&lt; T, KEY_TYPE &gt;::SeekIterator           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class____hash_1_1elementlist.html">phashelementlist</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>plist</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">KEY_TYPE&nbsp;</td>
          <td class="paramname"> <em>ref</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Searches for an iterator to an element. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>plist</em>&nbsp;</td><td>The list in which the element was found </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ref</em>&nbsp;</td><td>A key to the element. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The iterator to the element, or plist-&gt;end() if none was found </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ahashp_8h-source.html">ahashp.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Feb 1 13:27:19 2008 for ahash by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>