Class BinaryHeapCollection<T>

constructor

• new BinaryHeapCollection<T>(
      isItemOrdered: Predicate<[T, T]>,
      iterable?: Iterable<T, any, any>,
      capacity?: number,
  ): BinaryHeapCollection<T>

  Type Parameters

  • T

  Parameters

  • isItemOrdered: Predicate<[T, T]>
  • Optionaliterable: Iterable<T, any, any>
  • capacity: number = Infinity

  Returns BinaryHeapCollection<T>

Readonlycapacity

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<T>

  Returns AsyncIterator<T>

[iterator]

• "[iterator]"(): Iterator<T>

  Returns Iterator<T>

clear

• clear(): void

  Removes all elements from the collection.

  Returns void

concat

• concat(...items: T[]): IterableIterator<T>

  Concatenates the given items to the end of the collection and returns an iterator over the merged items.

  This method does not mutate the original collection.

  Parameters

  • ...items: T[]

    The items to merge.

  Returns IterableIterator<T>

  An iterator of the merged items.

count

• count(): number

  Returns the number of elements in the collection.

  Returns number

remove

• remove(condition: Predicate<[T]>): IterableIterator<T>

  Removes all the items matching the given predicate from the collection.

  Parameters

  • condition: Predicate<[T]>

    A predicate function to identify the items to remove.

  Returns IterableIterator<T>

  An iterable of the removed items.

removeFirst

• removeFirst(condition: Predicate<[T]>): boolean

  Removes the first occurrence of the item matching the given predicate from the collection.

  Parameters

  • condition: Predicate<[T]>

    A predicate function to identify the item to remove.

  Returns boolean

  true if the item was found and removed, false otherwise.

replace

• replace(
      condition: Predicate<[T]>,
      newItem: Callable<[T], T>,
  ): IterableIterator<T>

  Replaces all the item matching the given predicate in the collection with a new item.

  Parameters

  • condition: Predicate<[T]>

    A predicate function to identify the items to replace.

  • newItem: Callable<[T], T>

  Returns IterableIterator<T>

  An iterable of the replaced items.

replaceFirst

• replaceFirst(condition: Predicate<[T]>, newItem: T): boolean

  Replaces the first occurence of the item matching the given predicate in the collection with a new item.

  Parameters

  • condition: Predicate<[T]>

    A predicate function to identify the item to replace.

  • newItem: T

    The new item to insert.

  Returns boolean

  true if the item was found and replaced, false otherwise.