All files / collections/src sortedSet.ts

98.24% Statements 56/57
100% Branches 16/16
90% Functions 9/10
98.21% Lines 55/56

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 2253x   3x 3x   3x 27x                                                               39x 3x 3x             37x 37x 37x                                                     16x   16x 16x   16x   16x 13x   13x   13x 9x 5x     9x     13x     16x 9x 9x     16x             1x                                                 6x   6x 6x 6x 6x 6x 13x   13x 5x 3x     5x   8x       6x                                                           5x   5x 5x 13x 1x     12x   12x 2x     10x 4x       3x             1x             34x     37x    
import { clear, deleteAt, insertAt } from "@benneq/array";
import { Comparator } from "@benneq/comparator";
import { distinct } from "@benneq/iterable";
import { AbstractSet } from "./abstractSet";
 
const valueToSortedSet = <T>(value: SortedSet<T> | T): Iterable<T> => {
  return value instanceof SortedSet ? value : [value];
};
 
/**
 * A {@link SortedSet} uses a {@link Comparator} for sorting the values and
 * checking for equality.
 *
 * @example
 * Add, delete and iterate
 * ```ts
 * const sortedSet = new SortedSet(numberComparator);
 * sortedSet.add(2);
 *
 * const otherSortedSet = new SortedSet(numberComparator);
 * otherSortedSet.add(2);
 * otherSortedSet.add(3);
 * otherSortedSet.add(1);
 *
 * sortedSet.add(otherSortedSet);
 *
 * sortedSet.delete(1);
 *
 * const result = sortedSet.has(2);
 * console.log(result); // true
 *
 * for(const value of sortedSet) {
 *   console.log(value); // 2, 3
 * }
 * ```
 *
 * @typeParam T - the {@link SortedSet} element type
 */
export class SortedSet<T> extends AbstractSet<T> {
  readonly #comparator;
  readonly #values;
 
  /**
   * @param comparator - the {@link Comparator} to use for sorting the values
   * @param values - optional {@link Array} of sorted and unique values for initialization
   */
  constructor(comparator: Comparator<T>, values?: Iterable<T>) {
    super();
    this.#comparator = comparator;
    this.#values = values ? [...distinct<T>()(values)].sort(comparator) : [];
  }
 
  /**
   * Adds `values` to this {@link SortedSet} if it does not already contain equal
   * values. Values are considered equal if the {@link Comparator} returns `0`.
   *
   * @mutation
   *
   * @example
   * Add values
   * ```ts
   * const sortedSet = new SortedSet(numberComparator);
   *
   * sortedSet.add(2);
   * sortedSet.add(0);
   * sortedSet.add(new SortedSet(numberComparator, [1, 2, 3]));
   *
   * console.log([...sortedSet.values()]); // [0, 1, 2, 3]
   * ```
   *
   * @param values - the values to add
   * @returns this
   */
  add(value: T): this;
  add(values: SortedSet<T>): this;
  add(value: T | SortedSet<T>): this {
    const iterator = valueToSortedSet(value)[Symbol.iterator]();
 
    let i = 0;
    let next = iterator.next();
 
    const values = this.#values;
 
    while (i < values.length && !next.done) {
      const value = next.value;
 
      const comparisonResult = this.#comparator(value, values[i] as T);
 
      if (comparisonResult <= 0) {
        if (comparisonResult < 0) {
          insertAt(i, value)(values);
        }
 
        next = iterator.next();
      }
 
      i++;
    }
 
    while (!next.done) {
      values.push(next.value);
      next = iterator.next();
    }
 
    return this;
  }
 
  /**
   * Removes all elements from this {@link SortedSet}.
   */
  clear(): void {
    clear(this.#values);
  }
 
  /**
   * Removes `values` from this {@link SortedSet} if it does contain equal values.
   * Values are considered equal if the {@link Comparator} returns `0`.
   *
   * @mutation
   *
   * @example
   * Remove values
   * ```ts
   * const sortedSet = new SortedSet(numberComparator, [1, 2, 3, 4, 5]);
   *
   * sortedSet.delete(new SortedSet(numberComparator, [0, 1, 2, 5]))
   *
   * console.log([...sortedSet.values()]); // [3, 4]
   * ```
   *
   * @param values - the values to remove
   * @returns `true` if this {@link SortedSet} has ben modified, otherwise `false`
   */
  delete(value: T): boolean;
  delete(values: SortedSet<T>): boolean;
  delete(value: T | SortedSet<T>): boolean {
    const iterator = valueToSortedSet(value)[Symbol.iterator]();
 
    const values = this.#values;
    let i = 0;
    let next = iterator.next();
    let modified = false;
    while (i < values.length && !next.done) {
      const comparisonResult = this.#comparator(next.value, values[i] as T);
 
      if (comparisonResult <= 0) {
        if (!comparisonResult) {
          modified = deleteAt(i)(values);
        }
 
        next = iterator.next();
      } else {
        i++;
      }
    }
 
    return modified;
  }
 
  /**
   * Returns the value at the specified `index`.
   *
   * @param index - the index of the element to get
   * @returns the element at the specified `index`, or `undefined` if out of bounds
   */
  at(index: number): T | undefined {
    return this.#values.at(index);
  }
 
  /**
   * Checks if this {@link SortedSet} contains all of the values.
   *
   * @example
   * Does the `set` contain `1` and `2`?
   * ```ts
   * const sortedSet = new SortedSet(numberComparator, [1, 2, 3]);
   * const result = sortedSet.has(new SortedSet(numberComparator, [1, 2]));
   * console.log(result); // true
   * ```
   *
   * @param values - the values it should contain
   * @returns `true` if this {@link SortedSet} contains all of the values, otherwise `false`
   */
  has(value: T): boolean;
  has(values: SortedSet<T>): boolean;
  has(value: T | SortedSet<T>): boolean {
    const iterator = valueToSortedSet(value)[Symbol.iterator]();
 
    let next = iterator.next();
    for (const value of this) {
      if (next.done) {
        break;
      }
 
      const comparisonResult = this.#comparator(next.value, value);
 
      if (comparisonResult < 0) {
        return false;
      }
 
      if (!comparisonResult) {
        next = iterator.next();
      }
    }
 
    return true;
  }
 
  /**
   * @returns the number of elements in this {@link SortedSet}
   */
  get size(): number {
    return this.#values.length;
  }
 
  /**
   * @returns an {@link Iterable} of the values of this {@link SortedSet}.
   */
  values(): IterableIterator<T> {
    return this.#values[Symbol.iterator]();
  }
 
  [Symbol.toStringTag] = "SortedSet";
}