All files intervalSet.ts

100% Statements 144/144
100% Branches 71/71
100% Functions 34/34
100% Lines 126/126

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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 3591x             1x 2x                     1x 54x 54x                   54x 5x 8x 8x     54x             171x                 65x     63x 63x 38x               121x 58x 5x 53x 44x   9x 5x 4x 1x   3x                             88x 88x 88x 50x                         11x 19x                   3x             2x             92x   92x 92x 34x 34x     34x         19x       19x       19x   15x                         13x 20x 13x 4x   13x   13x           6x 7x 6x 2x   5x   4x 1x     3x 2x           3x 1x 1x 1x           3x 2x           3x       7x 7x 4x   3x 3x 4x 4x   4x   4x             3x                   3x   4x 3x 2x   3x 2x 1x 1x     3x 2x 1x 1x     2x 1x 1x 1x     1x 2x                       11x 11x   11x 3x 3x 3x     3x 6x 3x 3x       3x   8x 8x 8x   8x 3x   3x   3x 3x 3x     3x   3x 5x 10x 5x 5x                               4x               4x       1x 19x     1x 22x    
import { IInterval, Interval, IntervalNumber, NumericValue } from './interval';
 
/**
 * Represents interval set options.
 * mergeAddedInterval is optional and defaults to true.
 * mergeAddedInterval, when true, is used to merge overlapping Intervals when adding a new interval.
 */
export class IntervalSetOptions {
    mergeAddedInterval: boolean = true;
}
 
/**
 * Represents a set of intervals.
 * intervals is optional and defaults to an empty array.
 * mergeAddedInterval is optional and defaults to true.
 * mergeAddedInterval, when true, is used to merge overlapping Intervals when adding a new interval.
 * @example
 * const intervalSet: IntervalSet = new IntervalSet({ intervals: [new Interval({ a: new IntervalNumber(1), b: new IntervalNumber(10, false) }), new Interval({ a: new IntervalNumber(5), b: new IntervalNumber(15, false) })], options: { mergeAddedInterval: true });
 */
export class IntervalSet {
    private _intervals: Interval[] = [];
    private _mergeAddedInterval: boolean = true;
 
    /**
     * Creates a new IntervalSet object.
     * intervalSet is optional and defaults to undefined.
     * @param intervalSet - The interval set object.
     * @example
     * const intervalSet: IntervalSet = new IntervalSet({ intervals: [new Interval({ a: new IntervalNumber(1), b: new IntervalNumber(10, false) }), new Interval({ a: new IntervalNumber(5), b: new IntervalNumber(15, false) })], options: { mergeAddedInterval: true });
     */
    constructor(intervalSet?: { intervals?: (IInterval | string)[], options?: IntervalSetOptions }) {
        if (intervalSet?.intervals) {
            for (const interval of intervalSet.intervals) {
                const intervalObject = new Interval(interval);
                this._intervals.push(intervalObject);
            }
        }
        this.mergeAddedInterval = intervalSet?.options?.mergeAddedInterval ?? this._mergeAddedInterval;
    }
 
    /**
     * Returns a copy of the intervals in the interval set.
     */
    get intervals(): Interval[] {
        return this._intervals.map((r: Interval): Interval => new Interval(r));
    }
 
    /**
     * Gets or sets the mergeAddedInterval option.
     * mergeAddedInterval, when true, is used to merge overlapping Intervals when adding a new interval.
     * Setting this option to true will merge the intervals in the interval set.
     */
    get mergeAddedInterval(): boolean {
        return this._mergeAddedInterval;
    }
    set mergeAddedInterval(value: boolean) {
        this._mergeAddedInterval = value;
        if (this.mergeAddedInterval) {
            IntervalSet.mergeIntervals(this._intervals);
        }
    }
 
