Modifier and Type	Class and Description
public static class	BinaryHeap.Node A binary heap node.

Modifier and Type	Field and Description
private final boolean	isMaxHeap
private BinaryHeap.Node[]	nodes
public int	size

Access	Constructor and Description
public	BinaryHeap()
public	BinaryHeap(int capacity, boolean isMaxHeap)

Method Summary

Modifier and Type	Method and Description
public T	Returns: The specified node. add(T node) Adds the node to the heap using its current value.
public T	Returns: The specified node. add(T node, float value) Sets the node's value and adds it to the heap.
public void	clear()
public boolean	contains(T node, boolean If true, == comparison will be used. If false, .equals() comparison will be used. identity) Returns true if the heap contains the specified node.
private void	down(int index)
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty() Returns true if the heap is empty.
public boolean	notEmpty() Returns true if the heap has one or more items.
public T	peek() Returns the first item in the heap.
public T	pop() Removes the first item in the heap and returns it.
public T	remove(T node) Returns: The specified node.
public void	setValue(T node, float value) Changes the value of the node, which should already be in the heap.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	up(int index)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

isMaxHeap	back to summary
private final boolean isMaxHeap

nodes	back to summary
private BinaryHeap.Node[] nodes

size	back to summary
public int size

Constructor Detail

BinaryHeap	back to summary
public BinaryHeap()

BinaryHeap	back to summary
public BinaryHeap(int capacity, boolean isMaxHeap)

Method Detail

add	back to summary
public T add(T node) Adds the node to the heap using its current value. The node should not already be in the heap. Returns:T The specified node.

add

back to summary

public T add(T node)

Adds the node to the heap using its current value. The node should not already be in the heap.

Returns:T: The specified node.

add	back to summary
public T add(T node, float value) Sets the node's value and adds it to the heap. The node should not already be in the heap. Returns:T The specified node.

add

back to summary

public T add(T node, float value)

Sets the node's value and adds it to the heap. The node should not already be in the heap.

Returns:T: The specified node.

clear	back to summary
public void clear()

contains	back to summary
public boolean contains(T node, boolean identity) Returns true if the heap contains the specified node. Parameters identity:boolean If true, == comparison will be used. If false, .equals() comparison will be used.

contains

back to summary

public boolean contains(T node, boolean identity)

Returns true if the heap contains the specified node.

Parameters

identity:boolean: If true, == comparison will be used. If false, .equals() comparison will be used.

down	back to summary
private void down(int index)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isEmpty	back to summary
public boolean isEmpty() Returns true if the heap is empty.

notEmpty	back to summary
public boolean notEmpty() Returns true if the heap has one or more items.

peek	back to summary
public T peek() Returns the first item in the heap. This is the item with the lowest value (or highest value if this heap is configured as a max heap).

pop	back to summary
public T pop() Removes the first item in the heap and returns it. This is the item with the lowest value (or highest value if this heap is configured as a max heap).

remove	back to summary
public T remove(T node) Returns:T The specified node.

setValue	back to summary
public void setValue(T node, float value) Changes the value of the node, which should already be in the heap.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

up	back to summary
private void up(int index)

com.badlogic.gdx.utils back to summary

public Class BinaryHeap.Node

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.utils.BinaryHeap.Node

A binary heap node.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv int	index
pack-priv float	value

Constructor Summary

Access	Constructor and Description
public	Node(float The initial value for the node. To change the value, use `BinaryHeap#add(Node, float)` if the node is not in the heap, or `BinaryHeap#setValue(Node, float)` if the node is in the heap. value)

Method Summary

Modifier and Type	Method and Description
public float	getValue()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

index	back to summary
pack-priv int index

value	back to summary
pack-priv float value

Constructor Detail

Node	back to summary
public Node(float value) Parameters value:float The initial value for the node. To change the value, use `BinaryHeap#add(Node, float)` if the node is not in the heap, or `BinaryHeap#setValue(Node, float)` if the node is in the heap.

Method Detail

getValue	back to summary
public float getValue()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

public Class BinaryHeap<T extends BinaryHeap.Node>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BinaryHeap.Node

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail