Package jasima.core.simulation

Class EventHeap

java.lang.Object

jasima.core.simulation.EventHeap

All Implemented Interfaces:

EventQueue

public final class EventHeap
extends Object
implements EventQueue

An implementation of EventQueue using an array-based heap.

Author:

Torsten Hildebrandt

Constructor Summary

Constructors

Modifier	Constructor	Description
	EventHeap()	Create an event heap with an initial capacity of 103.
	EventHeap(int capacity)	Create an event heap with the given capacity.
protected	EventHeap(EventHeap copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
ArrayList<SimEvent>	allEvents()	Returns all events as an ordered list.
void	clear()	remove all elements *
SimEvent	extract()	Return and remove least element, or null if empty.
int	indexOf(SimEvent element)	Scans the underlying array if it contains the given element.
void	insert(SimEvent x)	insert an element, resize if necessary
boolean	remove(SimEvent element)	Removes an element from this heap.
int	size()	Return number of elements *

Methods inherited from class java.lang.Object

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

Constructor Detail

EventHeap

public EventHeap()

Create an event heap with an initial capacity of 103.

EventHeap

public EventHeap(int capacity)
          throws IllegalArgumentException

Create an event heap with the given capacity.

Throws:

IllegalArgumentException - if capacity less or equal to zero

EventHeap

protected EventHeap(EventHeap copyFrom)

Copy constructor.

Method Detail

insert

public void insert(SimEvent x)

insert an element, resize if necessary

Specified by:

insert in interface EventQueue

extract

public SimEvent extract()

Return and remove least element, or null if empty.

Specified by:

extract in interface EventQueue

indexOf

public int indexOf(SimEvent element)

Scans the underlying array if it contains the given element. This methods requires O(n) time and compares object references for equality, not using equals().

Parameters:

element - the element to look for.

Returns:

the index of the element in the underlying array

remove

public boolean remove(SimEvent element)

Removes an element from this heap. Required O(n) time to find the position of element in the underlying array.

Specified by:

remove in interface EventQueue

Parameters:

element - the element to remove

Returns:

true if the element was contained in the heap and successfully removed, false otherwise

clear

public void clear()

remove all elements *

size

public int size()

Return number of elements *

Specified by:

size in interface EventQueue

allEvents

public ArrayList<SimEvent> allEvents()

Returns all events as an ordered list.

Specified by:

allEvents in interface EventQueue

Returns:

All events.