Class Heap<T>

A basic implementation of a min-heap

Type parameters

T: HeapItem<T>

Hierarchy

Heap

Index

Constructors

constructor

Properties

Accessors

count

Methods

Constructors

constructor

new Heap(maxHeapSize: number): Heap

- Defined in services/pathfinding/heap.ts:10
Parameters
- maxHeapSize: number
Returns Heap

Properties

Private heapSize

heapSize: number

Private items

items: T[]

Private maxHeapSize

maxHeapSize: number

Accessors

count

get count(): number

- Defined in services/pathfinding/heap.ts:21
The number of items in the heap.

Returns number

Methods

add

add(item: T): void

- Defined in services/pathfinding/heap.ts:29
Adds an item to the heap.

Parameters
- item: T
  
  The item to add.
Returns void

contains

contains(item: T): boolean

- Defined in services/pathfinding/heap.ts:60
Checks whether the item exists in the heap.

Parameters
- item: T
  
  The item to check.
Returns boolean

removeFirst

removeFirst(): T

- Defined in services/pathfinding/heap.ts:39
Removes the first item from the heap.

Returns T

Private sortDown

sortDown(item: T): void

- Defined in services/pathfinding/heap.ts:67
Parameters
- item: T
Returns void

Private sortUp

sortUp(item: T): void

- Defined in services/pathfinding/heap.ts:91
Parameters
- item: T
Returns void

Private swap

swap(itemA: T, itemB: T): void

- Defined in services/pathfinding/heap.ts:105
Parameters
- itemA: T
- itemB: T
Returns void

update

update(item: T): void

- Defined in services/pathfinding/heap.ts:52
Updates the item's positioning in the heap.

Parameters
- item: T
  
  The item to update.
Returns void

Generated using TypeDoc