org.key_project.util.collection

Interface ImmutableHeap<T extends java.lang.Comparable<T>>

All Superinterfaces:

java.lang.Iterable<T>, java.io.Serializable

All Known Implementing Classes:

ImmutableLeftistHeap, ImmutableLeftistHeap.Empty, ImmutableLeftistHeap.Node

public interface ImmutableHeap<T extends java.lang.Comparable<T>>
extends java.io.Serializable, java.lang.Iterable<T>

Interface for heaps of objects of class T. T has to implement the interface Comparable, and the heap is able to return the minimum member regarding the relation compareTo of T via the method findMin. Elements of the interface Heap are immutable. Implementations of Heap have to provide an attribute EMPTY_HEAP, which is a singleton representing empty heaps. Heaps may contain multiple references to one object, or multiple objects which are equal.

Method Summary

Modifier and Type	Method and Description
ImmutableHeap<T>	deleteMin() Remove the minimum element from this heap
T	findMin()
ImmutableHeap<T>	insert(ImmutableHeap<T> h) Add multiple elements to this heap object
ImmutableHeap<T>	insert(java.util.Iterator<T> elements) Add multiple elements to this heap object
ImmutableHeap<T>	insert(T element) Add an element to this heap object
boolean	isEmpty()
ImmutableHeap<T>	removeAll(T element) Remove all elements of this heap which are equal to element.
int	size()
java.util.Iterator<T>	sortedIterator()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isEmpty

boolean isEmpty()

Returns:

true iff this heap is empty

insert

ImmutableHeap<T> insert(T element)

Add an element to this heap object

Parameters:

element - The element to be added

Returns:

a heap that contains all elements of this heap, and additionally element

insert

ImmutableHeap<T> insert(java.util.Iterator<T> elements)

Add multiple elements to this heap object

Parameters:

elements - The elements to be added

Returns:

a heap that contains all elements of this heap, and additionally all objects from elements

insert

ImmutableHeap<T> insert(ImmutableHeap<T> h)

Add multiple elements to this heap object

Parameters:

h - a heap containing the elements to be added

Returns:

a heap that contains all elements of this heap, and additionally all objects from h

findMin

T findMin()

Returns:

the minimum element of this heap, or null iff this heap is empty (isEmpty()==true)

deleteMin

ImmutableHeap<T> deleteMin()

Remove the minimum element from this heap

Returns:

a heap that contains all elements of this heap except for the minimum element

removeAll

ImmutableHeap<T> removeAll(T element)

Remove all elements of this heap which are equal to element.

Returns:

heap that has all occurrences of element removed

size

int size()

Returns:

the number of elements this heap holds

sortedIterator

java.util.Iterator<T> sortedIterator()

Returns:

an iterator that returns all elements of this heap in increasing order