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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Ds\PriorityQueue" namespace="Ds" name="PriorityQueue">
<implements name="Ds\Collection" full="Ds\Collection"/>
<constant name="MIN_CAPACITY" value="8">
<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="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="copy" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a shallow copy of the queue"/>
<return type="Ds\PriorityQueue"/>
</docblock>
</method>
<method name="isEmpty" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns whether the queue is empty"/>
<return type="bool"/>
</docblock>
</method>
<method name="peek" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the value at the front of the queue"/>
<return type="mixed"/>
</docblock>
</method>
<method name="pop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes and returns the value with the highest priority">Removes and returns the value at the front of the queue, ie. the value with the highest priority.</description>
<return type="mixed"/>
</docblock>
</method>
<method name="push" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Pushes values into the queue"/>
<return type="void"/>
</docblock>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="false" byreference="false" type="int"/>
</method>
<method name="toArray" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Converts the queue to an array ">Converts the queue to an array.</description>
<return type="array"/>
</docblock>
</method>
</class>
|