Class Heap<T>

container interface

Remarks

Describes the methods and properties that all containers have

Type Parameters

Hierarchy

Basic<T>
- Heap

Implements

Container<T>

Index

Constructors

constructor

new Heap<T>(opts?: Options<T>, heap?: T[]): Heap<T>
Type Parameters
- T
Parameters
- Optional opts: Options<T>
- Optional heap: T[]
Returns Heap<T>
Overrides Basic.constructor
- Defined in src/container/heap.ts:214

Properties

`Private` `Readonly` h_

h_: T[]

array heap

`Protected` opts_

opts_: undefined | Options<T>

Accessors

capacity

get capacity(): number
returns the capacity of the heap

Returns number
Implementation of Container.capacity

Overrides Basic.capacity
- Defined in src/container/heap.ts:175

heap

get heap(): T[]
Returns an array of underlying storage

Returns T[]
- Defined in src/container/heap.ts:161

isEmpty

get isEmpty(): boolean
Returns true if there is no data in the container

Returns boolean
Implementation of Container.isEmpty

Inherited from Basic.isEmpty
- Defined in src/container/types.ts:135

isFull

get isFull(): boolean
Returns true if the container has reached the container limit

Returns boolean
Implementation of Container.isFull

Inherited from Basic.isFull
- Defined in src/container/types.ts:151

isNotEmpty

get isNotEmpty(): boolean
Returns true if there is data in the container

Returns boolean
Implementation of Container.isNotEmpty

Inherited from Basic.isNotEmpty
- Defined in src/container/types.ts:143

isNotFull

get isNotFull(): boolean
Returns true if the container has not reached the container limit

Returns boolean
Implementation of Container.isNotFull

Inherited from Basic.isNotFull
- Defined in src/container/types.ts:159

length

get length(): number
returns the length of the heap

Returns number
Implementation of Container.length

Overrides Basic.length
- Defined in src/container/heap.ts:168

reverse

get reverse(): Iterable<T>
Sealed
Returns an object that implements a js Iterable, but it traverses the data in reverse

Returns Iterable<T>
Implementation of Container.reverse

Inherited from Basic.reverse
- Defined in src/container/types.ts:215

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
implements js Iterable

Sealedl

Returns Iterator<T, any, undefined>
Implementation of Container.[iterator]

Inherited from Basic.[iterator]
- Defined in src/container/types.ts:208

clear

clear(callback?: DeleteCallback<T>): void
Empty the data in the container
Parameters
- Optional callback: DeleteCallback<T>
  
  Call callback on the removed element
Returns void
Implementation of Container.clear
- Defined in src/container/heap.ts:262

clone

clone(callback?: CloneCallback<T>): Heap<T>
Create a full copy of the container
Parameters
- Optional callback: CloneCallback<T>
  
  How to create a duplicate copy of an element
Returns Heap<T>
Implementation of Container.clone
- Defined in src/container/heap.ts:309

compareTo

compareTo(o: Container<T>, callback?: CompareCallback<T>): number
Returns true if the data depth of the two containers is consistent
Parameters
- o: Container<T>
- Optional callback: CompareCallback<T>
Returns number
Implementation of Container.compareTo

Inherited from Basic.compareTo
- Defined in src/container/types.ts:181

find

find(callback: ValidCallback<T>, reverse?: boolean): boolean
Traverse the container looking for elements until the callback returns true, then stop looking

Returns
whether the element was found
Parameters
- callback: ValidCallback<T>
  
  Determine whether it is the element to be found
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns boolean
Implementation of Container.find

Inherited from Basic.find
- Defined in src/internal/decorator.ts:50

fix

fix(i: number): void
Fix re-establishes the heap ordering after the element at index i has changed its value.
Parameters
- i: number
Returns void
- Defined in src/container/heap.ts:151

forEach

forEach(callback: ValueCallback<T>, reverse?: boolean): void
call callback on each element in the container in turn
Parameters
- callback: ValueCallback<T>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns void
Implementation of Container.forEach

Inherited from Basic.forEach
- Defined in src/internal/decorator.ts:36

get

get(i: number): T
get heap array element

Throws
TypeError

Throws
RangeError
Parameters
- i: number
Returns T
- Defined in src/container/heap.ts:183

has

