Class MinHeap<N>

A concrete implementation of a min-heap.

Type Parameters

N extends IHeapNode = IHeapNode
The type of nodes in the heap.

Hierarchy (View Summary)

AbstractHeap<N>
- MinHeap

Index

Constructors

constructor

new MinHeap<N extends IHeapNode = IHeapNode>(
initialNodes?: N[] | readonly N[],
): MinHeap<N>
Class instance constructor.
Type Parameters
- N extends IHeapNode = IHeapNode
Parameters
- OptionalinitialNodes: N[] | readonly N[]
  Array of unsorted heap elements.
Returns MinHeap<N>
Overrides AbstractHeap.constructor
- Defined in src/classes/MinHeap.ts:33

Accessors

size

get size(): number
Getter method that returns heap size.

Returns number
Overrides AbstractHeap.size
- Defined in src/classes/MinHeap.ts:54

Methods

[iterator]

"[iterator]"(reversed?: boolean): Generator<N, void, unknown>
Returns an iterator for traversing the heap.
Parameters
- Optionalreversed: boolean = false
  If true, the iterator will traverse the heap in reverse order.
Returns Generator<N, void, unknown>
A generator that yields heap elements in the requested order.
Overrides AbstractHeap.[iterator]
- Defined in src/classes/MinHeap.ts:45

add

add(node: N): void
Adds an element to the heap.
Parameters
- node: N
  The element to add.
Returns void
Overrides AbstractHeap.add
- Defined in src/classes/MinHeap.ts:64

clear

clear(): void
Clears the heap by removing all elements.

Returns void
Overrides AbstractHeap.clear
- Defined in src/classes/MinHeap.ts:73

decrease

decrease(node: N, decreaseValue: number): boolean
Decreases the key value of a heap element.
Parameters
- node: N
  The element whose key value will be decreased.
- decreaseValue: number
  The value of decrease.
Returns boolean
true or false depending on the outcome of the decrease process.
Overrides AbstractHeap.decrease
- Defined in src/classes/MinHeap.ts:85

entries

entries(reversed?: boolean): Generator<N, void, unknown>
Returns an iterator for traversing the heap elements.
Parameters
- Optionalreversed: boolean = false
  If true, the iterator will traverse the heap in reverse order.
Returns Generator<N, void, unknown>
Overrides AbstractHeap.entries
- Defined in src/classes/MinHeap.ts:95

forEach

forEach(
callbackFn: (node: N, index: number, heapInstance: MinHeap<N>) => void,
thisArg?: any,
): void
Executes a provided function once per element in the heap.
Parameters
- callbackFn: (node: N, index: number, heapInstance: MinHeap<N>) => void
  - (node: N, index: number, heapInstance: MinHeap<N>): void
    Parameters
    node: N
    Element of each iteration.
    
    index: number
    The index of the current element being processed in the heap.
    
    heapInstance: MinHeap<N>
    The heap instance being iterated.
    
    Returns void
- OptionalthisArg: any
  Param: thisArg
  A value to use as this when executing callbackFn.
Returns void
Overrides AbstractHeap.forEach
- Defined in src/classes/MinHeap.ts:104

increase

increase(node: N, increaseValue: number): boolean
Increases the key value of a heap element.
Parameters
- node: N
  The element whose key value will be increased.
- increaseValue: number
  The value of increase.
Returns boolean
true or false depending on the outcome of the increase process.
Overrides AbstractHeap.increase
- Defined in src/classes/MinHeap.ts:133

keys

keys(reversed?: boolean): Generator<number, void, unknown>
Returns an iterator for traversing the heap element keys.
Parameters
- Optionalreversed: boolean = false
  If true, the iterator will traverse the heap in reverse order.
Returns Generator<number, void, unknown>
Overrides AbstractHeap.keys
- Defined in src/classes/MinHeap.ts:143

peek

peek(): undefined | N
Returns the top element of the heap or undefined if the heap is empty.

Returns undefined | N
Overrides AbstractHeap.peek
- Defined in src/classes/MinHeap.ts:152

pop

pop(): undefined | N
Removes and returns the top element of the heap, or returns undefined if the heap is empty.

Returns undefined | N
Overrides AbstractHeap.pop
- Defined in src/classes/MinHeap.ts:161

remove

remove(node: N): boolean
Removes an element from the heap.
Parameters
- node: N
  The element to remove.
Returns boolean
true or false depending on the outcome of the removal process.
Overrides AbstractHeap.remove
- Defined in src/classes/MinHeap.ts:172

Class MinHeap<N>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MinHeap<N>

Accessors

size

Returns number

Methods

[iterator]

Parameters

Returns Generator<N, void, unknown>

add

Parameters

Returns void

clear

Returns void

decrease

Parameters

Returns boolean

entries

Parameters

Returns Generator<N, void, unknown>

forEach

Parameters

Parameters

Returns void

Param: thisArg

Returns void

increase

Parameters

Returns boolean

keys

Parameters

Returns Generator<number, void, unknown>

peek

Returns undefined | N

pop

Returns undefined | N

remove

Parameters

Returns boolean

Settings

On This Page