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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Ds\Vector" namespace="Ds" name="Vector">
<implements name="Ds\Sequence" full="Ds\Sequence"/>
<constant name="MIN_CAPACITY" value="10">
<docblock>
<var type="int"/>
</docblock>
</constant>
<method name="allocate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Allocates enough memory for a required capacity"/>
<return type="void"/>
</docblock>
<parameter name="capacity" optional="false" byreference="false" type="int"/>
</method>
<method name="apply" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Updates all values by applying a callback function to each value"/>
<return type="void"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="capacity" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the current capacity"/>
<return type="int"/>
</docblock>
</method>
<method name="clear" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes all values"/>
<return type="void"/>
</docblock>
</method>
<method name="contains" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Determines if the vector contains given values"/>
<return type="bool"/>
</docblock>
<parameter name="...values" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="copy" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a shallow copy of the vector"/>
<return type="Ds\Vector"/>
</docblock>
</method>
<method name="filter" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Creates a new vector using a callable to determine which values to include "/>
<return type="Ds\Vector"/>
</docblock>
<parameter name="callback" optional="true" byreference="false" type="object" class="callable"/>
</method>
<method name="find" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Attempts to find a value's index "/>
<return type="mixed"/>
</docblock>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="first" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the first value in the vector"/>
<return type="mixed"/>
</docblock>
</method>
<method name="get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the value at a given index"/>
<return type="mixed"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
</method>
<method name="insert" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Inserts values at a given index"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="...values" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="isEmpty" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns whether the vector is empty"/>
<return type="bool"/>
</docblock>
</method>
<method name="join" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Joins all values together as a string"/>
<return type="string"/>
</docblock>
<parameter name="glue" optional="true" byreference="false" type="string"/>
</method>
<method name="last" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the last value"/>
<return type="mixed"/>
</docblock>
</method>
<method name="map" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the result of applying a callback to each value"/>
<return type="Ds\Vector"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="merge" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the result of adding all given values to the vector"/>
<return type="Ds\Vector"/>
</docblock>
<parameter name="values" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="pop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes and returns the last value"/>
<return type="mixed"/>
</docblock>
</method>
<method name="push" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds values to the end of the vector"/>
<return type="void"/>
</docblock>
<parameter name="...values" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="reduce" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Reduces the vector to a single value using a callback function"/>
<return type="mixed"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="initial" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="remove" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes and returns a value by index"/>
<return type="mixed"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
</method>
<method name="reverse" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Reverses the vector in-place "/>
<return type="void"/>
</docblock>
</method>
<method name="reversed" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a reversed copy"/>
<return type="Ds\Vector"/>
</docblock>
</method>
<method name="rotate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Rotates the vector by a given number of rotations"/>
<return type="void"/>
</docblock>
<parameter name="rotations" optional="false" byreference="false" type="int"/>
</method>
<method name="set" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Updates a value at a given index"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="shift" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes and returns the first value"/>
<return type="mixed"/>
</docblock>
</method>
<method name="slice" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Returns a sub-vector of a given range "/>
<return type="Ds\Vector"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="length" optional="true" byreference="false" type="int"/>
</method>
<method name="sort" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Sorts the vector in-place "/>
<return type="void"/>
</docblock>
<parameter name="comparator" optional="true" byreference="false" type="object" class="callable"/>
</method>
<method name="sorted" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a sorted copy"/>
<return type="Ds\Vector"/>
</docblock>
<parameter name="comparator" optional="true" byreference="false" type="object" class="callable"/>
</method>
<method name="sum" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the sum of all values in the vector">Returns the sum of all values in the vector.</description>
<return type="number"/>
</docblock>
</method>
<method name="toArray" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Converts the vector to an array ">Converts the vector to an array.</description>
<return type="array"/>
</docblock>
</method>
<method name="unshift" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds values to the front of the vector"/>
<return type="void"/>
</docblock>
<parameter name="values" optional="true" byreference="false" type="object" class="mixed"/>
</method>
</class>
|
