Class BinaryHeap<T>

A binary heap.

Type Parameters

T

Implements

PeekableQueue<T>
SyncQueue<T>

Index

Constructors

Properties

Accessors

Methods

clear front heapifyDown heapifyUp parent push shift

Constructors

constructor

new BinaryHeap<T>(items?, compare?, heapify?): BinaryHeap<T>
Type Parameters
- T
Parameters
- Optional items: Iterable<T>
  Initial elements for this heap.
- compare: ((lhs, rhs) => number) = defaultCompare
  The compare function to order elements.
  - - (lhs, rhs): number
    - The compare function to order elements.
      
      Parameters
      lhs: T
      rhs: T
      Returns number
- heapify: boolean = true
  Whether to heapify the initial elements. Set this to false if elements are already in heap order.
Returns BinaryHeap<T>
- Defined in collections/src/impl/heap.ts:7

Properties

`Private` `Readonly` compare

compare: ((lhs, rhs) => number) = defaultCompare

Type declaration

- (lhs, rhs): number
- The compare function to order elements.
  Parameters
  - lhs: T
  - rhs: T
  Returns number

`Private` heap

heap: T[]

Accessors

size

get size(): number
Returns the size of this BinaryHeap.

Returns number
- Defined in collections/src/impl/heap.ts:24

Methods

clear

clear(): void
Clears this BinaryHeap.

Returns void
- Defined in collections/src/impl/heap.ts:34

front

front(): undefined | T
Returns the top element, or undefined if empty.

Returns undefined | T
Implementation of SyncQueue.front
- Defined in collections/src/impl/heap.ts:29

`Private` heapifyDown

heapifyDown(index): void
Parameters
- index: number
Returns void
- Defined in collections/src/impl/heap.ts:74

`Private` heapifyUp

heapifyUp(index): void
Parameters
- index: number
Returns void
- Defined in collections/src/impl/heap.ts:59

`Private` parent

parent(index): number
Parameters
- index: number
Returns number
- Defined in collections/src/impl/heap.ts:55

push

push(value): void
Adds an element to this heap.
Parameters
- value: T
Returns void
Implementation of SyncQueue.push
- Defined in collections/src/impl/heap.ts:39

shift

shift(): undefined | T
Removes and returns the top element, or undefined if empty.

Returns undefined | T
Implementation of SyncQueue.shift
- Defined in collections/src/impl/heap.ts:45

Generated using TypeDoc