<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="ds-hashable.equals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Ds\Hashable::equals</refname>
  <refpurpose>Determines whether an object is equal to the current instance</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Ds\Hashable::equals</methodname>
   <methodparam><type>object</type><parameter>obj</parameter></methodparam>
  </methodsynopsis>
  <para>
    Determines whether another object is equal to the current instance.
  </para>

  <para>
    This method allows objects to be used as keys in structures such as
    <classname>Ds\Map</classname> and <classname>Ds\Set</classname>, or any
    other lookup structure that honors this interface.
  </para>

  <note>
    <para>
        It's guaranteed that <parameter>obj</parameter> is an instance of the same class.
    </para>
  </note>

  <caution>
    <para>
        It's important that objects which are equal also have the same hash value.
        See <function>Ds\Hashable::hash</function>.
    </para>
  </caution>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>obj</parameter></term>
    <listitem>
     <para>
        The object to compare the current instance to, which is always an instance of
        the same class.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    &true; if equal, &false; otherwise.
  </para>
 </refsect1>


</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
