Class SortedArray<V>

Readonlyarray

Readonlycomparator

length

• get length(): number

  Return the number of items in the array.

  Returns number

[iterator]

• "[iterator]"(): Generator<V, void, unknown>

  it allows to use SortedArray in for-of loop

  Returns Generator<V, void, unknown>

findExact

• findExact(v: V): V | undefined

  Return the exact (in terms of comparator) element that's in the array if present.

  Note this API might look redundant on a first glance, but it really depends on the comparator. We might have a complex object inside the array, yet the comparator will consider two objects equal just by looking at the id. With this API we are able to retrieve the exact object that's stored.

  Parameters

  • v: V

  Returns V | undefined

findIndex

• findIndex(v: V): number

  Returns index of SOME (it's not guaranteed it's first or last) equal element or -1 if the element does not exist.

  Parameters

  • v: V

  Returns number

has

• has(v: V): boolean

  Check if element is present in the collection.

  Parameters

  • v: V

  Returns boolean

insert

• insert(v: V): void

  Insert new element to the collection.

  Parameters

  • v: V

  Returns void

pop

• pop(): V | undefined

  Return and remove the last element of the collection.

  shift is much slower, so please don't add it.

  Returns V | undefined

removeOne

• removeOne(v: V): void

  Remove one matching element from the collection.

  Parameters

  • v: V

  Returns void

slice

• slice(start?: number, end?: number): V[]

  Return a regular array that's a copy of this one.

  Parameters

  • Optionalstart: number
  • Optionalend: number

  Returns V[]

StaticfromArray

• fromArray<V>(comparator: Comparator<V>, array?: readonly V[]): SortedArray<V>

  Create SortedArray from array that is not sorted. This function sorts the array.

  Type Parameters

  • V

  Parameters

  • comparator: Comparator<V>
  • array: readonly V[] = []

  Returns SortedArray<V>

StaticfromSortedArray

• fromSortedArray<V>(
      comparator: Comparator<V>,
      array?: readonly V[],
  ): SortedArray<V>

  Create SortedArray from array that is sorted. This function does not sort the array. Unsorted array will not work correctly!

  Type Parameters

  • V

  Parameters

  • comparator: Comparator<V>
  • array: readonly V[] = []

  Returns SortedArray<V>

StaticfromTwoSortedCollections

• fromTwoSortedCollections<V>(
      first: ImmutableSortedArray<V>,
      second: ImmutableSortedArray<V>,
  ): SortedArray<V>

  Create a new SortedArray from two sorted collections.

  Type Parameters

  • V

  Parameters

  • first: ImmutableSortedArray<V>
  • second: ImmutableSortedArray<V>

  Returns SortedArray<V>