|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--harpoon.Util.Collections.AbstractHeap
AbstractHeap
provides a skeletal implementation of
the Heap
interface, to minimize the effort required
to implement this interface.
Constructor Summary | |
protected |
AbstractHeap(Comparator c)
Sole constructor, for invocation by subclass constructors. |
Method Summary | |
abstract void |
clear()
Removes all entries from this Heap . |
Comparator |
comparator()
Returns the comparator used to compare keys in this Heap ,
or null if the keys' natural ordering is used. |
abstract void |
decreaseKey(Map.Entry me,
Object newkey)
Replace the key in the specified map entry with the specified smaller key. |
abstract void |
delete(Map.Entry me)
Remove the specified map entry from the mapping. |
abstract Collection |
entries()
Returns a collection view of all the Map.Entry s
in this Heap . |
protected Comparator |
entryComparator()
Returns a comparator which can be used to compare Map.Entry s. |
boolean |
equals(Object o)
Compares the specified object with this heap for equality. |
Map.Entry |
extractMinimum()
Remove and return a map entry with minimal key. |
int |
hashCode()
Returns the hash code for this heap. |
protected void |
insert(Map.Entry me)
This method should insert the specified Map.Entry ,
which is not currently in the Heap , into the
Heap . |
abstract Map.Entry |
insert(Object key,
Object value)
Inserts a node with the specified key and value into the Heap . |
boolean |
isEmpty()
Returns true if this Heap has no more
entries. |
protected Comparator |
keyComparator()
Returns the comparator used to compare keys in this Heap . |
abstract Map.Entry |
minimum()
Returns a mapping entry with minimal key. |
protected Object |
setKey(Map.Entry me,
Object newkey)
This method should set the key for the specified Map.Entry to the given newkey . |
abstract int |
size()
Returns the number of entries in this Heap . |
String |
toString()
Returns a string representation of this Heap . |
void |
union(Heap h)
Merges all of the mappings from the specified Heap
into this Heap . |
void |
updateKey(Map.Entry me,
Object newkey)
Replace the key in the specified map entry with the specified key, which may be either larger or smaller than its current key. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
protected AbstractHeap(Comparator c)
Method Detail |
public abstract Map.Entry insert(Object key, Object value)
Heap
Heap
. Returns the generated Map.Entry
which may be stored and eventually passed back to
decreaseKey()
or delete
to remove
this node.
insert
in interface Heap
public abstract Map.Entry minimum()
Heap
minimum
in interface Heap
public abstract void decreaseKey(Map.Entry me, Object newkey)
Heap
decreaseKey
in interface Heap
public abstract void delete(Map.Entry me)
Heap
delete
in interface Heap
public abstract int size()
Heap
Heap
.
size
in interface Heap
public abstract Collection entries()
Heap
Map.Entry
s
in this Heap
.
entries
in interface Heap
public abstract void clear()
Heap
Heap
.
clear
in interface Heap
public void updateKey(Map.Entry me, Object newkey)
Heap
updateKey
in interface Heap
protected void insert(Map.Entry me)
Map.Entry
,
which is not currently in the Heap
, into the
Heap
. Implementation is optional, but it is required
if you use the default implementation of updateKey()
.
protected Object setKey(Map.Entry me, Object newkey)
Map.Entry
to the given newkey
.
Implementation is optional, but it is required if you use the
default implementation of updateKey()
.
public Map.Entry extractMinimum()
Heap
extractMinimum
in interface Heap
public void union(Heap h)
Heap
Heap
into this Heap
. Note that duplicates are
permitted. After calling union()
, the Heap
passed in as an argument will be empty.
Note that usually efficient implementations of this method require
that the Heap
argument be from the same implementation
as this
. (That is, they must both be binomial heaps, or
both fibonacci heaps, etc.)
union
in interface Heap
public boolean isEmpty()
Heap
true
if this Heap
has no more
entries.
isEmpty
in interface Heap
public int hashCode()
Heap
Collection
returned by entries()
.
hashCode
in interface Heap
hashCode
in class Object
public boolean equals(Object o)
Heap
true
iff the given object is also a
Heap
and the Collection
s returned
by their entries()
methods are equal using
the equals()
method of Collection
.
equals
in interface Heap
equals
in class Object
public String toString()
Heap
Heap
.
toString
in interface Heap
toString
in class Object
public Comparator comparator()
Heap
,
or null
if the keys' natural ordering is used.
comparator
in interface Heap
protected Comparator keyComparator()
Heap
.
Will never return null
.
protected Comparator entryComparator()
Map.Entry
s. Will never return null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |