cz.cuni.amis.utils.heap

Class ImmutableHeap<NODE>

java.lang.Object

cz.cuni.amis.utils.heap.ImmutableHeap<NODE>

Type Parameters:

NODE -

All Implemented Interfaces:

IHeap<NODE>, Iterable<NODE>, Collection<NODE>

public class ImmutableHeap<NODE>
extends Object
implements IHeap<NODE>

Unmodifiable decorator the IHeap objects.

Author:

Jimmy

Constructor Summary

Constructors

Constructor and Description
ImmutableHeap(IHeap<NODE> heap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(NODE arg0)
boolean	addAll(Collection arg0)
boolean	addAll(NODE[] arg0) Adds all items from 'items'.
boolean	changedKey(NODE node) "node" value has been changed (not sure if it was increased or decreased), bubble it through the heap.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	containsAll(Object[] items) Whether this heap contains all 'items'.
boolean	decreaseKey(NODE arg0) "node" value has been decreased, bubble it through the heap.
boolean	deleteMin() Deletes node with min-value, returns success (true if there was some object in the heap, false if there weren't).
boolean	empty() Whether this heap is empty.
Comparator<NODE>	getComparator() Returns comparator that is used to compare the nodes in the heap.
NODE	getMin() Returns node with min-value from the heap.
boolean	increaseKey(NODE node) "node" value has been increased, bubble it through the heap.
boolean	isEmpty()
Iterator<NODE>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
Set<NODE>	toSet() Returns this heap as a set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

ImmutableHeap

public ImmutableHeap(IHeap<NODE> heap)

Method Detail

deleteMin

public boolean deleteMin()

Description copied from interface: IHeap

Deletes node with min-value, returns success (true if there was some object in the heap, false if there weren't).

Specified by:

deleteMin in interface IHeap<NODE>

Returns:

success

decreaseKey

public boolean decreaseKey(NODE arg0)

Description copied from interface: IHeap

"node" value has been decreased, bubble it through the heap.

Specified by:

decreaseKey in interface IHeap<NODE>

Returns:

add

public boolean add(NODE arg0)

Specified by:

add in interface Collection<NODE>

addAll

public boolean addAll(Collection arg0)

Specified by:

addAll in interface Collection<NODE>

addAll

public boolean addAll(NODE[] arg0)

Description copied from interface: IHeap

Adds all items from 'items'.

Specified by:

addAll in interface IHeap<NODE>

Returns:

clear

public void clear()

Specified by:

clear in interface Collection<NODE>

changedKey

public boolean changedKey(NODE node)

Description copied from interface: IHeap

"node" value has been changed (not sure if it was increased or decreased), bubble it through the heap.

Specified by:

changedKey in interface IHeap<NODE>

Returns:

containsAll

public boolean containsAll(Object[] items)

Description copied from interface: IHeap

Whether this heap contains all 'items'.

Specified by:

containsAll in interface IHeap<NODE>

Returns:

empty

public boolean empty()

Description copied from interface: IHeap

Whether this heap is empty.

Specified by:

empty in interface IHeap<NODE>

Returns:

getComparator

public Comparator<NODE> getComparator()

Description copied from interface: IHeap

Returns comparator that is used to compare the nodes in the heap.

Specified by:

getComparator in interface IHeap<NODE>

Returns:

getMin

public NODE getMin()

Description copied from interface: IHeap

Returns node with min-value from the heap.

Specified by:

getMin in interface IHeap<NODE>

Returns:

increaseKey

public boolean increaseKey(NODE node)

Description copied from interface: IHeap

"node" value has been increased, bubble it through the heap.

Specified by:

increaseKey in interface IHeap<NODE>

Returns:

toSet

public Set<NODE> toSet()

Description copied from interface: IHeap

Returns this heap as a set.

Specified by:

toSet in interface IHeap<NODE>

Returns:

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<NODE>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<NODE>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<NODE>

iterator

public Iterator<NODE> iterator()

Specified by:

iterator in interface Iterable<NODE>

Specified by:

iterator in interface Collection<NODE>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<NODE>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<NODE>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<NODE>

size

public int size()

Specified by:

size in interface Collection<NODE>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<NODE>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<NODE>