Class Heap<T>`Abstract`

Type Parameters

T

Hierarchy

Heap
- MaxHeap
- MinHeap

Index

Constructors

Properties

_pq _priorityCb

Accessors

Methods

clear isEmpty offer peek peekLast poll toArray

Constructors

`Protected` constructor

new Heap<T>(options?): Heap<T>
The function is a constructor for a class that initializes a priority callback function based on the options provided.
Type Parameters
- T
Parameters
- Optional options: HeapOptions<T>
  
  An optional object that contains configuration options for the Heap.
Returns Heap<T>
- Defined in src/data-structures/heap/heap.ts:17

Properties

`Protected` `Abstract` _pq

_pq: PriorityQueue<HeapItem<T>>

`Protected` _priorityCb

_priorityCb: ((element) => number)

Type declaration

- (element): number
- Parameters
  - element: T
  Returns number

Accessors

size

get size(): number
The function returns the size of a priority queue.

Returns number
The size of the priority queue.
- Defined in src/data-structures/heap/heap.ts:33

Methods

clear

clear(): void
The clear function clears the priority queue.

Returns void
- Defined in src/data-structures/heap/heap.ts:119

isEmpty

isEmpty(): boolean
The function checks if a priority queue is empty.

Returns boolean
A boolean value indicating whether the size of the priority queue is less than 1.
- Defined in src/data-structures/heap/heap.ts:41

offer

offer(element, priority?): Heap<T>
The offer function adds an element to a priority queue with an optional priority value.
Parameters
- element: T
  
  The element parameter represents the value that you want to add to the heap. It can be of any type.
- Optional priority: number
  
  The priority parameter is an optional number that represents the priority of the element being offered to the heap. If the element parameter is a number, then the priority parameter is set to the value of element. If the element parameter is not a number, then the
Returns Heap<T>
The offer method returns the instance of the Heap class.

Throws
if priority is not a valid number
- Defined in src/data-structures/heap/heap.ts:71

peek

peek(): null | HeapItem<T>
The peek function returns the top item in the priority queue without removing it.

Returns null | HeapItem<T>
The peek() method is returning either a HeapItem<T> object or null.Returns an element with the highest priority in the queue
- Defined in src/data-structures/heap/heap.ts:49

peekLast

peekLast(): null | HeapItem<T>
The peekLast function returns the last item in the heap.

Returns null | HeapItem<T>
The method peekLast() returns either a HeapItem<T> object or null.Returns an element with the lowest priority in the queue
- Defined in src/data-structures/heap/heap.ts:57

poll

poll(): null | HeapItem<T>
The poll function returns the top item from a priority queue or null if the queue is empty.Removes and returns an element with the highest priority in the queue

Returns null | HeapItem<T>
either a HeapItem object or null.
- Defined in src/data-structures/heap/heap.ts:100

toArray

toArray(): HeapItem<T>[]
The toArray function returns an array of HeapItem<T> objects.

Returns HeapItem<T>[]
An array of HeapItem objects.Returns a sorted list of elements
- Defined in src/data-structures/heap/heap.ts:112

Generated using TypeDoc