File: Judy.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 (166 lines) | stat: -rw-r--r-- 6,939 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
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
158
159
160
161
162
163
164
165
166
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Judy" namespace="" name="Judy">
  <implements name="ArrayAccess" full="ArrayAccess"/>
  <constant name="BITSET" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="INT_TO_INT" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="INT_TO_MIXED" value="3">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="STRING_TO_INT" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="STRING_TO_MIXED" value="5">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="byCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Locate the Nth index present in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="nth_index" optional="false" byreference="false" type="int"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a new Judy object"/>
      <return type="void"/>
    </docblock>
    <parameter name="judy_type" optional="false" byreference="false" type="int"/>
  </constructor>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Count the number of elements in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="index_start" optional="true" byreference="false" type="int"/>
    <parameter name="index_end" optional="true" byreference="false" type="int"/>
  </method>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destruct a Judy object"/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="first" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the first index in the Judy array"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="index" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="firstEmpty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the first absent index in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="index" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="free" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Free the entire Judy array"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the type of the current Judy array"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="last" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the last index in the Judy array"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="true" byreference="false" type="string"/>
  </method>
  <method name="lastEmpty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the last absent index in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="index" optional="true" byreference="false" type="int"/>
  </method>
  <method name="memoryUsage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the memory used by the Judy array"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the next index in the Judy array"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="nextEmpty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the next absent index in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether a offset exists"/>
      <return type="bool"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Offset to retrieve"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Offset to set"/>
      <return type="bool"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Offset to unset"/>
      <return type="bool"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="prev" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the previous index in the Judy array"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="prevEmpty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Search for the previous absent index in the Judy array"/>
      <return type="int"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="size" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the size of the current Judy array"/>
      <return type="void"/>
    </docblock>
  </method>
</class>