API Docs for: 0.0.4
Show:

MinHeap Class

Extends Heap
Defined in: Datastructures/MinHeap.ts:4

The MinHeap class provides the main functionality of a heap, keeping the minimum on the top.

Methods

_child

(
  • n
)
private

Inherited from Heap: Datastructures/Heap.ts:28

Parameters:

  • n Object

Returns:

number

_displayNode

(
  • node
  • prefix
  • last
)
private

Inherited from Heap: Datastructures/Heap.ts:205

Parameters:

  • node Object
  • prefix Object
  • last Object

Returns:

String

_parent

(
  • n
)
private

Inherited from Heap: Datastructures/Heap.ts:17

Parameters:

  • n Object

Returns:

number

compare

(
  • first
  • second
)

Inherited from Heap: Datastructures/Heap.ts:192

Compare elements in order to place them correctly in the heap while sifting up.

Parameters:

  • first Object

    The value of the first node being compared.

  • second Object

    The value of the second node being compared.

Returns:

number Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise. Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.

count

()

Inherited from Heap: Datastructures/Heap.ts:117

Counts the number of elements in the heap

Returns:

number the number of elements in the heap.

current

()

Inherited from Heap: Datastructures/Heap.ts:146

Return current node pointed by the iterator

Returns:

any The current node value.

extract

()

Inherited from Heap: Datastructures/Heap.ts:83

Extracts a node from top of the heap and sift up

Returns:

any The value of the extracted node.

insert

(
  • value
)

Inherited from Heap: Datastructures/Heap.ts:95

Inserts an element in the heap by sifting it up

Parameters:

  • value Object

    The value to insert.

Returns:

void

isEmpty

()

Inherited from Heap: Datastructures/Heap.ts:127

Checks whether the heap is empty

Returns:

boolean whether the heap is empty.

key

()

Inherited from Heap: Datastructures/Heap.ts:155

Return current node index

Returns:

any The current node index.

next

()

Inherited from Heap: Datastructures/Heap.ts:164

Move to the next node

Returns:

void

recoverFromCorruption

()

Inherited from Heap: Datastructures/Heap.ts:183

Recover from the corrupted state and allow further actions on the heap.

Returns:

void

rewind

()

Inherited from Heap: Datastructures/Heap.ts:137

Rewind iterator back to the start (no-op)

Returns:

void

shiftDown

(
  • i
)
private

Inherited from Heap: Datastructures/Heap.ts:61

Parameters:

  • i Object

shiftUp

(
  • i
)
private

Inherited from Heap: Datastructures/Heap.ts:39

Parameters:

  • i Object

top

()

Inherited from Heap: Datastructures/Heap.ts:107

Peeks at the node from the top of the heap

Returns:

any The value of the node on the top.

toString

()

Inherited from Heap: Datastructures/Heap.ts:234

Serializes the heap to string

Returns:

string The serialized string.

valid

()

Inherited from Heap: Datastructures/Heap.ts:173

Check whether the heap contains more nodes

Returns:

boolean true if the heap contains any more nodes, false otherwise.

Properties

_tree

Array private

Inherited from Heap: Datastructures/Heap.ts:8

Binary tree storage array