@thi.ng/arrays/swap.d.ts

Array / Arraylike utilities

import type { AnyArray, SwapFn } from "./api.js";
/**
 * Swaps values at index `x`/`y` in given array.
 *
 * @param arr - array
 * @param x - first index
 * @param y - other index
 */
export declare const swap: (arr: AnyArray, x: number, y: number) => void;
/**
 * Higher-order version of {@link swap} for swapping elements in multiple arrays
 * at once and hence useful for sorting multiple arrays based on a single
 * criteria.
 *
 * @remarks
 * The returned function takes the same args as `swap`, and when called swaps 2
 * elements in the array given to that function AND in the arrays given to
 * {@link multiSwap} itself. Provides fast routes for up to 3 extra arrays, then
 * falls back to a loop-based approach.
 *
 * {@link quickSort}
 *
 * @example
 * ```ts tangle:../export/multiswap.ts
 * import { multiSwap } from "@thi.ng/arrays";
 *
 * const a = [2, 1];
 * const b = [20, 10];
 * const c = [40, 30];
 *
 * const ms = multiSwap(b, c);
 * ms(a, 0, 1);
 *
 * console.log(a);
 * // [1, 2]
 *
 * console.log(b);
 * // [10, 20]
 *
 * console.log(c);
 * // [30, 40]
 * ```
 *
 * @param arrays - arrays to swap in later
 */
export declare const multiSwap: (...arrays: AnyArray[]) => SwapFn;
//# sourceMappingURL=swap.d.ts.map