Heap

class Heap<T>

Heap

A simple, generic heap implementation that uses a caller provided function to enable heaps of custom types.

The basic heap types, min-heap and max-heap, can be implemented by using a simple lambda such as:

// min heap
{ a, b -> a < b }

// max heap
{ a, b -> a b }

Author

Elizabeth Paige Harper - https://github.com/foxcapades

Since

0.1.0

Parameters

Type of values contained in this heap.

Constructors

Heap

fun <T> Heap(initialCapacity: Int = 8, scaleFactor: Float = 1.5f, maxSize: Int = Int.MAX_VALUE, sortTest: SortTest<T>)

Constructs a new heap instance.

Functions

forEach

inline fun forEach(fn: (T) -> Unit)

Destructively iterates over the elements popped from this heap and calls the given function on each value.

forEachIndexed

inline fun forEachIndexed(fn: (i: Int, it: T) -> Unit)

Destructively iterates over the elements popped from this heap and calls the given function on each value.

hasNext

operator fun hasNext(): Boolean

Tests whether this heap contains more items.

insert

fun insert(value: T)

Inserts a new value into the heap.

isEmpty

fun isEmpty(): Boolean

Tests whether this heap contains zero items.

isNotEmpty

fun isNotEmpty(): Boolean

Tests whether this heap contains one or more items.

iterator

operator fun iterator(): Heap<T>

Returns a destructive iterator over the contents of this heap.

operator fun next(): T

Removes and returns the value at the top of this heap.

peekNext

fun peekNext(): T

Returns the value at the top of this heap without removing it.

plusAssign

inline operator fun plusAssign(value: T)

Properties

capacity

val capacity: Int

The current capacity of the heap.

maxSize

val maxSize: Int

The maximum allowed number of items in this heap.

size

var size: Int

The current number of items in this heap.