@thi.ng/arrays 2.4.5 → 2.4.6

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/binary-search.d.ts

@@ -1,20 +1,19 @@
 import type { Comparator, Fn, FnN, FnN2 } from "@thi.ng/api";
 /**
- * Returns the supposed index of `x` in pre-sorted array-like collection
- * `buf`.
+ * Returns the supposed index of `x` in pre-sorted array-like collection `buf`.
  *
  * @remarks
- * If `x` can't be found, returns `-index-1`, representing the negative
- * of the index, were `x` to be inserted into `buf`. E.g if the return
- * value is -3, `x` would appear/insert at index 2.
+ * If `x` can't be found, returns `-index-1`, representing the negative of the
+ * index, were `x` to be inserted into `buf`. E.g if the return value is -3, `x`
+ * would appear/insert at index 2.
  *
- * The optional `key` function is used to obtain the actual sort value
- * of `x` and each array item (default: identity).
+ * The optional `key` function is used to obtain the actual sort value of `x`
+ * and each array item (default: identity).
  *
  * The optional `cmp` comparator (default:
- * {@link @thi.ng/compare#compare}) is then used to identify the index
- * of `x`. The sort order of `buf` MUST be compatible with that of
- * `cmp`.
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html))
+ * is then used to identify the index of `x`. The sort order of `buf` MUST be
+ * compatible with that of `cmp`.
  *
  * @example
  * ```ts
@@ -33,7 +32,7 @@ export declare const binarySearch: <A, B>(buf: ArrayLike<A>, x: A, key?: Fn<A, B
 /**
  * Similar to {@link binarySearch}, but optimized for numeric arrays and
  * supporting custom comparators (default:
- * {@link @thi.ng/compare#compareNumAsc}).
+ * [`compareNumAsc()`](https://docs.thi.ng/umbrella/compare/functions/compareNumAsc.html)).
  *
  * @param buf - array
  * @param x - search value

package/binary-search.js

@@ -1,21 +1,20 @@
 import { compare } from "@thi.ng/compare/compare";
 import { compareNumAsc } from "@thi.ng/compare/numeric";
 /**
- * Returns the supposed index of `x` in pre-sorted array-like collection
- * `buf`.
+ * Returns the supposed index of `x` in pre-sorted array-like collection `buf`.
  *
  * @remarks
- * If `x` can't be found, returns `-index-1`, representing the negative
- * of the index, were `x` to be inserted into `buf`. E.g if the return
- * value is -3, `x` would appear/insert at index 2.
+ * If `x` can't be found, returns `-index-1`, representing the negative of the
+ * index, were `x` to be inserted into `buf`. E.g if the return value is -3, `x`
+ * would appear/insert at index 2.
  *
- * The optional `key` function is used to obtain the actual sort value
- * of `x` and each array item (default: identity).
+ * The optional `key` function is used to obtain the actual sort value of `x`
+ * and each array item (default: identity).
  *
  * The optional `cmp` comparator (default:
- * {@link @thi.ng/compare#compare}) is then used to identify the index
- * of `x`. The sort order of `buf` MUST be compatible with that of
- * `cmp`.
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html))
+ * is then used to identify the index of `x`. The sort order of `buf` MUST be
+ * compatible with that of `cmp`.
  *
  * @example
  * ```ts
@@ -50,7 +49,7 @@ export const binarySearch = (buf, x, key = (x) => x, cmp = compare, low = 0, hig
 /**
  * Similar to {@link binarySearch}, but optimized for numeric arrays and
  * supporting custom comparators (default:
- * {@link @thi.ng/compare#compareNumAsc}).
+ * [`compareNumAsc()`](https://docs.thi.ng/umbrella/compare/functions/compareNumAsc.html)).
  *
  * @param buf - array
  * @param x - search value

package/ends-with.d.ts

@@ -1,12 +1,13 @@
 /**
- * Returns true if the last items of `buf` are the same items as in
- * `needle`.
+ * Returns true if the last items of `buf` are the same items as in `needle`.
  *
  * @remarks
- * This means `buf` should have at least the same length as `needle` for
- * this to be true.
+ * This means `buf` should have at least the same length as `needle` for this to
+ * be true.
  *
- * By default, uses {@link @thi.ng/equiv#equiv} for equality checking.
+ * By default, uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * equality checking.
  *
  * {@link startsWith}
  *

package/ends-with.js

@@ -1,13 +1,14 @@
 import { equiv as _eq } from "@thi.ng/equiv";
 /**
- * Returns true if the last items of `buf` are the same items as in
- * `needle`.
+ * Returns true if the last items of `buf` are the same items as in `needle`.
  *
  * @remarks
- * This means `buf` should have at least the same length as `needle` for
- * this to be true.
+ * This means `buf` should have at least the same length as `needle` for this to
+ * be true.
  *
- * By default, uses {@link @thi.ng/equiv#equiv} for equality checking.
+ * By default, uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * equality checking.
  *
  * {@link startsWith}
  *

package/find.d.ts

@@ -1,6 +1,6 @@
 import type { Predicate2 } from "@thi.ng/api";
 /**
- * Similar to `Array.find()`, but uses {@link @thi.ng/equiv#equiv} as
+ * Similar to `Array.find()`, but uses [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
  * default predicate.
  *
  * @param buf - array
@@ -9,8 +9,9 @@ import type { Predicate2 } from "@thi.ng/api";
  */
 export declare const find: <T>(buf: ArrayLike<T>, x: T, equiv?: Predicate2<T>) => T | undefined;
 /**
- * Similar to `Array.findIndex()`, but uses {@link @thi.ng/equiv#equiv}
- * as default predicate.
+ * Similar to `Array.findIndex()`, but uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
+ * default predicate.
  *
  * @param buf - array
  * @param x - search value

package/find.js

@@ -1,6 +1,6 @@
 import { equiv as _equiv } from "@thi.ng/equiv";
 /**
- * Similar to `Array.find()`, but uses {@link @thi.ng/equiv#equiv} as
+ * Similar to `Array.find()`, but uses [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
  * default predicate.
  *
  * @param buf - array
@@ -12,8 +12,9 @@ export const find = (buf, x, equiv = _equiv) => {
     return i !== -1 ? buf[i] : undefined;
 };
 /**
- * Similar to `Array.findIndex()`, but uses {@link @thi.ng/equiv#equiv}
- * as default predicate.
+ * Similar to `Array.findIndex()`, but uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
+ * default predicate.
  *
  * @param buf - array
  * @param x - search value

package/fuzzy-match.d.ts

@@ -5,12 +5,14 @@ import type { Predicate2 } from "@thi.ng/api";
  *
  * @remarks
  * The optional `equiv` predicate can be used to customize item equality
- * checking. Uses {@link @thi.ng/equiv#equiv} by default.
+ * checking. Uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * default.
  *
- * Adapted and generalized from:
- * {@link https://github.com/bevacqua/fufuzzyzzysearch} (MIT)
+ * Adapted and generalized from: https://github.com/bevacqua/fufuzzyzzysearch
+ * (MIT licensed)
  *
- * {@link @thi.ng/transducers#(filterFuzzy:1)}
+ * [`filterFuzzy()`](https://docs.thi.ng/umbrella/transducers/functions/filterFuzzy.html)
  *
  * @param domain - array
  * @param query - search value

package/fuzzy-match.js

@@ -5,12 +5,14 @@ import { equiv as _eq } from "@thi.ng/equiv";
  *
  * @remarks
  * The optional `equiv` predicate can be used to customize item equality
- * checking. Uses {@link @thi.ng/equiv#equiv} by default.
+ * checking. Uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * default.
  *
- * Adapted and generalized from:
- * {@link https://github.com/bevacqua/fufuzzyzzysearch} (MIT)
+ * Adapted and generalized from: https://github.com/bevacqua/fufuzzyzzysearch
+ * (MIT licensed)
  *
- * {@link @thi.ng/transducers#(filterFuzzy:1)}
+ * [`filterFuzzy()`](https://docs.thi.ng/umbrella/transducers/functions/filterFuzzy.html)
  *
  * @param domain - array
  * @param query - search value

package/is-sorted.d.ts

@@ -1,12 +1,13 @@
 import type { Comparator } from "@thi.ng/api";
 /**
- * Returns true if the given array and its elements in the selected
- * index range (entire array, by default) are in the order defined by
- * the given comparator ({@link @thi.ng/compare#compare} by default).
+ * Returns true if the given array and its elements in the selected index range
+ * (entire array, by default) are in the order defined by the given comparator
+ * ([`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html)
+ * by default).
  *
  * @remarks
- * Always returns true, if effective index range (or array length) has
- * less than two elements. No bounds checking.
+ * Always returns true, if effective index range (or array length) has less than
+ * two elements. No bounds checking.
  *
  * @example
  * ```ts

package/is-sorted.js

@@ -1,12 +1,13 @@
 import { compare } from "@thi.ng/compare/compare";
 /**
- * Returns true if the given array and its elements in the selected
- * index range (entire array, by default) are in the order defined by
- * the given comparator ({@link @thi.ng/compare#compare} by default).
+ * Returns true if the given array and its elements in the selected index range
+ * (entire array, by default) are in the order defined by the given comparator
+ * ([`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html)
+ * by default).
  *
  * @remarks
- * Always returns true, if effective index range (or array length) has
- * less than two elements. No bounds checking.
+ * Always returns true, if effective index range (or array length) has less than
+ * two elements. No bounds checking.
  *
  * @example
  * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/arrays",
-  "version": "2.4.5",
+  "version": "2.4.6",
   "description": "Array / Arraylike utilities",
   "type": "module",
   "module": "./index.js",
@@ -34,12 +34,12 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
+    "@thi.ng/api": "^8.6.1",
     "@thi.ng/checks": "^3.3.5",
-    "@thi.ng/compare": "^2.1.19",
+    "@thi.ng/compare": "^2.1.20",
     "@thi.ng/equiv": "^2.1.15",
     "@thi.ng/errors": "^2.2.6",
-    "@thi.ng/random": "^3.3.18"
+    "@thi.ng/random": "^3.3.19"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
@@ -153,5 +153,5 @@
   "thi.ng": {
     "year": 2018
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/quicksort.d.ts

@@ -1,18 +1,19 @@
 import type { Comparator, Fn3, TypedArray } from "@thi.ng/api";
 /**
- * In-place quicksort implementation with optional comparator & index
- * based swap function, useful for sorting multiple related arrays in
- * parallel, based on a single sort criteria.
+ * In-place quicksort implementation with optional comparator & index based swap
+ * function, useful for sorting multiple related arrays in parallel, based on a
+ * single sort criteria.
  *
  * @remarks
- * Supports sorting of sub-ranges only, via optionally given
- * `start`/`end` indices (both inclusive).
+ * Supports sorting of sub-ranges only, via optionally given `start`/`end`
+ * indices (both inclusive).
  *
- * Uses Hoare partitioning scheme. {@link @thi.ng/compare#compare} is
- * used as default comparator and {@link swap} from this package as
- * default swap function. Also see {@link multiSwap}.
+ * Uses Hoare partitioning scheme.
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html) is
+ * used as default comparator and {@link swap} from this package as default swap
+ * function. Also see {@link multiSwap}.
  *
- * {@link https://en.wikipedia.org/wiki/Quicksort#Hoare_partition_scheme}
+ * - https://en.wikipedia.org/wiki/Quicksort#Hoare_partition_scheme
  *
  * @example
  * ```ts

package/shuffle.d.ts

@@ -2,14 +2,14 @@ import type { TypedArray } from "@thi.ng/api";
 import type { IRandom } from "@thi.ng/random";
 import type { AnyArray } from "./api.js";
 /**
- * Shuffles the items in the given index range of array `buf` using
- * Fisher-yates and optional `rnd` PRNG.
+ * Shuffles the items in the given index range of array `buf` using Fisher-yates
+ * and optional `rnd` PRNG.
  *
  * @remarks
- * If neither `start` / `end` are given, the entire array will be
- * shuffled. Mutates original array.
+ * If neither `start` / `end` are given, the entire array will be shuffled.
+ * Mutates original array.
  *
- * See {@link @thi.ng/random#IRandom}
+ * See [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
  *
  * @param buf - array
  * @param n - num items

package/shuffle.js

@@ -1,14 +1,14 @@
 import { assert } from "@thi.ng/errors/assert";
 import { SYSTEM } from "@thi.ng/random/system";
 /**
- * Shuffles the items in the given index range of array `buf` using
- * Fisher-yates and optional `rnd` PRNG.
+ * Shuffles the items in the given index range of array `buf` using Fisher-yates
+ * and optional `rnd` PRNG.
  *
  * @remarks
- * If neither `start` / `end` are given, the entire array will be
- * shuffled. Mutates original array.
+ * If neither `start` / `end` are given, the entire array will be shuffled.
+ * Mutates original array.
  *
- * See {@link @thi.ng/random#IRandom}
+ * See [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
  *
  * @param buf - array
  * @param n - num items

package/starts-with.d.ts

@@ -1,12 +1,13 @@
 /**
- * Returns true if the first items of `buf` are the same items as in
- * `needle`.
+ * Returns true if the first items of `buf` are the same items as in `needle`.
  *
  * @remarks
- * This means `buf` should have at least the same length as `needle` for
- * this to be true.
+ * This means `buf` should have at least the same length as `needle` for this to
+ * be true.
  *
- * By default, uses {@link @thi.ng/equiv#equiv} for equality checking.
+ * By default, uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * equality checking.
  *
  * {@link endsWith}
  *

package/starts-with.js

@@ -1,13 +1,14 @@
 import { equiv as _eq } from "@thi.ng/equiv";
 /**
- * Returns true if the first items of `buf` are the same items as in
- * `needle`.
+ * Returns true if the first items of `buf` are the same items as in `needle`.
  *
  * @remarks
- * This means `buf` should have at least the same length as `needle` for
- * this to be true.
+ * This means `buf` should have at least the same length as `needle` for this to
+ * be true.
  *
- * By default, uses {@link @thi.ng/equiv#equiv} for equality checking.
+ * By default, uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * equality checking.
  *
  * {@link endsWith}
  *

package/swap.d.ts

@@ -8,17 +8,17 @@ import type { AnyArray, SwapFn } from "./api.js";
  */
 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.
+ * 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.
+ * 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:1)}
+ * {@link quickSort}
  *
  * @example
  * ```ts

package/swap.js

@@ -11,17 +11,17 @@ export const swap = (arr, x, y) => {
     arr[y] = t;
 };
 /**
- * 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.
+ * 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.
+ * 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:1)}
+ * {@link quickSort}
  *
  * @example
  * ```ts