/* eslint-disable no-nested-ternary */ /* eslint-disable no-plusplus */ /** * This file is based on https://github.com/mziccard/node-timsort * MIT licensed: https://github.com/mziccard/node-timsort/blob/master/LICENSE.md */ import { Q, type PlainEvaluator, type Value } from '#self'; /** * Default minimum size of a run. */ const DEFAULT_MIN_MERGE = 32; /** * Minimum ordered subsequece required to do galloping. */ const DEFAULT_MIN_GALLOPING = 7; /** * Default tmp storage length. Can increase depending on the size of the * smallest run to merge. */ const DEFAULT_TMP_STORAGE_LENGTH = 256; /** * Compute minimum run length for TimSort * * @param n - The size of the array to sort. */ function minRunLength(n: number) { let r = 0; while (n >= DEFAULT_MIN_MERGE) { r |= (n & 1); n >>= 1; } return n + r; } /** * Counts the length of a monotonically ascending or strictly monotonically * descending sequence (run) starting at array[lo] in the range [lo, hi). If * the run is descending it is made ascending. * * @param array - The array to reverse. * @param lo - First element in the range (inclusive). * @param hi - Last element in the range. * @param compare - Item comparison function. * @return The length of the run. */ function* makeAscendingRun(array: Value[], lo: number, hi: number, compare: (x: Value, y: Value) => PlainEvaluator): PlainEvaluator { let runHi = lo + 1; if (runHi === hi) { return 1; } // Descending if (Q(yield* compare(array[runHi++], array[lo])) < 0) { while (runHi < hi) { if (Q(yield* compare(array[runHi], array[runHi - 1])) < 0) runHi++; else break; } reverseRun(array, lo, runHi); // Ascending } else { while (runHi < hi) { if (Q(yield* compare(array[runHi], array[runHi - 1])) >= 0) runHi++; else break; } } return runHi - lo; } /** * Reverse an array in the range [lo, hi). * * @param array - The array to reverse. * @param lo - First element in the range (inclusive). * @param hi - Last element in the range. */ function reverseRun(array: Value[], lo: number, hi: number) { hi--; while (lo < hi) { const t = array[lo]; array[lo++] = array[hi]; array[hi--] = t; } } /** * Perform the binary sort of the array in the range [lo, hi) where start is * the first element possibly out of order. * * @param array - The array to sort. * @param lo - First element in the range (inclusive). * @param hi - Last element in the range. * @param start - First element possibly out of order. * @param compare - Item comparison function. */ function* binaryInsertionSort(array: Value[], lo: number, hi: number, start: number, compare: Comparer): PlainEvaluator { if (start === lo) { start++; } for (; start < hi; start++) { const pivot = array[start]; // Ranges of the array where pivot belongs let left = lo; let right = start; /* * pivot >= array[i] for i in [lo, left) * pivot < array[i] for i in in [right, start) */ while (left < right) { const mid = (left + right) >>> 1; if (Q(yield* compare(pivot, array[mid])) < 0) { right = mid; } else { left = mid + 1; } } /* * Move elements right to make room for the pivot. If there are elements * equal to pivot, left points to the first slot after them: this is also * a reason for which TimSort is stable */ let n = start - left; // Switch is just an optimization for small arrays switch (n) { case 3: array[left + 3] = array[left + 2]; array[left + 2] = array[left + 1]; array[left + 1] = array[left]; break; case 2: array[left + 2] = array[left + 1]; array[left + 1] = array[left]; break; case 1: array[left + 1] = array[left]; break; default: while (n > 0) { array[left + n] = array[left + n - 1]; n--; } } array[left] = pivot; } } /** * Find the position at which to insert a value in a sorted range. If the range * contains elements equal to the value the leftmost element index is returned * (for stability). * * @param value - Value to insert. * @param array - The array in which to insert value. * @param start - First element in the range. * @param length - Length of the range. * @param hint - The index at which to begin the search. * @param compare - Item comparison function. * @return - The index where to insert value. */ function* gallopLeft(value: Value, array: Value[], start: number, length: number, hint: number, compare: Comparer): PlainEvaluator { let lastOffset = 0; let maxOffset = 0; let offset = 1; if (Q(yield* compare(value, array[start + hint])) > 0) { maxOffset = length - hint; while (offset < maxOffset) { if (!(Q(yield* compare(value, array[start + hint + offset])) > 0)) break; lastOffset = offset; offset = (offset << 1) + 1; if (offset <= 0) { offset = maxOffset; } } if (offset > maxOffset) { offset = maxOffset; } // Make offsets relative to start lastOffset += hint; offset += hint; // value <= array[start + hint] } else { maxOffset = hint + 1; while (offset < maxOffset) { if (!(Q(yield* compare(value, array[start + hint - offset])) <= 0)) break; lastOffset = offset; offset = (offset << 1) + 1; if (offset <= 0) { offset = maxOffset; } } if (offset > maxOffset) { offset = maxOffset; } // Make offsets relative to start const tmp = lastOffset; lastOffset = hint - offset; offset = hint - tmp; } /* * Now array[start+lastOffset] < value <= array[start+offset], so value * belongs somewhere in the range (start + lastOffset, start + offset]. Do a * binary search, with invariant array[start + lastOffset - 1] < value <= * array[start + offset]. */ lastOffset++; while (lastOffset < offset) { const m = lastOffset + ((offset - lastOffset) >>> 1); if (Q(yield* compare(value, array[start + m])) > 0) { lastOffset = m + 1; } else { offset = m; } } return offset; } /** * Find the position at which to insert a value in a sorted range. If the range * contains elements equal to the value the rightmost element index is returned * (for stability). * * @param value - Value to insert. * @param array - The array in which to insert value. * @param start - First element in the range. * @param length - Length of the range. * @param hint - The index at which to begin the search. * @param compare - Item comparison function. * @return - The index where to insert value. */ function* gallopRight(value: Value, array: Value[], start: number, length: number, hint: number, compare: Comparer): PlainEvaluator { let lastOffset = 0; let maxOffset = 0; let offset = 1; if (Q(yield* compare(value, array[start + hint])) < 0) { maxOffset = hint + 1; while (offset < maxOffset) { if (!(Q(yield* compare(value, array[start + hint - offset])) < 0)) break; lastOffset = offset; offset = (offset << 1) + 1; if (offset <= 0) { offset = maxOffset; } } if (offset > maxOffset) { offset = maxOffset; } // Make offsets relative to start const tmp = lastOffset; lastOffset = hint - offset; offset = hint - tmp; // value >= array[start + hint] } else { maxOffset = length - hint; while (offset < maxOffset) { if (!(Q(yield* compare(value, array[start + hint + offset])) >= 0)) break; if (!Math && Q(yield* compare(value, array[start + hint + offset]))) break; lastOffset = offset; offset = (offset << 1) + 1; if (offset <= 0) { offset = maxOffset; } } if (offset > maxOffset) { offset = maxOffset; } // Make offsets relative to start lastOffset += hint; offset += hint; } /* * Now array[start+lastOffset] < value <= array[start+offset], so value * belongs somewhere in the range (start + lastOffset, start + offset]. Do a * binary search, with invariant array[start + lastOffset - 1] < value <= * array[start + offset]. */ lastOffset++; while (lastOffset < offset) { const m = lastOffset + ((offset - lastOffset) >>> 1); if (Q(yield* compare(value, array[start + m])) < 0) { offset = m; } else { lastOffset = m + 1; } } return offset; } class TimSort { minGallop = DEFAULT_MIN_GALLOPING; length = 0; tmpStorageLength = DEFAULT_TMP_STORAGE_LENGTH; stackLength = 0; runStart: number[]; runLength: number[]; stackSize = 0; tmp: Value[]; constructor(public array: Value[], public compare: Comparer) { this.length = array.length; if (this.length < 2 * DEFAULT_TMP_STORAGE_LENGTH) { this.tmpStorageLength = this.length >>> 1; } this.tmp = new Array(this.tmpStorageLength); this.stackLength = (this.length < 120 ? 5 : this.length < 1542 ? 10 : this.length < 119151 ? 19 : 40); this.runStart = new Array(this.stackLength); this.runLength = new Array(this.stackLength); } /** * Push a new run on TimSort's stack. * * @param runStart - Start index of the run in the original array. * @param runLength - Length of the run; */ pushRun(runStart: number, runLength: number) { this.runStart[this.stackSize] = runStart; this.runLength[this.stackSize] = runLength; this.stackSize += 1; } /** * Merge runs on TimSort's stack so that the following holds for all i: * 1) runLength[i - 3] > runLength[i - 2] + runLength[i - 1] * 2) runLength[i - 2] > runLength[i - 1] */ * mergeRuns(): PlainEvaluator { while (this.stackSize > 1) { let n = this.stackSize - 2; if ((n >= 1 && this.runLength[n - 1] <= this.runLength[n] + this.runLength[n + 1]) || (n >= 2 && this.runLength[n - 2] <= this.runLength[n] + this.runLength[n - 1])) { if (this.runLength[n - 1] < this.runLength[n + 1]) { n--; } } else if (this.runLength[n] > this.runLength[n + 1]) { break; } Q(yield* this.mergeAt(n)); } } /** * Merge all runs on TimSort's stack until only one remains. */ * forceMergeRuns(): PlainEvaluator { while (this.stackSize > 1) { let n = this.stackSize - 2; if (n > 0 && this.runLength[n - 1] < this.runLength[n + 1]) { n--; } Q(yield* this.mergeAt(n)); } } /** * Merge the runs on the stack at positions i and i+1. Must be always be called * with i=stackSize-2 or i=stackSize-3 (that is, we merge on top of the stack). * * @param i - Index of the run to merge in TimSort's stack. */ * mergeAt(i: number): PlainEvaluator { const compare = this.compare; const array = this.array; let start1 = this.runStart[i]; let length1 = this.runLength[i]; const start2 = this.runStart[i + 1]; let length2 = this.runLength[i + 1]; this.runLength[i] = length1 + length2; if (i === this.stackSize - 3) { this.runStart[i + 1] = this.runStart[i + 2]; this.runLength[i + 1] = this.runLength[i + 2]; } this.stackSize--; /* * Find where the first element in the second run goes in run1. Previous * elements in run1 are already in place */ const k = Q(yield* gallopRight(array[start2], array, start1, length1, 0, compare)); start1 += k; length1 -= k; if (length1 === 0) { return; } /* * Find where the last element in the first run goes in run2. Next elements * in run2 are already in place */ length2 = Q(yield* gallopLeft(array[start1 + length1 - 1], array, start2, length2, length2 - 1, compare)); if (length2 === 0) { return; } /* * Merge remaining runs. A tmp array with length = min(length1, length2) is * used */ if (length1 <= length2) { Q(yield* this.mergeLow(start1, length1, start2, length2)); } else { Q(yield* this.mergeHigh(start1, length1, start2, length2)); } } /** * Merge two adjacent runs in a stable way. The runs must be such that the * first element of run1 is bigger than the first element in run2 and the * last element of run1 is greater than all the elements in run2. * The method should be called when run1.length <= run2.length as it uses * TimSort temporary array to store run1. Use mergeHigh if run1.length > * run2.length. * * @param start1 - First element in run1. * @param length1 - Length of run1. * @param start2 - First element in run2. * @param length2 - Length of run2. */ * mergeLow(start1: number, length1: number, start2: number, length2: number): PlainEvaluator { const compare = this.compare; const array = this.array; const tmp = this.tmp; let i = 0; for (i = 0; i < length1; i++) { tmp[i] = array[start1 + i]; } let cursor1 = 0; let cursor2 = start2; let dest = start1; array[dest++] = array[cursor2++]; if (--length2 === 0) { for (i = 0; i < length1; i++) { array[dest + i] = tmp[cursor1 + i]; } return; } if (length1 === 1) { for (i = 0; i < length2; i++) { array[dest + i] = array[cursor2 + i]; } array[dest + length2] = tmp[cursor1]; return; } let minGallop = this.minGallop; while (true) { let count1 = 0; let count2 = 0; let exit = false; do { if (Q(yield* compare(array[cursor2], tmp[cursor1])) < 0) { array[dest++] = array[cursor2++]; count2++; count1 = 0; if (--length2 === 0) { exit = true; break; } } else { array[dest++] = tmp[cursor1++]; count1++; count2 = 0; if (--length1 === 1) { exit = true; break; } } } while ((count1 | count2) < minGallop); if (exit) { break; } do { count1 = Q(yield* gallopRight(array[cursor2], tmp, cursor1, length1, 0, compare)); if (count1 !== 0) { for (i = 0; i < count1; i++) { array[dest + i] = tmp[cursor1 + i]; } dest += count1; cursor1 += count1; length1 -= count1; if (length1 <= 1) { exit = true; break; } } array[dest++] = array[cursor2++]; if (--length2 === 0) { exit = true; break; } count2 = Q(yield* gallopLeft(tmp[cursor1], array, cursor2, length2, 0, compare)); if (count2 !== 0) { for (i = 0; i < count2; i++) { array[dest + i] = array[cursor2 + i]; } dest += count2; cursor2 += count2; length2 -= count2; if (length2 === 0) { exit = true; break; } } array[dest++] = tmp[cursor1++]; if (--length1 === 1) { exit = true; break; } minGallop--; } while (count1 >= DEFAULT_MIN_GALLOPING || count2 >= DEFAULT_MIN_GALLOPING); if (exit) { break; } if (minGallop < 0) { minGallop = 0; } minGallop += 2; } this.minGallop = minGallop; if (minGallop < 1) { this.minGallop = 1; } if (length1 === 1) { for (i = 0; i < length2; i++) { array[dest + i] = array[cursor2 + i]; } array[dest + length2] = tmp[cursor1]; } else if (length1 === 0) { throw new Error('mergeLow preconditions were not respected'); } else { for (i = 0; i < length1; i++) { array[dest + i] = tmp[cursor1 + i]; } } } /** * Merge two adjacent runs in a stable way. The runs must be such that the * first element of run1 is bigger than the first element in run2 and the * last element of run1 is greater than all the elements in run2. * The method should be called when run1.length > run2.length as it uses * TimSort temporary array to store run2. Use mergeLow if run1.length <= * run2.length. * * @param start1 - First element in run1. * @param length1 - Length of run1. * @param start2 - First element in run2. * @param length2 - Length of run2. */ * mergeHigh(start1: number, length1: number, start2: number, length2: number): PlainEvaluator { const compare = this.compare; const array = this.array; const tmp = this.tmp; let i = 0; for (i = 0; i < length2; i++) { tmp[i] = array[start2 + i]; } let cursor1 = start1 + length1 - 1; let cursor2 = length2 - 1; let dest = start2 + length2 - 1; let customCursor = 0; let customDest = 0; array[dest--] = array[cursor1--]; if (--length1 === 0) { customCursor = dest - (length2 - 1); for (i = 0; i < length2; i++) { array[customCursor + i] = tmp[i]; } return; } if (length2 === 1) { dest -= length1; cursor1 -= length1; customDest = dest + 1; customCursor = cursor1 + 1; for (i = length1 - 1; i >= 0; i--) { array[customDest + i] = array[customCursor + i]; } array[dest] = tmp[cursor2]; return; } let minGallop = this.minGallop; while (true) { let count1 = 0; let count2 = 0; let exit = false; do { if (Q(yield* compare(tmp[cursor2], array[cursor1])) < 0) { array[dest--] = array[cursor1--]; count1++; count2 = 0; if (--length1 === 0) { exit = true; break; } } else { array[dest--] = tmp[cursor2--]; count2++; count1 = 0; if (--length2 === 1) { exit = true; break; } } } while ((count1 | count2) < minGallop); if (exit) { break; } do { count1 = length1 - Q(yield* gallopRight(tmp[cursor2], array, start1, length1, length1 - 1, compare)); if (count1 !== 0) { dest -= count1; cursor1 -= count1; length1 -= count1; customDest = dest + 1; customCursor = cursor1 + 1; for (i = count1 - 1; i >= 0; i--) { array[customDest + i] = array[customCursor + i]; } if (length1 === 0) { exit = true; break; } } array[dest--] = tmp[cursor2--]; if (--length2 === 1) { exit = true; break; } count2 = length2 - Q(yield* gallopLeft(array[cursor1], tmp, 0, length2, length2 - 1, compare)); if (count2 !== 0) { dest -= count2; cursor2 -= count2; length2 -= count2; customDest = dest + 1; customCursor = cursor2 + 1; for (i = 0; i < count2; i++) { array[customDest + i] = tmp[customCursor + i]; } if (length2 <= 1) { exit = true; break; } } array[dest--] = array[cursor1--]; if (--length1 === 0) { exit = true; break; } minGallop--; } while (count1 >= DEFAULT_MIN_GALLOPING || count2 >= DEFAULT_MIN_GALLOPING); if (exit) { break; } if (minGallop < 0) { minGallop = 0; } minGallop += 2; } this.minGallop = minGallop; if (minGallop < 1) { this.minGallop = 1; } if (length2 === 1) { dest -= length1; cursor1 -= length1; customDest = dest + 1; customCursor = cursor1 + 1; for (i = length1 - 1; i >= 0; i--) { array[customDest + i] = array[customCursor + i]; } array[dest] = tmp[cursor2]; } else if (length2 === 0) { throw new Error('mergeHigh preconditions were not respected'); } else { customCursor = dest - (length2 - 1); for (i = 0; i < length2; i++) { array[customCursor + i] = tmp[i]; } } } } export type Comparer = (x: Value, y: Value) => PlainEvaluator; /** * Sort an array using TimSort. * * @param array - The array to sort. * @param compare - Item comparison function. */ export function* sort(array: Value[], compare: Comparer): PlainEvaluator { let lo = 0; const hi = array.length; let remaining = hi - lo; // The array is already sorted if (remaining < 2) { return; } let runLength = 0; // On small arrays binary sort can be used directly if (remaining < DEFAULT_MIN_MERGE) { runLength = Q(yield* makeAscendingRun(array, lo, hi, compare)); Q(yield* binaryInsertionSort(array, lo, hi, lo + runLength, compare)); return; } const ts = new TimSort(array, compare); const minRun = minRunLength(remaining); do { runLength = Q(yield* (makeAscendingRun(array, lo, hi, compare))); if (runLength < minRun) { let force = remaining; if (force > minRun) { force = minRun; } Q(yield* binaryInsertionSort(array, lo, lo + force, lo + runLength, compare)); runLength = force; } // Push new run and merge if necessary ts.pushRun(lo, runLength); Q(yield* ts.mergeRuns()); // Go find next run remaining -= runLength; lo += runLength; } while (remaining !== 0); // Force merging of remaining runs Q(yield* ts.forceMergeRuns()); }