Class MaxHeap<A>

A mutable MAX HEAP data-structure. It can also work as a min heap by inverting the gt parameter.

Type parameters

A

Hierarchy

MaxHeap

Index

Accessors

Methods

Accessors

length

get length(): number

- Defined in src/mutable/maxHeap.ts:26
Returns the size of the heap

Returns number

peek

get peek(): A | undefined

- Defined in src/mutable/maxHeap.ts:33
Returns the top most element on the heap

Returns A | undefined

Static numbers

get numbers(): MaxHeap<number>

- Defined in src/mutable/maxHeap.ts:16
Creates a new MaxHeap that works with numbers

Returns MaxHeap<number>

Methods

pop

pop(): A | undefined

- Defined in src/mutable/maxHeap.ts:44
Remove the top element from heap.

Returns A | undefined

push

push(element: A): void

- Defined in src/mutable/maxHeap.ts:59
Adds a new element to the heap

Parameters
- element: A
Returns void

Static of

of<A>(gt: function): MaxHeap<A>

- Defined in src/mutable/maxHeap.ts:9
Creates a new MaxHeap data structure.

Type parameters
- A
Parameters
- gt: function
  - - (a: A, b: A): boolean
    - Parameters
      - a: A
      - b: A
      Returns boolean
Returns MaxHeap<A>

Generated using TypeDoc