has(data: T, reverse?: boolean, callback?: CompareCallback<T>): boolean
Returns whether the data data exists in the container
Parameters
- data: T
- Optional reverse: boolean
- Optional callback: CompareCallback<T>
Returns boolean
Implementation of Container.has

Inherited from Basic.has
- Defined in src/internal/decorator.ts:60

heapify

heapify(): void
Initialize array to heap

Returns void
- Defined in src/container/heap.ts:145

iterator

iterator(reverse?: boolean): Iterator<T, any, undefined>
return js iterator
Parameters
- Optional reverse: boolean
  
  If true, returns an iterator to traverse in reverse
Returns Iterator<T, any, undefined>
Implementation of Container.iterator

Overrides Basic.iterator
- Defined in src/container/heap.ts:276

join

join<TO>(separator?: string, callback?: MapCallback<T, TO>, reverse?: boolean): string
Adds all the elements of an container into a string, separated by the specified separator string.
Type Parameters
- TO
Parameters
- Optional separator: string
  
  A string used to separate one element of the container from the next in the resulting string. If omitted, the array elements are separated with a comma.
- Optional callback: MapCallback<T, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns string
Implementation of Container.join

Inherited from Basic.join
- Defined in src/internal/decorator.ts:83

map

map<TO>(callback: MapCallback<T, TO>, reverse?: boolean): TO[]
Convert container to array
Type Parameters
- TO
Parameters
- callback: MapCallback<T, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns TO[]
Implementation of Container.map

Inherited from Basic.map
- Defined in src/internal/decorator.ts:72

pop

pop(): ReturnValue<T>
Pop removes and returns the minimum element (according opts.compare cf or <) from the heap.

Returns ReturnValue<T>
- Defined in src/container/heap.ts:238

popRaw

popRaw(): ReturnValueRaw<T>
Pop removes and returns the minimum element (according opts.compare cf or <) from the heap.

Returns ReturnValueRaw<T>
- Defined in src/container/heap.ts:244

push

push(...vals: T[]): void
Push pushes the element vals onto the heap.
Parameters
- Rest ...vals: T[]
Returns void
- Defined in src/container/heap.ts:225

pushList

pushList(vals: Iterable<T>, callback?: CloneCallback<T>): void
inserts a copy of another container of heap.
Parameters
- vals: Iterable<T>
- Optional callback: CloneCallback<T>
Returns void
- Defined in src/container/heap.ts:322

remove

remove(i: number): T
Remove removes and returns the element at index i from the heap.

Throws
TypeError

Throws
RangeError
Parameters
- i: number
Returns T
- Defined in src/container/heap.ts:253

set

set(i: number, val: T): void
set heap array element

Throws
TypeError

Throws
RangeError
Parameters
- i: number
- val: T
Returns void
- Defined in src/container/heap.ts:198

Class Heap<T>

Remarks

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

Optional opts: Options<T>

Optional heap: T[]

Returns Heap<T>

Properties

Private Readonly h_

Protected opts_

Accessors

capacity

Returns number

heap

Returns T[]

isEmpty

Returns boolean

isFull

Returns boolean

isNotEmpty

Returns boolean

isNotFull

Returns boolean

length

Returns number

reverse

Returns Iterable<T>

Methods

[iterator]

Sealedl

Returns Iterator<T, any, undefined>

clear

Parameters

Optional callback: DeleteCallback<T>

Returns void

clone

Parameters

Optional callback: CloneCallback<T>

Returns Heap<T>

compareTo

Parameters

o: Container<T>

Optional callback: CompareCallback<T>

Returns number

find

Returns

Parameters

callback: ValidCallback<T>

Optional reverse: boolean

Returns boolean

fix

Parameters

i: number

Returns void

forEach

Parameters

callback: ValueCallback<T>

Optional reverse: boolean

Returns void

get

Throws

Throws

Parameters

i: number

Returns T

has

Parameters

data: T

`Optional` opts: Options<T>

`Optional` heap: T[]

`Private` `Readonly` h_

`Protected` opts_

`Optional` callback: DeleteCallback<T>

`Optional` callback: CloneCallback<T>

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` separator: string

`Optional` callback: MapCallback<T, TO>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Rest` ...vals: T[]

`Optional` callback: CloneCallback<T>