    /**
     * Sorts the intervals in the interval set, ascending based on the minimum value of each interval and isClosed is before !isClosed.
     */
    static sort(intervals: Interval[]): void {
        intervals.sort((a: Interval, b: Interval): number => {
            if (a.min.number < b.min.number) {
                return -1;
            } else if (a.min.number > b.min.number) {
                return 1;
            } else {
                if (a.min.isClosed && !b.min.isClosed) {
                    return -1;
                } else if (!a.min.isClosed && b.min.isClosed) {
                    return 1;
                } else {
                    return 0;
                }
            }
        });
    }
 
    /**
     * Adds an interval to the interval set.
     * @param interval - The interval object or string representation.
     * @example
     * intervalSet.addInterval(new Interval({ a: new IntervalNumber(1), b: new IntervalNumber(10, false) }));
     * @example
     * intervalSet.addInterval('[1, 10)');
     */
    addInterval(interval: IInterval | string): void {
        const intervalObject = new Interval(interval);
        this._intervals.push(intervalObject);
        if (this._mergeAddedInterval) {
            IntervalSet.mergeIntervals(this._intervals);
        }
    }
 
    /**
     * Removes an interval from the interval set.
     * @param interval - The interval object or string representation.
     * @example
     * intervalSet.removeInterval(new Interval({ a: new IntervalNumber(1), b: new IntervalNumber(10, false) }));
     * @example
     * intervalSet.removeInterval('[1, 10)');
     */
    removeInterval(interval: IInterval | string): void {
        const intervalObject = new Interval(interval);
        this._intervals = this._intervals.filter((r: Interval): boolean => r.toString() !== intervalObject.toString());
    }
 
    /**
     * Remove interval by name.
     * @param name - The name of the interval.
     * @example
     * intervalSet.removeIntervalByName('Interval 1');
     */
    removeIntervalByName(name: string): void {
        this._intervals = this._intervals.filter((r: Interval): boolean => r.name !== name);
    }
 
    /**
     * Removes all intervals from the interval set.
     */
    clear(): void {
        this._intervals = [];
    }
 
    /**
     * Merge overlapping intervals in the interval set.
     */
    private static mergeIntervals(intervals: Interval[]): void {
        IntervalSet.sort(intervals);
 
        let i = 0;
        while (i < intervals.length - 1) {
            const current = intervals[i];
            const next = intervals[i + 1];
 
            // Check if intervals overlap or are adjacent
            if (
                current.overlaps(next) ||
                (current.max.number === next.min.number && (current.max.isClosed || next.min.isClosed))
            ) {
                // Merge intervals
                current.min = new IntervalNumber(
                    safeMin(current.min.number, next.min.number),
                    current.min.isClosed || next.min.isClosed
                );
                current.max = new IntervalNumber(
                    safeMax(current.max.number, next.max.number),
                    current.max.isClosed || next.max.isClosed
                );
                intervals.splice(i + 1, 1); // Remove the merged interval
            } else {
                i++;
            }
        }
    }
 
    /**
     * Returns the gaps between the intervals in the passed in interval..
     * If interval is provided, the gaps are calculated based on the given interval.
     * If interval is not provided, the gaps are calculated based on the intervals in the interval set.
     * @param interval - The interval object or string representation.
     * @returns An array of Interval objects representing the gaps.
     */
    getIntervalGaps(interval?: IInterval | string): Interval[] {
        const intervalObject = interval ? new Interval(interval) : undefined;
        const intervalsCopy = this._intervals.map((r) => new Interval(r));
        if (!this._mergeAddedInterval) {
            IntervalSet.mergeIntervals(intervalsCopy);
        }
        IntervalSet.sort(intervalsCopy);
 
        return intervalObject
            ? this._getGapsForInterval(intervalObject, intervalsCopy)
            : this._getGapsForSet(intervalsCopy);
    }
 
