@thi.ng/arrays 2.5.23 → 2.6.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-27T11:20:58Z
+- **Last updated**: 2023-10-05T11:44:15Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/arrays@2.6.0) (2023-10-05)
+
+#### 🚀 Features
+
+- add argMin()/argMax() ([33512ec](https://github.com/thi-ng/umbrella/commit/33512ec))
+- add selectThresholdMin/Max() fns ([de9ba50](https://github.com/thi-ng/umbrella/commit/de9ba50))
+
 ### [2.5.15](https://github.com/thi-ng/umbrella/tree/@thi.ng/arrays@2.5.15) (2023-08-04)
 
 #### ♻️ Refactoring

package/README.md

@@ -50,7 +50,7 @@ For Node.js REPL:
 const arrays = await import("@thi.ng/arrays");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.61 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.75 KB
 
 ## Dependencies
 
@@ -69,9 +69,10 @@ directory are using this package.
 
 A selection:
 
-| Screenshot                                                                                                        | Description                      | Live demo                                        | Source                                                                        |
-|:------------------------------------------------------------------------------------------------------------------|:---------------------------------|:-------------------------------------------------|:------------------------------------------------------------------------------|
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/kmeans-viz.jpg" width="240"/> | k-means clustering visualization | [Demo](https://demo.thi.ng/umbrella/kmeans-viz/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/kmeans-viz) |
+| Screenshot                                                                                                            | Description                                            | Live demo                                            | Source                                                                            |
+|:----------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------|:-----------------------------------------------------|:----------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/kmeans-viz.jpg" width="240"/>     | k-means clustering visualization                       | [Demo](https://demo.thi.ng/umbrella/kmeans-viz/)     | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/kmeans-viz)     |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/stacked-layout.png" width="240"/> | Responsive & reactively computed stacked column layout | [Demo](https://demo.thi.ng/umbrella/stacked-layout/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/stacked-layout) |
 
 ## API
 

package/argmin.d.ts

@@ -0,0 +1,34 @@
+import type { Predicate2 } from "@thi.ng/api";
+/**
+ * Takes an array of numbers and returns the index of the item which is
+ * considered the minimum value according to the given initial `min` value
+ * (default: ∞) and predicate (both optional). Returns -1 if `items` is empty.
+ *
+ * @remarks
+ * See {@link argMax}.
+ *
+ * @example
+ * ```ts
+ * argMin([42, 11, 66, 23])
+ * // 1
+ *
+ * // same as argmax() with defaults
+ * argMin([42, 11, 66, 23], -Infinity, (a, b) => a > b)
+ * // 2
+ * ```
+ *
+ * @param buf
+ * @param min
+ * @param pred
+ */
+export declare const argMin: (buf: ArrayLike<number>, min?: number, pred?: Predicate2<number>) => number;
+/**
+ * Similar to {@link argMin}, but selects index of maximum item. Returns -1 if
+ * `items` is empty.
+ *
+ * @param items
+ * @param min
+ * @param pred
+ */
+export declare const argMax: (items: ArrayLike<number>, min?: number, pred?: Predicate2<number>) => number;
+//# sourceMappingURL=argmin.d.ts.map

package/argmin.js

@@ -0,0 +1,42 @@
+/**
+ * Takes an array of numbers and returns the index of the item which is
+ * considered the minimum value according to the given initial `min` value
+ * (default: ∞) and predicate (both optional). Returns -1 if `items` is empty.
+ *
+ * @remarks
+ * See {@link argMax}.
+ *
+ * @example
+ * ```ts
+ * argMin([42, 11, 66, 23])
+ * // 1
+ *
+ * // same as argmax() with defaults
+ * argMin([42, 11, 66, 23], -Infinity, (a, b) => a > b)
+ * // 2
+ * ```
+ *
+ * @param buf
+ * @param min
+ * @param pred
+ */
+export const argMin = (buf, min = Infinity, pred = (a, b) => a < b) => {
+    let id = -1;
+    for (let i = 0, n = buf.length; i < n; i++) {
+        const x = buf[i];
+        if (pred(x, min)) {
+            min = x;
+            id = i;
+        }
+    }
+    return id;
+};
+/**
+ * Similar to {@link argMin}, but selects index of maximum item. Returns -1 if
+ * `items` is empty.
+ *
+ * @param items
+ * @param min
+ * @param pred
+ */
+export const argMax = (items, min = -Infinity, pred = (a, b) => a > b) => argMin(items, min, pred);

package/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./api.js";
+export * from "./argmin.js";
 export * from "./arg-sort.js";
 export * from "./binary-search.js";
 export * from "./bisect.js";
@@ -22,5 +23,6 @@ export * from "./sort-cached.js";
 export * from "./starts-with.js";
 export * from "./swap.js";
 export * from "./swizzle.js";
+export * from "./threshold.js";
 export * from "./topo-sort.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,4 +1,5 @@
 export * from "./api.js";
+export * from "./argmin.js";
 export * from "./arg-sort.js";
 export * from "./binary-search.js";
 export * from "./bisect.js";
@@ -22,4 +23,5 @@ export * from "./sort-cached.js";
 export * from "./starts-with.js";
 export * from "./swap.js";
 export * from "./swizzle.js";
+export * from "./threshold.js";
 export * from "./topo-sort.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/arrays",
-  "version": "2.5.23",
+  "version": "2.6.0",
   "description": "Array / Arraylike utilities",
   "type": "module",
   "module": "./index.js",
@@ -39,7 +39,7 @@
     "@thi.ng/compare": "^2.2.0",
     "@thi.ng/equiv": "^2.1.30",
     "@thi.ng/errors": "^2.3.5",
-    "@thi.ng/random": "^3.6.4"
+    "@thi.ng/random": "^3.6.6"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.36.4",
@@ -83,6 +83,9 @@
     "./arg-sort": {
       "default": "./arg-sort.js"
     },
+    "./argmin": {
+      "default": "./argmin.js"
+    },
     "./binary-search": {
       "default": "./binary-search.js"
     },
@@ -149,6 +152,9 @@
     "./swizzle": {
       "default": "./swizzle.js"
     },
+    "./threshold": {
+      "default": "./threshold.js"
+    },
     "./topo-sort": {
       "default": "./topo-sort.js"
     }
@@ -156,5 +162,5 @@
   "thi.ng": {
     "year": 2018
   },
-  "gitHead": "b2ef5a1b8932d067af4ec2fc7da03d59d6868dc7\n"
+  "gitHead": "10d8b3725e96c5d704c759489a89f132892b181e\n"
 }

package/threshold.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Higher order function. Takes an object of threshold values and their target
+ * values, as well as a default value. Returns a new function which then matches
+ * a given value against all given thresholds and returns a matching target
+ * value, of (if none matched), the given default.
+ *
+ * @remarks
+ * The thresholds will be sorted & matched in ascending order using `<=`
+ * comparison.
+ *
+ * @example
+ * ```ts
+ * const numColumns = selectThresholdMin({ 480: 1, 640: 2, 960: 3 }, 4);
+ *
+ * numColumns(320) // 1
+ *
+ * numColumns(481) // 2
+ *
+ * numColumns(768) // 3
+ *
+ * numColumns(1024) // 4
+ * ```
+ *
+ * @param thresholds
+ * @param defaultVal
+ */
+export declare const selectThresholdMin: <T>(thresholds: Record<number, T>, defaultVal: T) => (x: number) => T;
+/**
+ * Similar to {@link selectThresholdMin}, but uses `>=` ordering.
+ *
+ * @param thresholds
+ * @param defaultVal
+ */
+export declare const selectThresholdMax: <T>(thresholds: Record<number, T>, defaultVal: T) => (x: number) => T;
+//# sourceMappingURL=threshold.d.ts.map

package/threshold.js

@@ -0,0 +1,50 @@
+/**
+ * Higher order function. Takes an object of threshold values and their target
+ * values, as well as a default value. Returns a new function which then matches
+ * a given value against all given thresholds and returns a matching target
+ * value, of (if none matched), the given default.
+ *
+ * @remarks
+ * The thresholds will be sorted & matched in ascending order using `<=`
+ * comparison.
+ *
+ * @example
+ * ```ts
+ * const numColumns = selectThresholdMin({ 480: 1, 640: 2, 960: 3 }, 4);
+ *
+ * numColumns(320) // 1
+ *
+ * numColumns(481) // 2
+ *
+ * numColumns(768) // 3
+ *
+ * numColumns(1024) // 4
+ * ```
+ *
+ * @param thresholds
+ * @param defaultVal
+ */
+export const selectThresholdMin = (thresholds, defaultVal) => {
+    const $thresholds = Object.entries(thresholds)
+        .map(([k, v]) => [+k, v])
+        .sort((a, b) => a[0] - b[0]);
+    return (x) => {
+        const res = $thresholds.find((t) => x <= t[0]);
+        return res ? res[1] : defaultVal;
+    };
+};
+/**
+ * Similar to {@link selectThresholdMin}, but uses `>=` ordering.
+ *
+ * @param thresholds
+ * @param defaultVal
+ */
+export const selectThresholdMax = (thresholds, defaultVal) => {
+    const $thresholds = Object.entries(thresholds)
+        .map(([k, v]) => [+k, v])
+        .sort((a, b) => b[0] - a[0]);
+    return (x) => {
+        const res = $thresholds.find((t) => x >= t[0]);
+        return res ? res[1] : defaultVal;
+    };
+};