Interface ISortedSet<K>

size

add

• add(key: K): any

  Adds the specified item to the set, if it was not in the set already.

  Parameters

  • key: K

  Returns any

clear

• clear(): void

  Removes everything so that the set is empty.

  Returns void

delete

• delete(key: K): boolean

  Returns true if an element in the map object existed and has been removed, or false if the element did not exist.

  Parameters

  • key: K

  Returns boolean

forRange

• forRange(
      low: K,
      high: K,
      includeHigh: boolean,
      onFound?: (k: K, v: any, counter: number) => void,
      initialCounter?: number,
  ): number

  Calls callback on the specified range of keys, in ascending order by key.

  Parameters

  • low: K

    The first key scanned will be greater than or equal to low.

  • high: K

    Scanning stops when a key larger than this is reached.

  • includeHigh: boolean

    If the high key is present in the map, onFound is called for that final pair if and only if this parameter is true.

  • OptionalonFound: (k: K, v: any, counter: number) => void

    A function that is called for each key pair. Because this is a subinterface of ISortedMapSource, if there is a value associated with the key, it is passed as the second parameter.

  • OptionalinitialCounter: number

    Initial third argument of onFound. This value increases by one each time onFound is called. Default: 0

  Returns number

  Number of pairs found and the number of times onFound was called.

has

• has(key: K): boolean

  Returns a boolean asserting whether the key exists in the map object or not.

  Parameters

  • key: K

  Returns boolean

keys

• keys(firstKey?: K): IterableIterator<K>

  Returns a new iterator for iterating the keys of each pair in ascending order.

  Parameters

  • OptionalfirstKey: K

    Minimum key to include in the output.

  Returns IterableIterator<K>

maxKey

• maxKey(): K | undefined

  Gets the highest key in the collection.

  Returns K | undefined

minKey

• minKey(): K | undefined

  Gets the lowest key in the collection.

  Returns K | undefined

nextHigherKey

• nextHigherKey(key?: K): K | undefined

  Returns the next key larger than the specified key (or undefined if there is none). Also, nextHigherKey(undefined) returns the lowest key.

  Parameters

  • Optionalkey: K

  Returns K | undefined

nextLowerKey

• nextLowerKey(key?: K): K | undefined

  Returns the next key smaller than the specified key (or undefined if there is none). Also, nextLowerKey(undefined) returns the highest key.

  Parameters

  • Optionalkey: K

  Returns K | undefined