    private _getGapsForInterval(interval: Interval, intervals: Interval[]): Interval[] {
        const gaps: Interval[] = [];
        const isContained = intervals.some((r) => r.contains(interval));
        if (isContained) {
            return gaps; // No gaps if the interval is contained within existing intervals
        }
        const overlappingIntervals = intervals.filter((r) => interval.overlaps(r));
 
        if (overlappingIntervals.length === 0) {
            return [interval];
        }
 
        if (!overlappingIntervals[0].containsMin(interval.min)) {
            gaps.push(new Interval({
                a: interval.min,
                b: new IntervalNumber(overlappingIntervals[0].min.number, !overlappingIntervals[0].min.isClosed),
            }));
        }
 
        for (let i = 0; i < overlappingIntervals.length - 1; i++) {
            const current = overlappingIntervals[i];
            const next = overlappingIntervals[i + 1];
            gaps.push(new Interval({
                a: new IntervalNumber(current.max.number, !current.max.isClosed),
                b: new IntervalNumber(next.min.number, !next.min.isClosed),
            }));
        }
 
        if (!overlappingIntervals[overlappingIntervals.length - 1].containsMax(interval.max)) {
            gaps.push(new Interval({
                a: new IntervalNumber(overlappingIntervals[overlappingIntervals.length - 1].max.number, !overlappingIntervals[overlappingIntervals.length - 1].max.isClosed),
                b: interval.max,
            }));
        }
 
        return gaps;
    }
 
    private _getGapsForSet(intervals: Interval[]): Interval[] {
        const gaps: Interval[] = [];
        if (intervals.length < 2) {
            return gaps;
        }
        if (intervals.length > 1) {
            for (let i = 0; i < intervals.length - 1; i++) {
                const current = intervals[i];
                const next = intervals[i + 1];
                // if they don't overlap, create a gap interval
                if (!current.overlaps(next) && (current.max.number !== next.min.number || (!current.max.isClosed && !next.min.isClosed))) {
                    // Create a gap interval
                    gaps.push(new Interval({
                        a: new IntervalNumber(current.max.number, !current.max.isClosed),
                        b: new IntervalNumber(next.min.number, !next.min.isClosed),
                    }));
                }
            }
        }
        return gaps;
    }
 
    /**
     * Create an interval gap in the interval set.
     * @param interval - The interval object or string representation.
     * @example
     * intervalSet.createIntervalGap(new Interval({ a: new IntervalNumber(5), b: new IntervalNumber(10, false) }));
     */
    createIntervalGap(interval: IInterval | string): void {
        const intervalObject = new Interval(interval);
        // use internal intervals array to properly update the intervals
        const overlappingIntervals: Interval[] = this._intervals.filter((r: Interval): boolean => r.overlaps(intervalObject));
        if (overlappingIntervals.length > 0) {
            const overlappingIntervalSet = new IntervalSet({ intervals: overlappingIntervals, options: { mergeAddedInterval: false } });
            // get the overlapping intervals that contain the given interval's max but not min, and update their max
            const minIntervals: Interval[] = this._intervals.filter((r: Interval): boolean => intervalObject.containsMax(r.max) && !intervalObject.containsMin(r.min));
            for (const minInterval of minIntervals) {
                minInterval.max = new IntervalNumber(intervalObject.min.number, !intervalObject.min.isClosed);
                overlappingIntervalSet.removeInterval(minInterval);
            }
            // get the overlapping intervals that contain the given interval's min but not max, and update their min
            const maxIntervals: Interval[] = this._intervals.filter((r: Interval): boolean => intervalObject.containsMin(r.min) && !intervalObject.containsMax(r.max));
            for (const maxInterval of maxIntervals) {
                maxInterval.min = new IntervalNumber(intervalObject.max.number, !intervalObject.max.isClosed);
                overlappingIntervalSet.removeInterval(maxInterval);
            }
            // if there's only 1 overlapping interval and it contains the given interval, then split the overlapping interval into 2 intervals
            if (overlappingIntervalSet.intervals.length === 1 && overlappingIntervalSet.intervals[0].contains(intervalObject)) {
                this.clear();
                this.addInterval(new Interval({ a: overlappingIntervalSet.intervals[0].min, b: new IntervalNumber(intervalObject.min.number, !intervalObject.min.isClosed) } as IInterval));
                this.addInterval(new Interval({ a: new IntervalNumber(intervalObject.max.number, !intervalObject.max.isClosed), b: overlappingIntervalSet.intervals[0].max } as IInterval));
            } else {
                // remove the overlapping intervals that are contained in the given interval
                for (const overlappingInterval of overlappingIntervalSet.intervals) {
                    this.removeInterval(overlappingInterval);
                }
            }
        }
    }
 
