File: QuickHashIntSet.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (94 lines) | stat: -rw-r--r-- 3,902 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="QuickHashIntSet" namespace="" name="QuickHashIntSet">
  <constant name="CHECK_FOR_DUPES" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="DO_NOT_USE_ZEND_ALLOC" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="HASHER_NO_HASH" value="256">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="HASHER_JENKINS1" value="512">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="HASHER_JENKINS2" value="1024">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="add" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This method adds a new entry to the set"/>
      <return type="bool"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="int"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new QuickHashIntSet object"/>
      <return type="void"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="delete" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This method deletes an entry from the set"/>
      <return type="bool"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="int"/>
  </method>
  <method name="exists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This method checks whether a key is part of the set"/>
      <return type="bool"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the number of elements in the set"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="loadFromFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This factory method creates a set from a file"/>
      <return type="QuickHashIntSet"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="size" optional="true" byreference="false" type="int"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
  <method name="loadFromString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This factory method creates a set from a string"/>
      <return type="QuickHashIntSet"/>
    </docblock>
    <parameter name="contents" optional="false" byreference="false" type="string"/>
    <parameter name="size" optional="true" byreference="false" type="int"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
  <method name="saveToFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This method stores an in-memory set to disk"/>
      <return type="void"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
  </method>
  <method name="saveToString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="This method returns a serialized version of the set"/>
      <return type="string"/>
    </docblock>
  </method>
</class>