-
diff --git a/docs/classes/HeapAsync.html b/docs/classes/HeapAsync.html
index dc0a670..f5dcf8d 100644
--- a/docs/classes/HeapAsync.html
+++ b/docs/classes/HeapAsync.html
@@ -1,1501 +1,240 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-heap
-
-
-
-
-
-
-remove
-
-
-
-
-
-
-
-
-
-
-_apply
-
-
-_bottom
-
-
-_inverted
-
-
-_move
-
-
-_sort
-
-
-_sort
-
-
-_top
-
-
-_top
- to
to
-
-
-Class Heap<T>
Type Parameters
--
-
-
-
T
Hierarchy
--
-
- Heap
Implements
--
-
- Iterable<T>
- Index
-
-
-
-
-
-
-
-
-
Constructors
-Properties
-Accessors
-Methods
-[iterator]
-_apply
Constructors
-constructor
--
-
- new
Heap<T>(compare?): Heap<T>
- -
--
Heap instance constructor.
-- -Type Parameters
--
-
-
-
T
--Parameters
--
-
-
-
compare: Comparator<T> = Heap.minComparator
--Optional comparison function, defaults to Heap.minComparator
-
Returns Heap<T>
- -
-
Properties
-_limit
-_limit: number = 0
compare
- -Optional comparison function, defaults to Heap.minComparator
element
-element: (() => undefined | T) = ...
-
-
Type declaration
--
-
-
-
-
-
- (): undefined | T -
-
--
Alias of __type
-Returns undefined | T
--See
peek
-
heap
-heap
offer
-offer: ((element) => boolean) = ...
-
-
Type declaration
--
-
-
-
-
-
- (element): boolean -
-
--
Alias of __type
---Parameters
--
-
-
-
element: T
Returns boolean
--See
add
- -
-
poll
-poll: (() => undefined | T) = ...
-
-
Type declaration
--
-
-
-
-
-
- (): undefined | T -
-
--
Alias of __type
-Returns undefined | T
--See
pop
-
remove
-remove
-
-
Type declaration
--
-
-
-
-
-
- (): void -
-
--
Alias of __type
-Returns void
--See
clear
-
Accessors
-length
--
-
- get length(): number -
-
--
Length of the heap. Aliases: size.
-Returns number
--See
size
-
limit
--
-
- get limit(): number -
-
-
-
Returns number
--See
setLimit
-
- - set limit(_l): void -
-
--
Set length limit of the heap. Same as using setLimit.
---Parameters
--
-
-
-
_l: number
--Limit, defaults to 0 (no limit). Negative, Infinity, or NaN values set the limit to 0.
-
Returns void
--Description
If the heap is longer than the limit, the needed amount of leafs are removed.
- -See
setLimit
- -
-
Methods
-[iterator]
-_apply
-_bottom
-_inverted
-_move
-_sort
-_sort
-_top
-_top
--
-
- _top
N_ fill(n): T[]
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
Heap | heap-js --Class Heap<T>
Heap
+Type Parameters
Implements
- Iterable<T>
Index
Constructors
Properties
Accessors
Methods
_applyLimit +_bottom N_ push +_inverted Compare +_move Node +_sort Node Down +_sort Node Up +_top Idx Of +_top N_ fill +_top N_ heap +_top N_ push +_top Of +[iterator] +add +add All +bottom +check +clear +clone +comparator +contains +get +get Children Of +get Parent Of +index Of +index Of Every +init +is Empty +iterator +leafs +peek +pop +push +pushpop +remove +replace +set Limit +size +to Array +top +to String +default Is Equal +get Children Index Of +get Parent Index Of +get Sibling Index Of +heapbottom +heapify +heappop +heappush +heappushpop +heapreplace +heaptop +max Comparator +max Comparator Number +min Comparator +min Comparator Number +nlargest +nsmallest +print + Constructors
constructor
- new Heap<T>(compare?: Comparator<T>): Heap<T>
Heap instance constructor.
+Type Parameters
Parameters
- compare: Comparator<T> = Heap.minComparator
Optional comparison function, defaults to Heap.minComparator
+
Returns Heap<T>
- compare: Comparator<T> = Heap.minComparator
Properties
_limit
_limit: number = 0compare
Optional comparison function, defaults to Heap.minComparator
+element
Alias of peek
+Type declaration
heap
Array offer
Alias of add
+Type declaration
poll
Alias of pop
+Type declaration
remove
All removeAll: () => void = ...Alias of clear
+Type declaration
- (): void
Remove all of the elements from this heap.
+Returns void
Accessors
length
- get length(): number
Length of the heap. Aliases: size.
+Returns number
limit
- get limit(): number
Returns number
- set limit(_l: number): void
Set length limit of the heap. Same as using setLimit.
+Parameters
- _l: number
Limit, defaults to 0 (no limit). Negative, Infinity, or NaN values set the limit to 0.
+
Returns void
- _l: number
Methods
_apply
Limit _bottom
N_ push _inverted
Compare _move
Node _sort
Node Down _sort
Node Up _top
Idx Of _top
N_ fill - _topN_fill(n: number): T[]
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: init + push.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns T[]
Array of length <= N.
- - -
-
- _top
-N_ heap -
-
- _top
N_ heap(n): T[]
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
Parameters
- n: number
Number of elements.
+
Returns T[]
Array of length <= N.
+ - n: number
_top
N_ heap - _topN_heap(n: number): T[]
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: heap.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns T[]
Array of length <= N.
- - -
-
- _top
-N_ push -
-
- _top
N_ push(n): T[]
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
Parameters
- n: number
Number of elements.
+
Returns T[]
Array of length <= N.
+ - n: number
_top
N_ push - _topN_push(n: number): T[]
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: push.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns T[]
Array of length <= N.
- - -
-
- -_top
-Of - add
-_top
Of [iterator]
add
- add(element: T): boolean
-
---
Parameters
--
-
-
-
element: T
--Element to be added
-
Returns boolean
true
- - -
-
- add
-All -
-
- add
All(elements): boolean
- -
-
Adds an array of elements to the heap. +
Parameters
- element: T
Element to be added
+
Returns boolean
true
+ - element: T
add
All - -bottom
-- -check
-- -clear
-- -clone
-- -comparator
--
-
- comparator(): Comparator<T> -
-
--
Returns the comparison function.
-Returns Comparator<T>
-
- -contains
--
-
- contains(o, callbackFn?): boolean -
-
--
Returns true if this queue contains the specified element.
---Parameters
--
-
-
-
o: T
--Element to be found
-
- -
-
callbackFn: IsEqual<T> = Heap.defaultIsEqual
--Optional comparison function, receives (element, needle)
-
Returns boolean
- -
-
- -get
-- -get
-Children Of - -get
-Parent Of - -index
-Of -
-
- index
Of(element, callbackFn?): number
- -
--
Get the index of the first occurrence of the element in the heap (using the comparator).
---Parameters
--
-
-
-
element: T
--Element to be found
-
- -
-
callbackFn: IsEqual<T> = Heap.defaultIsEqual
--Optional comparison function, receives (element, needle)
-
Returns number
Index or -1 if not found
- - -
-
- -index
-Of Every -
-
- index
Of Every(element, callbackFn?): number[]
- -
--
Get the indexes of the every occurrence of the element in the heap (using the comparator).
---Parameters
--
-
-
-
element: T
--Element to be found
-
- -
-
callbackFn: IsEqual<T> = Heap.defaultIsEqual
--Optional comparison function, receives (element, needle)
-
Returns number[]
Array of indexes or empty array if not found
- - -
-
- -init
-- -is
-Empty - -iterator
-- leafs
--
-
- leafs(): T[] -
-
--
Get the leafs of the tree (no children nodes). -See also: getChildrenOf and bottom.
-Returns T[]
--See
-
+
Parameters
- elements: T[]
Elements to be added
+
Returns boolean
true
+ - elements: T[]
bottom
check
clear
clone
comparator
- comparator(): Comparator<T>
Returns the comparison function.
+Returns Comparator<T>
contains
get
get
Children Of get
Parent Of index
Of index
Of Every init
is
Empty iterator
leafs
- leafs(): T[]
Get the leafs of the tree (no children nodes). +See also: getChildrenOf and bottom.
+Returns T[]
-- peek
--
-
- peek(): undefined | T -
-
-
Top node. Aliases: element. +
peek
- peek(): undefined | T
-
-
Returns undefined | T
Top node
- --See
top
-
- -pop
--
-
- pop(): undefined | T -
-
--
Extract the top node (root). Aliases: poll.
-Returns undefined | T
Extracted top node, undefined if empty
- -
- -push
-- -pushpop
-- -remove
--
-
- remove(o?, callbackFn?): boolean -
-
--
Remove the first occurrence of an element from the heap.
---Parameters
--
-
-
-
-Optionalo: T-Element to be found
-
- -
-
callbackFn: IsEqual<T> = Heap.defaultIsEqual
--Optional equality function, receives (element, needle)
-
Returns boolean
True if the heap was modified
- - -
-
- -replace
-- set
-Limit -
-
- set
Limit(_l): number
- -
-
Set length limit of the heap. +
Returns undefined | T
Top node
+
pop
push
pushpop
remove
replace
set
Limit - setLimit(_l: number): number
- -
Set length limit of the heap. Same as assigning to limit but returns NaN if the value was invalid.
---Parameters
--
-
-
-
_l: number
--Limit. Negative, Infinity, or NaN values set the limit to 0.
-
Returns number
The limit or NaN if the value was negative, or NaN.
- --See
limit
- -
-
- -size
-- -to
-Array - -to
-String - -top
-- -
-StaticdefaultIs Equal - -
-StaticgetChildren Index Of - -
-StaticgetParent Index Of - -
-StaticgetSibling Index Of - -
-Staticheapbottom-
-
- heapbottom<N>(heapArr, n?, compare?): N[] -
-
--
Return the
-nleast valuable elements of a heap-like Array- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array, should be an array-heap
-
- -
-
n: number = 1
--Max number of elements
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N[]
Elements
- - -
-
- -
-Staticheapify-
-
- heapify<N>(arr, compare?): Heap<N> -
-
--
Converts an array into an array-heap, in place
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
arr: N[]
--Array to be modified
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns Heap<N>
For convenience, it returns a Heap instance
- - -
-
- -
-Staticheappop-
-
- heappop<N>(heapArr, compare?): undefined | N -
-
--
Extract the peek of an array-heap
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns undefined | N
Returns the extracted peek
- - -
-
- -
-Staticheappush-
-
- heappush<N>(heapArr, item, compare?): void -
-
--
Pushes a item into an array-heap
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item to push
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns void
- -
-
- -
-Staticheappushpop-
-
- heappushpop<N>(heapArr, item, compare?): N -
-
--
Push followed by pop, faster
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item to push
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N
Returns the extracted peek
- - -
-
- -
-Staticheapreplace-
-
- heapreplace<N>(heapArr, item, compare?): N -
-
--
Replace peek with item
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item as replacement
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N
Returns the extracted peek
- - -
-
- -
-Staticheaptop-
-
- heaptop<N>(heapArr, n?, compare?): N[] -
-
--
Return the
-nmost valuable elements of a heap-like Array- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array, should be an array-heap
-
- -
-
n: number = 1
--Max number of elements
-
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N[]
Elements
- - -
-
- -
-StaticmaxComparator - -
-StaticmaxComparator Number - -
-StaticminComparator - -
-StaticminComparator Number - -
-Staticnlargest-
-
- nlargest<N>(n, iterable, compare?): N[] -
-
--
Return the
-nmost valuable elements of an iterable- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
n: number
--Max number of elements
-
- -
-
iterable: Iterable<N>
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N[]
Elements
- - -
-
- -
-Staticnsmallest-
-
- nsmallest<N>(n, iterable, compare?): N[] -
-
--
Return the
-nleast valuable elements of an iterable- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
n: number
--Max number of elements
-
- -
-
iterable: Iterable<N>
- -
-
-Optionalcompare: Comparator<N>-Optional compare function
-
Returns N[]
Elements
- - -
-
-
-Staticprint-
-
- print<N>(heap): string -
-
--
Prints a heap.
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heap: Heap<N>
--Heap to be printed
-
Returns string
- -
-
-- \ No newline at end of file +Generated using TypeDoc
Parameters
- _l: number
Limit. Negative, Infinity, or NaN values set the limit to 0.
+
Returns number
The limit or NaN if the value was negative, or NaN.
+
size
to
top
to
Staticdefault
Staticget
Staticget
Staticget
Staticheapbottom
- heapbottom<N>(heapArr: N[], n?: number, compare?: Comparator<N>): N[]
Return the
+nleast valuable elements of a heap-like ArrayType Parameters
Parameters
- heapArr: N[]
Array, should be an array-heap
+ - n: number = 1
Max number of elements
+ Optionalcompare: Comparator<N>Optional compare function
+
Returns N[]
Elements
+- heapArr: N[]
Staticheapify
Staticheappop
- heappop<N>(heapArr: N[], compare?: Comparator<N>): undefined | N
Extract the peek of an array-heap
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ Optionalcompare: Comparator<N>Optional compare function
+
Returns undefined | N
Returns the extracted peek
+- heapArr: N[]
Staticheappush
- heappush<N>(heapArr: N[], item: N, compare?: Comparator<N>): void
Pushes a item into an array-heap
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ - item: N
Item to push
+ Optionalcompare: Comparator<N>Optional compare function
+
Returns void
- heapArr: N[]
Staticheappushpop
Staticheapreplace
Staticheaptop
- heaptop<N>(heapArr: N[], n?: number, compare?: Comparator<N>): N[]
Return the
+nmost valuable elements of a heap-like ArrayType Parameters
Parameters
- heapArr: N[]
Array, should be an array-heap
+ - n: number = 1
Max number of elements
+ Optionalcompare: Comparator<N>Optional compare function
+
Returns N[]
Elements
+- heapArr: N[]
Staticmax
Staticmax
Staticmin
Staticmin
Staticnlargest
- nlargest<N>(n: number, iterable: Iterable<N>, compare?: Comparator<N>): N[]
Return the
+nmost valuable elements of an iterableType Parameters
Parameters
- n: number
Max number of elements
+ - iterable: Iterable<N>
Optionalcompare: Comparator<N>Optional compare function
+
Returns N[]
Elements
+- n: number
Staticnsmallest
- nsmallest<N>(n: number, iterable: Iterable<N>, compare?: Comparator<N>): N[]
Return the
+nleast valuable elements of an iterableType Parameters
Parameters
- n: number
Max number of elements
+ - iterable: Iterable<N>
Optionalcompare: Comparator<N>Optional compare function
+
Returns N[]
Elements
+- n: number
Staticprint
-
diff --git a/docs/functions/toInt.html b/docs/functions/toInt.html
index 4d76be1..2a6f0ec 100644
--- a/docs/functions/toInt.html
+++ b/docs/functions/toInt.html
@@ -1,58 +1 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-heap
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-_apply
-
-
-_bottom
-
-
-_inverted
-
-
-_move
-
-
-_sort
-
-
-_sort
-
-
-_top
-
-
-_top
- to
to
-
-
-Class HeapAsync<T>
Heap
-Type Parameters
--
-
-
-
T
Hierarchy
--
-
- HeapAsync
Implements
--
-
- Iterable<Promise<T>>
- Index
-
-
-
-
-
-
-
-
-
Constructors
-Properties
-Accessors
-Methods
-[iterator]
-_apply
Constructors
-constructor
--
-
- new
Heap Async<T>(compare?): HeapAsync<T>
- -
--
Heap instance constructor.
-- -Type Parameters
--
-
-
-
T
--Parameters
--
-
-
-
compare: AsyncComparator<T> = HeapAsync.minComparator
--Optional comparison function, defaults to Heap.minComparator
-
Returns HeapAsync<T>
- -
-
Properties
-_limit
-_limit: number = 0
compare
- -Optional comparison function, defaults to Heap.minComparator
element
-element: (() => undefined | T) = ...
-
-
Type declaration
--
-
-
-
-
-
- (): undefined | T -
-
--
Alias of peek
-Returns undefined | T
-
heap
-heap
offer
-offer: ((element) => Promise<boolean>) = ...
-
-
Type declaration
--
-
-
-
-
-
- (element): Promise<boolean> -
-
--
Alias of add
---Parameters
--
-
-
-
element: T
Returns Promise<boolean>
- -
-
poll
-poll: (() => Promise<undefined | T>) = ...
-
-
Type declaration
--
-
-
-
-
-
- (): Promise<undefined | T> -
-
--
Alias of pop
-Returns Promise<undefined | T>
-
Accessors
-length
--
-
- get length(): number -
-
--
Length of the heap.
-Returns number
-
limit
--
-
- get limit(): number -
-
--
Get length limit of the heap.
-Returns number
-
- - set limit(_l): void -
-
--
Set length limit of the heap.
---Parameters
--
-
-
-
_l: number
Returns void
- -
-
Methods
-[iterator]
-_apply
-_bottom
-_inverted
-_move
-_sort
-_sort
-_top
-_top
--
-
- _top
N_ fill(n): Promise<T[]>
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
HeapAsync | heap-js --Class HeapAsync<T>
Heap
+Type Parameters
Implements
- Iterable<Promise<T>>
Index
Constructors
Properties
Accessors
Methods
_applyLimit +_bottom N_ push +_inverted Compare +_move Node +_sort Node Down +_sort Node Up +_top Idx Of +_top N_ fill +_top N_ heap +_top N_ push +_top Of +[iterator] +add +add All +bottom +check +clear +clone +comparator +contains +get +get Children Of +get Parent Of +init +is Empty +iterator +leafs +peek +pop +push +pushpop +remove +replace +size +to Array +top +to String +default Is Equal +get Children Index Of +get Parent Index Of +get Sibling Index Of +heapbottom +heapify +heappop +heappush +heappushpop +heapreplace +heaptop +max Comparator +max Comparator Number +min Comparator +min Comparator Number +nlargest +nsmallest +print + Constructors
constructor
- new HeapAsync<T>(compare?: AsyncComparator<T>): HeapAsync<T>
Heap instance constructor.
+Type Parameters
Parameters
- compare: AsyncComparator<T> = HeapAsync.minComparator
Optional comparison function, defaults to Heap.minComparator
+
Returns HeapAsync<T>
- compare: AsyncComparator<T> = HeapAsync.minComparator
Properties
_limit
_limit: number = 0compare
Optional comparison function, defaults to Heap.minComparator
+element
Alias of peek
+heap
Array offer
Alias of add
+poll
Alias of pop
+Accessors
length
- get length(): number
Length of the heap.
+Returns number
limit
- get limit(): number
Get length limit of the heap.
+Returns number
- set limit(_l: number): void
Set length limit of the heap.
+Parameters
- _l: number
Returns void
Methods
_apply
Limit _bottom
N_ push _inverted
Compare _move
Node _sort
Node Down _sort
Node Up _top
Idx Of _top
N_ fill - _topN_fill(n: number): Promise<T[]>
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: init + push.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns Promise<T[]>
Array of length <= N.
- - -
-
- _top
-N_ heap -
-
- _top
N_ heap(n): Promise<T[]>
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
Parameters
- n: number
Number of elements.
+
Returns Promise<T[]>
Array of length <= N.
+ - n: number
_top
N_ heap - _topN_heap(n: number): Promise<T[]>
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: heap.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns Promise<T[]>
Array of length <= N.
- - -
-
- _top
-N_ push -
-
- _top
N_ push(n): Promise<T[]>
- -
-
Return the top (highest value) N elements of the heap, without corner cases, unsorted +
Parameters
- n: number
Number of elements.
+
Returns Promise<T[]>
Array of length <= N.
+ - n: number
_top
N_ push - _topN_push(n: number): Promise<T[]>
- -
Return the top (highest value) N elements of the heap, without corner cases, unsorted Implementation: push.
---Parameters
--
-
-
-
n: number
--Number of elements.
-
Returns Promise<T[]>
Array of length <= N.
- - -
-
- -_top
-Of - add
--
-
- add(element): Promise<boolean> -
-
-
Adds an element to the heap. Aliases:
offer. +Parameters
- n: number
Number of elements.
+
Returns Promise<T[]>
Array of length <= N.
+ - n: number
_top
Of [iterator]
add
- add(element: T): Promise<boolean>
- -
Adds an element to the heap. Aliases:
-offer. Same as: push(element)--Parameters
--
-
-
-
element: T
--Element to be added
-
Returns Promise<boolean>
true
- - -
-
- add
-All -
-
- add
All(elements): Promise<boolean>
- -
-
Adds an array of elements to the heap. +
Parameters
- element: T
Element to be added
+
Returns Promise<boolean>
true
+ - element: T
add
All - addAll(elements: T[]): Promise<boolean>
- -
Adds an array of elements to the heap. Similar as: push(element, element, ...).
---Parameters
--
-
-
-
elements: T[]
--Elements to be added
-
Returns Promise<boolean>
true
- - -
-
- -bottom
-- -check
-- -clear
-- -clone
-- -comparator
--
-
- comparator(): AsyncComparator<T> -
-
--
Returns the comparison function.
-Returns AsyncComparator<T>
-
- -contains
--
-
- contains(o, fn?): Promise<boolean> -
-
--
Returns true if this queue contains the specified element.
---Parameters
--
-
-
-
o: T
--Element to be found
-
- -
-
fn: AsyncIsEqual<T> = HeapAsync.defaultIsEqual
--Optional comparison function, receives (element, needle)
-
Returns Promise<boolean>
- -
-
- -get
-- -get
-Children Of - -get
-Parent Of - -init
-- -is
-Empty - -iterator
-- -leafs
-- peek
--
-
- peek(): undefined | T -
-
-
Top node. Aliases:
element. +Parameters
- elements: T[]
Elements to be added
+
Returns Promise<boolean>
true
+ - elements: T[]
bottom
check
clear
clone
comparator
- comparator(): AsyncComparator<T>
Returns the comparison function.
+Returns AsyncComparator<T>
contains
- contains(o: T, fn?: AsyncIsEqual<T>): Promise<boolean>
Returns true if this queue contains the specified element.
+Parameters
- o: T
Element to be found
+ - fn: AsyncIsEqual<T> = HeapAsync.defaultIsEqual
Optional comparison function, receives (element, needle)
+
Returns Promise<boolean>
- o: T
get
get
Children Of get
Parent Of init
is
Empty iterator
leafs
peek
- peek(): undefined | T
- -
Top node. Aliases:
-element. Same as:top(1)[0]Returns undefined | T
Top node
- -
- -pop
-- -push
-- -pushpop
-- -remove
--
-
- remove(o?, fn?): Promise<boolean> -
-
--
Remove an element from the heap.
---Parameters
--
-
-
-
-Optionalo: T-Element to be found
-
- -
-
fn: AsyncIsEqual<T> = HeapAsync.defaultIsEqual
--Optional function to compare
-
Returns Promise<boolean>
True if the heap was modified
- - -
-
- -replace
-- -size
-- -to
-Array - -to
-String - -top
-- -
-StaticdefaultIs Equal - -
-StaticgetChildren Index Of - -
-StaticgetParent Index Of - -
-StaticgetSibling Index Of - -
-Staticheapbottom-
-
- heapbottom<N>(heapArr, n?, compare?): Promise<N[]> -
-
--
Return the
-nleast valuable elements of a heap-like Array- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array, should be an array-heap
-
- -
-
n: number = 1
--Max number of elements
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N[]>
Elements
- - -
-
- -
-Staticheapify-
-
- heapify<N>(arr, compare?): Promise<HeapAsync<N>> -
-
--
Converts an array into an array-heap, in place
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
arr: N[]
--Array to be modified
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<HeapAsync<N>>
For convenience, it returns a Heap instance
- - -
-
- -
-Staticheappop-
-
- heappop<N>(heapArr, compare?): Promise<undefined | N> -
-
--
Extract the peek of an array-heap
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<undefined | N>
Returns the extracted peek
- - -
-
- -
-Staticheappush-
-
- heappush<N>(heapArr, item, compare?): Promise<void> -
-
--
Pushes a item into an array-heap
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item to push
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<void>
- -
-
- -
-Staticheappushpop-
-
- heappushpop<N>(heapArr, item, compare?): Promise<N> -
-
--
Push followed by pop, faster
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item to push
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N>
Returns the extracted peek
- - -
-
- -
-Staticheapreplace-
-
- heapreplace<N>(heapArr, item, compare?): Promise<N> -
-
--
Replace peek with item
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array to be modified, should be a heap
-
- -
-
item: N
--Item as replacement
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N>
Returns the extracted peek
- - -
-
- -
-Staticheaptop-
-
- heaptop<N>(heapArr, n?, compare?): Promise<N[]> -
-
--
Return the
-nmost valuable elements of a heap-like Array- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heapArr: N[]
--Array, should be an array-heap
-
- -
-
n: number = 1
--Max number of elements
-
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N[]>
Elements
- - -
-
- -
-StaticmaxComparator - -
-StaticmaxComparator Number - -
-StaticminComparator - -
-StaticminComparator Number - -
-Staticnlargest-
-
- nlargest<N>(n, iterable, compare?): Promise<N[]> -
-
--
Return the
-nmost valuable elements of an iterable- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
n: number
--Max number of elements
-
- -
-
iterable: Iterable<N>
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N[]>
Elements
- - -
-
- -
-Staticnsmallest-
-
- nsmallest<N>(n, iterable, compare?): Promise<N[]> -
-
--
Return the
-nleast valuable elements of an iterable- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
n: number
--Max number of elements
-
- -
-
iterable: Iterable<N>
- -
-
-Optionalcompare: AsyncComparator<N>-Optional compare function
-
Returns Promise<N[]>
Elements
- - -
-
-
-Staticprint-
-
- print<N>(heap): string -
-
--
Prints a heap.
-- -Type Parameters
--
-
-
-
N
--Parameters
--
-
-
-
heap: HeapAsync<N>
--Heap to be printed
-
Returns string
- -
-
-- \ No newline at end of file +Generated using TypeDoc
Returns undefined | T
Top node
+
pop
push
pushpop
remove
- remove(o?: T, fn?: AsyncIsEqual<T>): Promise<boolean>
Remove an element from the heap.
+Parameters
Optionalo: TElement to be found
+- fn: AsyncIsEqual<T> = HeapAsync.defaultIsEqual
Optional function to compare
+
Returns Promise<boolean>
True if the heap was modified
+
replace
size
to
top
to
Staticdefault
Staticget
Staticget
Staticget
Staticheapbottom
- heapbottom<N>(
    heapArr: N[],
    n?: number,
    compare?: AsyncComparator<N>,
): Promise<N[]> Return the
+nleast valuable elements of a heap-like ArrayType Parameters
Parameters
- heapArr: N[]
Array, should be an array-heap
+ - n: number = 1
Max number of elements
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N[]>
Elements
+- heapArr: N[]
Staticheapify
- heapify<N>(arr: N[], compare?: AsyncComparator<N>): Promise<HeapAsync<N>>
Converts an array into an array-heap, in place
+Type Parameters
Parameters
- arr: N[]
Array to be modified
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<HeapAsync<N>>
For convenience, it returns a Heap instance
+- arr: N[]
Staticheappop
- heappop<N>(heapArr: N[], compare?: AsyncComparator<N>): Promise<undefined | N>
Extract the peek of an array-heap
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<undefined | N>
Returns the extracted peek
+- heapArr: N[]
Staticheappush
- heappush<N>(heapArr: N[], item: N, compare?: AsyncComparator<N>): Promise<void>
Pushes a item into an array-heap
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ - item: N
Item to push
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<void>
- heapArr: N[]
Staticheappushpop
- heappushpop<N>(heapArr: N[], item: N, compare?: AsyncComparator<N>): Promise<N>
Push followed by pop, faster
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ - item: N
Item to push
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N>
Returns the extracted peek
+- heapArr: N[]
Staticheapreplace
- heapreplace<N>(heapArr: N[], item: N, compare?: AsyncComparator<N>): Promise<N>
Replace peek with item
+Type Parameters
Parameters
- heapArr: N[]
Array to be modified, should be a heap
+ - item: N
Item as replacement
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N>
Returns the extracted peek
+- heapArr: N[]
Staticheaptop
- heaptop<N>(heapArr: N[], n?: number, compare?: AsyncComparator<N>): Promise<N[]>
Return the
+nmost valuable elements of a heap-like ArrayType Parameters
Parameters
- heapArr: N[]
Array, should be an array-heap
+ - n: number = 1
Max number of elements
+ Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N[]>
Elements
+- heapArr: N[]
Staticmax
Staticmax
Staticmin
Staticmin
Staticnlargest
- nlargest<N>(
    n: number,
    iterable: Iterable<N>,
    compare?: AsyncComparator<N>,
): Promise<N[]> Return the
+nmost valuable elements of an iterableType Parameters
Parameters
- n: number
Max number of elements
+ - iterable: Iterable<N>
Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N[]>
Elements
+- n: number
Staticnsmallest
- nsmallest<N>(
    n: number,
    iterable: Iterable<N>,
    compare?: AsyncComparator<N>,
): Promise<N[]> Return the
+nleast valuable elements of an iterableType Parameters
Parameters
- n: number
Max number of elements
+ - iterable: Iterable<N>
Optionalcompare: AsyncComparator<N>Optional compare function
+
Returns Promise<N[]>
Elements
+- n: number
Staticprint
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
heap-js
Auxiliary experimental
(WIP) Benchmarks.
-
Implements Java's
Implements static Python's
-
-heap-js
Heap.js
+
heap-js
Heap.js
Efficient Binary heap (priority queue, binary tree) data structure for JavaScript / TypeScript.
Now with support for async comparators with the new HeapAsync class!
Includes JavaScript methods, Python's heapq module methods, and Java's PriorityQueue methods.
+Includes JavaScript methods, Python's heapq module methods, and Java's PriorityQueue methods.
Easy to use, known interfaces, tested, and well-documented JavaScript binary heap library.
Instances are integer min heap by default.
Is it faster than sorting an array?
It depends on your usage, but for some scenarios, it is much faster:
+Is it faster than sorting an array?
It depends on your usage, but for some scenarios, it is much faster:
heap vs array: push + pop/unshift 50
heap x 72,130 ops/sec ±0.50% (93 runs sampled)
array x 121 ops/sec ±78.09% (5 runs sampled)
heap vs array: push + peek 20
heap x 622,332 ops/sec ±27.93% (63 runs sampled)
array x 207 ops/sec ±78.18% (5 runs sampled)
heap vs array: push + top(1) of 100
heap x 124,835 ops/sec ±40.37% (61 runs sampled)
array x 123 ops/sec ±78.49% (5 runs sampled)
heap vs array: push + top(50) of 100
heap x 59,210 ops/sec ±17.66% (82 runs sampled)
array x 125 ops/sec ±78.79% (5 runs sampled)
Star History
Changelog
2.5
-
+
+
- Improves the
limitproperty to support negative, Infinity, and NaN values. They will be set as0and the heap will not be limited. - Adds the
setLimitmethod to set the limit of the heap. It returnsNaNif the limit is negative, or NaN. This method is useful to check if the limit was set as expected. - Improves tests and documentation.
- Adds the
indexOfmethod to find the first index of an element in the heap. - Adds the
indexOfEverymethod to find all indexes of an element in the heap. - Changes the
removemethod to use theindexOfmethod. - Changes the
containsmethod to use theindexOfmethod. - Improves documentation.
- Adds the
HeapAsyncclass, with async methods and supporting async comparators. It is a drop-in replacement for theHeapclass with Promises. - Fixes
.iterator()method to follow Java's PriorityQueue implementation: -+
2.2
-
+
- Fixes
.iterator()method to follow Java's PriorityQueue implementation: + +The Iterator provided in method iterator() is not guaranteed to traverse the elements of the priority queue in any particular order.
Notice that using the heap directly as an iterator will consume the heap, as Python's
-heapqimplementation does.2.1
-
+
- Adds
Heap.nlargestas inheapq. - Adds
Heap.nsmallestas inheapq. - Sanitizes
top/bottominput to force an integer. - Linted with Eslint.
top(N)is unordered, only the first element is guaranteed to be the top priority element.- Fixes custom heap issue #31. @@ -62,42 +50,52 @@
Notice that using the heap directly as an iterator will consume the heap, as Python's
+heapqimplementation does.2.1
2.0
The main breaking change is that now
+top(N)does NOT sort the output, because sorting should not be part of the spec for a priority queue. The output is the top N elements, and they will be partially ordered with the peek at index0by definition.2.0
The main breaking change is that now
top(N)does NOT sort the output, because sorting should not be part of the spec for a priority queue. The output is the top N elements, and they will be partially ordered with the peek at index0by definition.heap-js
- Fixes
Star History
Changelog
2.5
2.4
-
+
2.4
2.3
-
+
2.3
2.2
-
-
top(N) algorithms.1.5
-
+
- Adds the
Iteratorinterface anditerator()method.
1.5
Examples
Basic usage
Min Heap
A heap where the smallest element is always at the top. It is the default heap.
-import { Heap } from 'heap-js';
// Min Heap by default
const minHeap = new Heap();
// Initialize the heap with an array
minHeap.init([5, 18, 1]);
// Push a new value
minHeap.push(2);
console.log(minHeap.peek()); //> 1
console.log(minHeap.pop()); //> 1
console.log(minHeap.peek()); //> 2
-Max Heap
A heap where the largest element is always at the top.
-import { Heap } from 'heap-js';
// Max Heap
const maxHeap = new Heap(Heap.maxComparator);
// Initialize the heap with an array
maxHeap.init([3, 4, 1, 12, 8]);
// Push a new value
maxHeap.push(2);
console.log(maxHeap.peek()); //> 12
console.log(maxHeap.pop()); //> 12
console.log(maxHeap.peek()); //> 8
-Custom Heap
A heap where the most important element is always at the top, but the elements are objects with a priority property.
import { Heap } from 'heap-js';
const customPriorityComparator = (a, b) => a.priority - b.priority;
// Custom Heap
const customHeap = new Heap(customPriorityComparator);
// Initialize the heap with an array
customHeap.init([{ priority: 5 }, { priority: 18 }, { priority: 1 }]);
// Push a new value
customHeap.push({ priority: 2 });
console.log(customHeap.peek()); //> { priority: 1 }
console.log(customHeap.pop()); //> { priority: 1 }
console.log(customHeap.peek()); //> { priority: 2 }
-Min HeapAsync
A heap where the most important element is always at the top, the elements are objects with a priority property, and the comparator function is asynchronous. Implements the same interface as Heap, but almost all methods return a Promise.
import { HeapAsync } from 'heap-js';
const customPriorityComparator = (a, b) => Promise.resolve(a.priority - b.priority);
// Custom HeapAsync
const customHeap = new HeapAsync(customPriorityComparator);
// Initialize the heap with an array
await customHeap.init([{ priority: 5 }, { priority: 18 }, { priority: 1 }]);
// Push a new value
await customHeap.push({ priority: 2 });
console.log(customHeap.peek()); //> { priority: 1 }
console.log(await customHeap.pop()); //> { priority: 1 }
console.log(await customHeap.peek()); //> { priority: 2 }
-Priority Queue usage
JavaScript / Python-style iterator (recommended)
Iterates over the heap consuming it, and guarantees to traverse the elements of the heap in the order of priority. Useful.
-const { Heap } = require('heap-js');
// Get all tasks from the database
const tasks = db.collection.find().toArray();
// The most important task has the lowest priority value
const customPriorityComparator = (a, b) => a.priority - b.priority;
// Create the priority queue
const priorityQueue = new Heap(customPriorityComparator);
// Initialize the priority queue with the tasks
priorityQueue.init(tasks);
// Iterator that will consume the heap while traversing it in the order of priority
for (const task of priorityQueue) {
console.log(task);
}
-Java-style iterator (not recommended)
Iterates over the heap without consuming it, but does not guarantee to traverse the elements of the heap in any particular order. Barely useful.
-const { Heap } = require('heap-js');
// Get all tasks from the database
const tasks = db.collection.find().toArray();
// The most important task has the lowest priority value
const customPriorityComparator = (a, b) => a.priority - b.priority;
const priorityQueue = new Heap(customPriorityComparator);
// Initialize the priority queue with the tasks
priorityQueue.init(tasks);
// Iterator, the Java way, that will not consume the heap BUT does not guarantee to traverse the elements of the heap in any particular order. Barely useful.
for (const task of priorityQueue.iterator()) {
console.log(task);
}
-Python-like static methods
import { Heap } from 'heap-js';
const numbers = [2, 3, 7, 5];
// Changes the array elements order into a heap in-place
Heap.heapify(numbers);
console.log(numbers); //> [ 2, 3, 5, 7 ]
// Pushes a new value to the heap
Heap.heappush(numbers, 1);
console.log(numbers); //> [ 1, 2, 5, 7, 3 ]
-Installation
yarn add heap-js # if you use yarn
npm install --save heap-js # if you use npm
-Constructor
Heap
new Heap([comparator]);
-HeapAsync
new HeapAsync([asyncComparator]);
-Comparators already included
-
+
Examples
Basic usage
Min Heap
A heap where the smallest element is always at the top. It is the default heap.
+import { Heap } from 'heap-js';
// Min Heap by default
const minHeap = new Heap();
// Initialize the heap with an array
minHeap.init([5, 18, 1]);
// Push a new value
minHeap.push(2);
console.log(minHeap.peek()); //> 1
console.log(minHeap.pop()); //> 1
console.log(minHeap.peek()); //> 2
+Max Heap
A heap where the largest element is always at the top.
+import { Heap } from 'heap-js';
// Max Heap
const maxHeap = new Heap(Heap.maxComparator);
// Initialize the heap with an array
maxHeap.init([3, 4, 1, 12, 8]);
// Push a new value
maxHeap.push(2);
console.log(maxHeap.peek()); //> 12
console.log(maxHeap.pop()); //> 12
console.log(maxHeap.peek()); //> 8
+Custom Heap
A heap where the most important element is always at the top, but the elements are objects with a priority property.
import { Heap } from 'heap-js';
const customPriorityComparator = (a, b) => a.priority - b.priority;
// Custom Heap
const customHeap = new Heap(customPriorityComparator);
// Initialize the heap with an array
customHeap.init([{ priority: 5 }, { priority: 18 }, { priority: 1 }]);
// Push a new value
customHeap.push({ priority: 2 });
console.log(customHeap.peek()); //> { priority: 1 }
console.log(customHeap.pop()); //> { priority: 1 }
console.log(customHeap.peek()); //> { priority: 2 }
+Min HeapAsync
A heap where the most important element is always at the top, the elements are objects with a priority property, and the comparator function is asynchronous. Implements the same interface as Heap, but almost all methods return a Promise.
import { HeapAsync } from 'heap-js';
const customPriorityComparator = (a, b) => Promise.resolve(a.priority - b.priority);
// Custom HeapAsync
const customHeap = new HeapAsync(customPriorityComparator);
// Initialize the heap with an array
await customHeap.init([{ priority: 5 }, { priority: 18 }, { priority: 1 }]);
// Push a new value
await customHeap.push({ priority: 2 });
console.log(customHeap.peek()); //> { priority: 1 }
console.log(await customHeap.pop()); //> { priority: 1 }
console.log(await customHeap.peek()); //> { priority: 2 }
+Priority Queue usage
JavaScript / Python-style iterator (recommended)
Iterates over the heap consuming it, and guarantees to traverse the elements of the heap in the order of priority. Useful.
+const { Heap } = require('heap-js');
// Get all tasks from the database
const tasks = db.collection.find().toArray();
// The most important task has the lowest priority value
const customPriorityComparator = (a, b) => a.priority - b.priority;
// Create the priority queue
const priorityQueue = new Heap(customPriorityComparator);
// Initialize the priority queue with the tasks
priorityQueue.init(tasks);
// Iterator that will consume the heap while traversing it in the order of priority
for (const task of priorityQueue) {
console.log(task);
}
+Java-style iterator (not recommended)
Iterates over the heap without consuming it, but does not guarantee to traverse the elements of the heap in any particular order. Barely useful.
+const { Heap } = require('heap-js');
// Get all tasks from the database
const tasks = db.collection.find().toArray();
// The most important task has the lowest priority value
const customPriorityComparator = (a, b) => a.priority - b.priority;
const priorityQueue = new Heap(customPriorityComparator);
// Initialize the priority queue with the tasks
priorityQueue.init(tasks);
// Iterator, the Java way, that will not consume the heap BUT does not guarantee to traverse the elements of the heap in any particular order. Barely useful.
for (const task of priorityQueue.iterator()) {
console.log(task);
}
+Python-like static methods
import { Heap } from 'heap-js';
const numbers = [2, 3, 7, 5];
// Changes the array elements order into a heap in-place
Heap.heapify(numbers);
console.log(numbers); //> [ 2, 3, 5, 7 ]
// Pushes a new value to the heap
Heap.heappush(numbers, 1);
console.log(numbers); //> [ 1, 2, 5, 7, 3 ]
+Installation
yarn add heap-js # if you use yarn
npm install --save heap-js # if you use npm
+Constructor
Heap
new Heap([comparator]);
+HeapAsync
new HeapAsync([asyncComparator]);
+Comparators already included
Heap.minComparator: Uses less-than operator to compare elements. It is the default comparator.Heap.maxComparator: Uses greater-than operator to compare elements.Heap.minComparatorNumber: Uses subtractiona - bto compare elements.Heap.maxComparatorNumber: Uses subtractionb - ato compare elements.
Implements JavaScript-style methods
indexOf(element, fn?) returns the internal index of the first occurrence of the element in the heap.indexOfEvery(element, fn?) returns an array with the internal indexes of all occurrences of the element in the heap.Implements Java's PriorityQueue interface
contains(element, fn?)element() alias of peek()isEmpty()iterator() returns the same as toArray() because it is iterable and follows Java's implementation. Barely useful. Use for (const value of heap) instead.iterator() returns the same as toArray() because it is iterable and follows Java's implementation. Barely useful. Use for (const value of heap) instead.offer(element) alias of add(element)peek()poll() alias of pop()heap-js
equalsretainAllImplements static Python's heapq interface
-
+
Heap.heapify(array, comparator?)that converts an array to an array-heap.Heap.heappop(heapArray, comparator?)that takes the peek of the array-heap.Heap.heappush(heapArray, item, comparator?)that appends elements to the array-heap.
@@ -153,97 +151,17 @@
Implements static Python's heapq interface
heap-js
merge(...iterables, comparator?)
Documentation
https://ignlg.github.io/heap-js/
-Contributing
Development of Heap.js happens in the open on GitHub, and I am grateful to the community for contributing bug fixes and improvements.
-Dev setup
yarn
-Tests
npm run test
-Benchmarks
npm run benchmarks
-License
Heap.js is BSD licensed.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Documentation
https://ignlg.github.io/heap-js/
+Sponsor
We are looking for sponsors to help us maintain and improve Heap.js. If you're interested in supporting this project, please get in touch with us.
+Collaborate
Would you like to contribute to Heap.js? Feel free to submit a pull request, open an issue, or reach out to the maintainers. We welcome your feedback and ideas!
+Dev setup
yarn
+Tests
npm run test
+Benchmarks
npm run benchmarks
+License
Heap.js is BSD 3-Clause Licensed.
+ diff --git a/docs/media/LICENSE b/docs/media/LICENSE new file mode 100644 index 0000000..d843642 --- /dev/null +++ b/docs/media/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2017, Ignacio Lago +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/docs/media/heap-js.png b/docs/media/heap-js.png new file mode 100644 index 0000000..a4aa5fc Binary files /dev/null and b/docs/media/heap-js.png differ diff --git a/docs/modules.html b/docs/modules.html index ddaf8ba..cdb521a 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,77 +1 @@ -
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/types/AsyncComparator.html b/docs/types/AsyncComparator.html
index 19be44f..28f76c8 100644
--- a/docs/types/AsyncComparator.html
+++ b/docs/types/AsyncComparator.html
@@ -1,69 +1 @@
-
-
-
-
-
-
-
-
-
-Type alias AsyncComparator<T>
Async
-Type Parameters
--
-
-
-
T
-
Type declaration
--
-
-
-
-
-
- (a, b): Promise<number> -
-
---
Parameters
--
-
-
-
a: T
- -
-
b: T
Returns Promise<number>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/types/AsyncIsEqual.html b/docs/types/AsyncIsEqual.html
index dd5c74e..e1ab3f8 100644
--- a/docs/types/AsyncIsEqual.html
+++ b/docs/types/AsyncIsEqual.html
@@ -1,69 +1 @@
-
-
-
-
-
-
-
-
-
-Type alias AsyncIsEqual<T>
Async
-Type Parameters
--
-
-
-
T
-
Type declaration
--
-
-
-
-
-
- (e, o): Promise<boolean> -
-
---
Parameters
--
-
-
-
e: T
- -
-
o: T
Returns Promise<boolean>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/types/Comparator.html b/docs/types/Comparator.html
index 389b159..3a48ddd 100644
--- a/docs/types/Comparator.html
+++ b/docs/types/Comparator.html
@@ -1,69 +1 @@
-
-
-
-
-
-
-
-
-
-Type alias Comparator<T>
Comparator<T>: ((a, b) => number)
-Type Parameters
--
-
-
-
T
-
Type declaration
--
-
-
-
-
-
- (a, b): number -
-
---
Parameters
--
-
-
-
a: T
- -
-
b: T
Returns number
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/types/IsEqual.html b/docs/types/IsEqual.html
index 3081d48..bf2f038 100644
--- a/docs/types/IsEqual.html
+++ b/docs/types/IsEqual.html
@@ -1,69 +1 @@
-
-
-
-
-
-
-
-
-
-Type alias IsEqual<T>
Is
-Type Parameters
--
-
-
-
T
-
Type declaration
--
-
-
-
-
-
- (e, o): boolean -
-
---
Parameters
--
-
-
-
e: T
- -
-
o: T
Returns boolean
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/package.json b/package.json
index 5a7051f..318d3c8 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "heap-js",
- "version": "2.5.0",
+ "version": "2.6.0",
"description": "Efficient Binary heap (priority queue, binary tree) data structure for JavaScript / TypeScript. Includes JavaScript methods, Python's heapq module methods, and Java's PriorityQueue methods.",
"keywords": [
"heap",
@@ -19,7 +19,7 @@
"license": "BSD-3-Clause",
"repository": {
"type": "git",
- "url": "git@github.com:ignlg/heap-js.git"
+ "url": "git+ssh://git@github.com/ignlg/heap-js.git"
},
"files": [
"dist"
@@ -69,32 +69,32 @@
}
},
"devDependencies": {
- "@rollup/plugin-commonjs": "^25.0.4",
- "@rollup/plugin-node-resolve": "^15.2.1",
- "@types/benchmark": "^2.1.2",
- "@types/jest": "^29.5.3",
- "@types/node": "^20.5.2",
- "@typescript-eslint/eslint-plugin": "6.4.1",
- "@typescript-eslint/parser": "^6.4.1",
+ "@rollup/plugin-commonjs": "^28.0.2",
+ "@rollup/plugin-node-resolve": "^16.0.0",
+ "@types/benchmark": "^2.1.5",
+ "@types/jest": "^29.5.14",
+ "@types/node": "^22.10.2",
+ "@typescript-eslint/eslint-plugin": "8.18.2",
+ "@typescript-eslint/parser": "^8.18.2",
"benchmark": "^2.1.4",
"coveralls": "^3.1.1",
"cross-env": "^7.0.3",
- "eslint": "8.47.0",
- "eslint-config-prettier": "^9.0.0",
- "eslint-plugin-prettier": "^5.0.0",
- "husky": "^8.0.3",
- "jest": "^29.6.3",
- "lint-staged": "^14.0.1",
+ "eslint": "<9.0.0",
+ "eslint-config-prettier": "^9.1.0",
+ "eslint-plugin-prettier": "^5.2.1",
+ "husky": "^9.1.7",
+ "jest": "^29.7.0",
+ "lint-staged": "^15.3.0",
"lodash.camelcase": "^4.3.0",
- "prettier": "^3.0.2",
- "prettier-eslint": "^15.0.1",
- "rimraf": "^5.0.1",
- "rollup": "^3.28.1",
+ "prettier": "^3.4.2",
+ "prettier-eslint": "^16.3.0",
+ "rimraf": "^6.0.1",
+ "rollup": "^4.29.1",
"rollup-plugin-sourcemaps": "^0.6.3",
- "ts-jest": "^29.1.1",
- "ts-node": "^10.9.1",
- "tsc-watch": "^6.0.4",
- "typedoc": "^0.24.8",
- "typescript": "^5.1.6"
+ "ts-jest": "^29.2.5",
+ "ts-node": "^10.9.2",
+ "tsc-watch": "^6.2.1",
+ "typedoc": "^0.27.6",
+ "typescript": "^5.7.2"
}
}
diff --git a/rollup.config.mjs b/rollup.config.mjs
index 6a320a9..708f55f 100644
--- a/rollup.config.mjs
+++ b/rollup.config.mjs
@@ -3,7 +3,7 @@ import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';
import sourceMaps from 'rollup-plugin-sourcemaps';
-import pkg from './package.json' assert { type: 'json' };
+import pkg from './package.json' with { type: 'json' };
const libraryName = 'Heap';
diff --git a/src/Heap.ts b/src/Heap.ts
index 8886eb1..f280782 100644
--- a/src/Heap.ts
+++ b/src/Heap.ts
@@ -614,24 +614,28 @@ export class Heap
Heap
-