    /**
     * Remove interval gaps in the interval set.
     * If interval set is already merged, then the gaps are removed depending on the replaceGapsWithNewIntervals parameter.
     * If interval set is not merged, then resolve the existing sets annd remove contained intervals, hen remove the gaps depending on the replaceGapsWithNewIntervals parameter.
     */
    chainIntervals(): void {
        const intervalsCopy = this.intervals;
        IntervalSet.sort(intervalsCopy);
 
        if (this._mergeAddedInterval) {
            for (let i = 0; i < intervalsCopy.length - 1; i++) {
                const current = intervalsCopy[i];
                const next = intervalsCopy[i + 1];
 
                // Update the next interval's min if not already chained
                if (current.max.number !== next.min.number || current.max.isClosed === next.min.isClosed) {
                    const localIntervalToUpdate = this._intervals.find((r) => r.toString() === next.toString());
                    if (localIntervalToUpdate) {
                        localIntervalToUpdate.min = new IntervalNumber(current.max.number, !current.max.isClosed);
                    }
                }
            }
            this.mergeAddedInterval = false;
        } else {
            for (let i = 0; i < intervalsCopy.length - 1; i++) {
                const current = intervalsCopy[i];
                const next = intervalsCopy[i + 1];
 
                if (current.containsMax(next.max) || next.max.number < current.max.number) {
                    intervalsCopy.splice(i + 1, 1); // Remove the next interval
                    // Adjust the current interval's max if necessary
                    current.max = new IntervalNumber(safeMax(current.max.number, next.max.number), current.max.isClosed || next.max.isClosed);
                    // update the current interval in the original intervals array
                    const localIntervalToUpdate = this._intervals.find((r) => r.toString() === current.toString());
                    if (localIntervalToUpdate) {
                        localIntervalToUpdate.max = current.max;
                    }
                    // Remove the next interval from the original intervals array
                    this.removeInterval(next);
                    // Decrement i to recheck the current position after removal
                    i--;
                } else if (!current.containsMax(next.max)) {
                    const localIntervalToUpdate = this._intervals.find((r) => r.toString() === next.toString());
                    if (localIntervalToUpdate) {
                        localIntervalToUpdate.min = new IntervalNumber(current.max.number, !current.max.isClosed);
                    }
                }
            }
        }
    }
 
    /**
     * Returns the interval in the interval set that contain the given number.
     * @param x - The number to check.
     * @example
     * const intervalSet: IntervalSet = new IntervalSet({ intervals: [new Interval({ a: 1, b: 10 }), new Interval({ a: 20, b: 30 })], options: { mergeAddedInterval: true });
     * const intervals: Interval[] = intervalSet.getIntervalsContaining(5);
     * @returns An array of Interval objects that contain the provided number.
     */
    getIntervalsContaining(x: number): Interval[] {
        return this._intervals.filter((r: Interval): boolean => r.containsNumber(x));
    }
 
    /**
     * Returns a string representation of the interval set.
     * Example: "[1, 5), (10, 15]"
     */
    toString(): string {
        return this._intervals.map(interval => interval.toString()).join(', ');
    }
}
 
export function safeMin(a: NumericValue, b: NumericValue): NumericValue {
    return a < b ? a : b;
}
 
export function safeMax(a: NumericValue, b: NumericValue): NumericValue {
    return a > b ? a : b;
}