Implements Iterable < T > IClear ICopy < Heap < T > > IEmpty < Heap < T > > ILength IStack < T , T , Heap < T > > Constructors constructor new Heap<T>( values?: null | Iterable < T > , opts?: HeapOpts < T > ) : Heap < T > Type parameters Parameters Optional values: null | Iterable < T > Optional opts: HeapOpts < T > Returns Heap < T > Properties compare compare: Comparator < T >
Methods [Symbol.iterator] [Symbol.iterator]( ) : Generator < T , void , undefined > Returns Generator < T , void , undefined > children children( n: number ) : undefined | T [] Parameters Returns undefined | T [] heapify heapify( vals?: T [] ) : void into into( vals: Iterable < T > ) : Heap < T > Parameters Returns Heap < T > parent parent( n: number ) : undefined | T Parameters Returns undefined | T Protected percolateDown percolateDown( i: number , vals?: T [] ) : void Protected percolateUp percolateUp( i: number , vals?: T [] ) : void push Parameters Returns Heap < T > pushPop pushPop( val: T , vals?: T [] ) : undefined | T Parameters Returns undefined | T pushPopAll pushPopAll( vals: Iterable < T > ) : undefined | T Parameters Returns undefined | T Static childIndex childIndex( idx: number ) : number Static parentIndex parentIndex( idx: number ) : number Legend Inherited property Inherited method Protected property Protected method
Generic binary heap / priority queue with customizable ordering via user-supplied comparator. By default, implements min-heap ordering and uses @thi.ng/compare.