alma::ACS::jbaci::Heap Class Reference

Collaboration diagram for alma::ACS::jbaci::Heap:

[legend]

List of all members.

Public Member Functions
	Heap (int capacity, Comparator cmp) throws IllegalArgumentException
	Heap (int capacity)
synchronized void	insert (Object x)
synchronized Object	extract ()
synchronized Object	peek ()
synchronized int	size ()
synchronized void	clear ()
Protected Member Functions
int	compare (Object a, Object b)
final int	parent (int k)
final int	left (int k)
final int	right (int k)
Protected Attributes
Object[]	nodes_
int	count_ = 0
final Comparator	cmp_

---

Detailed Description

A heap-based priority queue. The class currently uses a standard array-based heap, as described in, for example, Sedgewick's Algorithms text. All methods are fully synchronized.

---

Constructor & Destructor Documentation

alma::ACS::jbaci::Heap::Heap	(	int	capacity,
		Comparator	cmp
	)			throws IllegalArgumentException [inline]

Create a Heap with the given initial capacity and comparator

Parameters:

	capacity	initial capacity.
	cmp	comparator instance.

Exceptions:

IllegalArgumentException

if capacity less or equal to zero

References cmp_, and nodes_.

alma::ACS::jbaci::Heap::Heap

(

int

capacity

)

[inline]

Create a Heap with the given capacity, and relying on natural ordering.

Parameters:

capacity

initial capacity.

---

Member Function Documentation

synchronized void alma::ACS::jbaci::Heap::clear

(

)

[inline]

Remove all elements.

References count_, and nodes_.

Referenced by alma::ACS::jbaci::BACITimer::shutDown().

int alma::ACS::jbaci::Heap::compare	(	Object	a,
		Object	b
	)			[inline, protected]

Perform element comparisons using comparator or natural ordering.

References cmp_.

Referenced by extract(), and insert().

synchronized Object alma::ACS::jbaci::Heap::extract

(

)

[inline]

Return and remove least element, or null if empty.

Returns:

extraced least element.

References compare(), count_, left(), nodes_, and right().

Referenced by alma::ACS::jbaci::BACITimer::nextTask().

synchronized void alma::ACS::jbaci::Heap::insert

(

Object

x

)

[inline]

Insert an element, resize if necessary.

Parameters:

x

object to insert.

References compare(), count_, nodes_, and parent().

Referenced by alma::ACS::jbaci::BACITimer::executeAfterDelay(), alma::ACS::jbaci::BACITimer::executeAt(), alma::ACS::jbaci::BACITimer::executePeriodically(), and alma::ACS::jbaci::BACITimer::nextTask().

final int alma::ACS::jbaci::Heap::left

(

int

k

)

[inline, protected]

Get left child.

Referenced by extract().

final int alma::ACS::jbaci::Heap::parent

(

int

k

)

[inline, protected]

Get parent index.

Referenced by insert().

synchronized Object alma::ACS::jbaci::Heap::peek

(

)

[inline]

Return least element without removing it, or null if empty.

Returns:

least element.

References count_, and nodes_.

Referenced by alma::ACS::jbaci::BACITimer::nextTask().

final int alma::ACS::jbaci::Heap::right

(

int

k

)

[inline, protected]

Get right child.

Referenced by extract().

synchronized int alma::ACS::jbaci::Heap::size

(

)

[inline]

Return number of elements.

Returns:

number of elements.

References count_.

---

Member Data Documentation

final Comparator alma::ACS::jbaci::Heap::cmp_ [protected]

Ordering comparator.

Referenced by compare(), and Heap().

int alma::ACS::jbaci::Heap::count_ = 0 [protected]

Number of used slots.

Referenced by clear(), extract(), insert(), peek(), and size().

Object [] alma::ACS::jbaci::Heap::nodes_ [protected]

The tree nodes, packed into an array.

Referenced by clear(), extract(), Heap(), insert(), and peek().

---

The documentation for this class was generated from the following file:

• Heap.java