1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.quickhashintstringhash" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The QuickHashIntStringHash class</title>
<titleabbrev>QuickHashIntStringHash</titleabbrev>
<partintro>
<!-- {{{ QuickHashIntStringHash intro -->
<section xml:id="quickhashintstringhash.intro">
&reftitle.intro;
<para>
This class wraps around a hash containing integer numbers, where the
values are strings. Hashes are also available as implementation of the
<interfacename>ArrayAccess</interfacename> interface.
</para>
<para>
Hashes can also be iterated over with <link linkend="control-structures.foreach"><literal>foreach</literal></link> as the <interfacename>Iterator</interfacename> interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
</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>QuickHashIntStringHash::CHECK_FOR_DUPES</constant></term>
<listitem>
<para>If enabled, adding duplicate elements to a set (through either <methodname>QuickHashIntStringHash::add</methodname> or
<methodname>QuickHashIntStringHash::loadFromFile</methodname>) will result in those elements to be dropped from the
set. This will take up extra time, so only used when it is required.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.do-not-use-zend-alloc">
<term><constant>QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
<para>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
count towards the <link linkend="ini.memory-limit">memory_limit</link> settings.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-no-hash">
<term><constant>QuickHashIntStringHash::HASHER_NO_HASH</constant></term>
<listitem>
<para>Selects to not use a hashing function, but merely use a modulo to
find the bucket list index. This is not faster than normal hashing, and
gives more collisions.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins1">
<term><constant>QuickHashIntStringHash::HASHER_JENKINS1</constant></term>
<listitem>
<para>This is the default hashing function to turn the integer hashes
into bucket list indexes.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashintstringhash.constants.hasher-jenkins2">
<term><constant>QuickHashIntStringHash::HASHER_JENKINS2</constant></term>
<listitem>
<para>Selects a variant hashing algorithm.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.quickhash.entities.quickhashintstringhash;
</reference>
<!-- 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
-->
|
