kone.collections/dev.lounres.kone.collections.heap

Package-level declarations

Types

interface HeapEntry<out Element, out Priority>

Represents a pair of an element and its (future) priority in the heap.

interface HeapNode<Element, Priority> : HeapEntry<Element, Priority>

Represents a node in the inner structure of MinimumHeap/MaximumHeap.

interface LinkedHeapNode<Element, Priority> : HeapNode<Element, Priority>

Represents a node in the inner structure of LinkedMinimumHeap/LinkedMaximumHeap. See HeapNode for general definition.

LinkedMaximumHeap

interface LinkedMaximumHeap<Element, Priority> : MaximumHeap<Element, Priority>

Represents a linked minimum heap. See MaximumHeap for general definition of minimum heap.

LinkedMinimumHeap

interface LinkedMinimumHeap<Element, Priority> : MinimumHeap<Element, Priority>

Represents a linked minimum heap. See MinimumHeap for general definition of minimum heap.

interface MaximumHeap<Element, Priority>

In Kone, maximum heap is a structure that consists of:

interface MinimumHeap<Element, Priority>

In Kone, minimum heap is a structure that consists of:

Properties

val <Element, Priority> MaximumHeap<Element, Priority>.nodes: KoneReifiedSet<HeapNode<Element, Priority>>

val <Element, Priority> MinimumHeap<Element, Priority>.nodes: KoneReifiedSet<HeapNode<Element, Priority>>

Functions

fun <Element, Priority> HeapEntry(element: Element, priority: Priority): HeapEntry<Element, Priority>

Returns simple HeapEntry instance that has the specified element and priority.

fun MaximumHeap<*, *>.isEmpty(): Boolean

fun MinimumHeap<*, *>.isEmpty(): Boolean

Checks if the heap is empty.

fun MaximumHeap<*, *>.isNotEmpty(): Boolean

fun MinimumHeap<*, *>.isNotEmpty(): Boolean

Checks if the heap is not empty.