API Docs for: 0.1.21
Show:

Heap Class

Defined in: Datastructures/Heap.ts:1

The Heap class provides the main functionality of a Heap.

Methods

_child

(
  • n
)
private

Defined in Datastructures/Heap.ts:53

Get index of left child element in binary tree stored in array

Parameters:

  • n Object

Returns:

number

_displayNode

(
  • node
  • prefix
  • last
)
private

Defined in Datastructures/Heap.ts:294

Visually display heap tree

Parameters:

  • node Object
  • prefix Object
  • last Object

Returns:

String

_parent

(
  • n
)
private

Defined in Datastructures/Heap.ts:65

Get index of parent element in binary tree stored in array

Parameters:

  • n Object

Returns:

number

_siftDown

(
  • i
)
private

Defined in Datastructures/Heap.ts:110

Sift down elements in binary tree

Parameters:

  • i Object

_siftUp

(
  • i
)
private

Defined in Datastructures/Heap.ts:91

Sift elements in binary tree

Parameters:

  • i Object

_swap

(
  • first
  • second
)
private

Defined in Datastructures/Heap.ts:77

Swap 2 elements in binary tree

Parameters:

  • first Object
  • second Object

compare

(
  • first
  • second
)

Defined in Datastructures/Heap.ts:275

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 first is greater than second, 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

()

Defined in Datastructures/Heap.ts:195

Counts the number of elements in the heap

Returns:

number the number of elements in the heap.

current

()

Defined in Datastructures/Heap.ts:225

Return current node pointed by the iterator

Returns:

any The current node value.

extract

()

Defined in Datastructures/Heap.ts:146

Extracts a node from top of the heap and sift up

Returns:

any The value of the extracted node.

insert

(
  • value
)

Defined in Datastructures/Heap.ts:169

Inserts an element in the heap by sifting it up

Parameters:

  • value Object

    The value to insert.

Returns:

void

isEmpty

()

Defined in Datastructures/Heap.ts:205

Checks whether the heap is empty

Returns:

boolean whether the heap is empty.

key

()

Defined in Datastructures/Heap.ts:235

Return current node index

Returns:

any The current node index.

next

()

Defined in Datastructures/Heap.ts:245

Move to the next node

Returns:

void

prev

()

Defined in Datastructures/Heap.ts:255

Move to previous entry

Returns:

void

rewind

()

Defined in Datastructures/Heap.ts:215

Rewind iterator back to the start (no-op)

Returns:

void

toArray

()

Defined in Datastructures/Heap.ts:343

Serializes the heap to array

Returns:

Array The serialized array.

top

()

Defined in Datastructures/Heap.ts:181

Peeks at the node from the top of the heap

Returns:

any The value of the node on the top.

toString

()

Defined in Datastructures/Heap.ts:332

Serializes the heap to string

Returns:

string The serialized string.

valid

()

Defined in Datastructures/Heap.ts:265

Check whether the heap contains more nodes

Returns:

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

Properties

_key

Number private

Defined in Datastructures/Heap.ts:44

Iteration pointer

_tree

Array private

Defined in Datastructures/Heap.ts:26

Binary tree storage array

_type

Number private

Defined in Datastructures/Heap.ts:35

Heap type

MAX

Number static

Defined in Datastructures/Heap.ts:8

Max heap flag

MIN

Number static

Defined in Datastructures/Heap.ts:17

Min heap flag