quickhashintstringhash.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 95a1b13144581b79cbebe041abed61d43430d902 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: yes Maintainer: sergey -->
<phpdoc:classref xml:id="class.quickhashintstringhash" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>Класс QuickHashIntStringHash</title>
 <titleabbrev>QuickHashIntStringHash</titleabbrev>

 <partintro>

  <!-- {{{ QuickHashIntStringHash intro -->
  <section xml:id="quickhashintstringhash.intro">
   &reftitle.intro;
   <para>
    Класс-обёртка для хеш-таблицы с целочисленными ключами и значениями, являющимися
    строками. Также реализует интерфейс <interfacename>ArrayAccess</interfacename>.
   </para>
   <para>
    Класс реализует интерфейс <interfacename>Iterator</interfacename>, что даёт возможность перебора
    с помощью конструкции <link linkend="control-structures.foreach"><literal>foreach</literal></link>.
    Порядок следования элементов не гарантируется.
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="quickhashintstringhash.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>QuickHashIntStringHash</classname></ooclass>

    <!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>QuickHashIntStringHash</classname>
     </ooclass>
    </classsynopsisinfo>
    <!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="quickhashintstringhash.constants.check-for-dupes">QuickHashIntStringHash::CHECK_FOR_DUPES</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="quickhashintstringhash.constants.do-not-use-zend-alloc">QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="quickhashintstringhash.constants.hasher-no-hash">QuickHashIntStringHash::HASHER_NO_HASH</varname>
     <initializer>256</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="quickhashintstringhash.constants.hasher-jenkins1">QuickHashIntStringHash::HASHER_JENKINS1</varname>
     <initializer>512</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="quickhashintstringhash.constants.hasher-jenkins2">QuickHashIntStringHash::HASHER_JENKINS2</varname>
     <initializer>1024</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashintstringhash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
   <!-- }}} -->

  </section>

  <!-- {{{ QuickHashIntStringHash constants -->
  <section xml:id="quickhashintstringhash.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="quickhashintstringhash.constants.check-for-dupes">
     <term><constant>QuickHashIntHash::CHECK_FOR_DUPES</constant></term>
     <listitem>
      <para>
       Если включено, то добавление повторяющихся элементов в набор
       (с помощью методов <methodname>QuickHashIntStringHash::add</methodname> или <methodname>QuickHashIntStringHash::loadFromFile</methodname>)
       приведёт к отбрасыванию этих элементов.
       Эта функциональность несколько замедляет работу, так что должен использоваться только
       если действительно необходим.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="quickhashintstringhash.constants.do-not-use-zend-alloc">
     <term><constant>QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
     <listitem>
      <para>
       Запрещает использование встроенного в PHP менеджера памяти для
       внутренних структур. Если включена эта опция, то используемая память не
       будет учитываться настройкой <link linkend="ini.memory-limit">memory_limit</link>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="quickhashintstringhash.constants.hasher-no-hash">
     <term><constant>QuickHashIntHash::HASHER_NO_HASH</constant></term>
     <listitem>
      <para>
       Указывает, что не нужно использовать функцию хеширования, а
       вместо неё, для поиска индекса в цепочке, использовать модуль.
       Это не быстрее обычного хеширования и порождает больше коллизий.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins1">
     <term><constant>QuickHashIntHash::HASHER_JENKINS1</constant></term>
     <listitem>
      <para>
       Хеширующая функция по умолчанию.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins2">
     <term><constant>QuickHashIntHash::HASHER_JENKINS2</constant></term>
     <listitem>
      <para>
       Другой хеширующий алгоритм.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
  <!-- }}} -->


 </partintro>

 &reference.quickhash.entities.quickhashintstringhash;

</phpdoc:classref>
<!-- 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
-->