@thi.ng/metrics 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-07-30T22:32:35Z
+- **Last updated**: 2025-07-31T10:48:56Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,12 @@ 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.
 
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/metrics@0.2.0) (2025-07-31)
+
+#### 🚀 Features
+
+- add median to all metrics ([64c4a11](https://github.com/thi-ng/umbrella/commit/64c4a11))
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/metrics@0.1.0) (2025-07-30)
 
 #### 🚀 Features

package/README.md

@@ -24,11 +24,11 @@
 
 ## About
 
-Utilities for computing & aggregating value metrics (mean, min/max, sd), incl. support for circular domains.
+Utilities for computing & aggregating value metrics (mean, median, min/max, sd), incl. support for circular domains.
 
 ## Status
 
-**BETA** - possibly breaking changes forthcoming
+**STABLE** - used in production
 
 [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bmetrics%5D+in%3Atitle)
 
@@ -58,7 +58,7 @@ For Node.js REPL:
 const met = await import("@thi.ng/metrics");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 545 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 698 bytes
 
 ## Dependencies
 

package/api.d.ts

@@ -5,6 +5,8 @@ export type Range = [number, number];
 export interface Metric {
     /** Average value */
     mean: number;
+    /** Median value */
+    median: number;
     /** Minimum value */
     min: number;
     /** Maximum value */

package/metrics.d.ts

@@ -23,8 +23,8 @@ export declare const defMetric: (values: NumericArray) => Metric;
 export declare const defWeightedMetric: (values: NumericArray, weights: NumericArray) => WeightedMetric;
 /**
  * Computes a {@link Metric} for given angular/circular `values` (normalized to
- * [0,1] range). The `mean` and `sd` are computed using circular versions and
- * the `min`/`max` bounds via {@link circularRange}.
+ * [0,1] range). The `mean`, `media` and `sd` are computed using circular
+ * versions and the `min`/`max` bounds via {@link circularRange}.
  *
  * @param values
  */

package/metrics.js

@@ -4,6 +4,7 @@ import { circularMean, circularSD } from "@thi.ng/vectors/circular";
 import { dot } from "@thi.ng/vectors/dot";
 import { vmax } from "@thi.ng/vectors/max";
 import { vmean } from "@thi.ng/vectors/mean";
+import { vmedian } from "@thi.ng/vectors/median";
 import { vmin } from "@thi.ng/vectors/min";
 import { sd } from "@thi.ng/vectors/variance";
 const defMetric = (values) => {
@@ -12,16 +13,17 @@ const defMetric = (values) => {
     min,
     max,
     mean: vmean(values),
+    median: vmedian(values),
     sd: sd(values)
   };
 };
 const defWeightedMetric = (values, weights) => {
   const [min, max] = valueRange(values);
-  const mean = vmean(values);
   return {
     min,
     max,
-    mean,
+    mean: vmean(values),
+    median: vmedian(values),
     sd: sd(values),
     weighted: dot(values, weights)
   };
@@ -34,6 +36,7 @@ const defCircularMetric = (values) => {
     min,
     max,
     mean,
+    median: __circularMedian(values, min, max),
     sd: circularSD(scaledValues) / TAU
   };
 };
@@ -66,9 +69,10 @@ const circularRange = (values, mean) => {
 };
 const aggregateMetrics = (metrics) => {
   const mean = __mean(metrics, "mean");
+  const median = __mean(metrics, "median");
   const sd2 = __mean(metrics, "sd");
   const [min, max] = aggregateMetricRanges(metrics);
-  return { mean, min, max, sd: sd2 };
+  return { min, max, mean, median, sd: sd2 };
 };
 const aggregateWeightedMetrics = (metrics) => {
   const res = aggregateMetrics(metrics);
@@ -77,15 +81,29 @@ const aggregateWeightedMetrics = (metrics) => {
 };
 const aggregateCircularMetrics = (metrics) => {
   const mean = circularMean(metrics.map((x) => x.mean * TAU)) / TAU;
-  const sd2 = __mean(metrics, "sd");
   const [min, max] = aggregateMetricRanges(metrics);
-  return { mean, min, max, sd: sd2 };
+  const sd2 = __mean(metrics, "sd");
+  const median = __circularMedian(
+    metrics.map((x) => x.mean),
+    min,
+    max
+  );
+  return { min, max, mean, median, sd: sd2 };
 };
 const aggregateMetricRanges = (metrics) => [
   vmin(metrics.map((x) => x.min)),
   vmax(metrics.map((x) => x.max))
 ];
 const __mean = (metrics, key) => vmean(metrics.map((x) => x[key]));
+const __circularMedian = (values, min, max) => {
+  if (min <= max) return vmedian(values);
+  const n = values.length;
+  const m = n >> 1;
+  const sorted = [...values].sort((a, b) => a - b);
+  const split = sorted.findIndex((x) => x === min);
+  const reordered = sorted.slice(split).concat(sorted.slice(0, split));
+  return n & 1 ? reordered[m] : (reordered[m - 1] + reordered[m]) * 0.5;
+};
 export {
   aggregateCircularMetrics,
   aggregateMetricRanges,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thi.ng/metrics",
-  "version": "0.1.0",
-  "description": "Utilities for computing & aggregating value metrics (mean, min/max, sd), incl. support for circular domains",
+  "version": "0.2.0",
+  "description": "Utilities for computing & aggregating value metrics (mean, median, min/max, sd), incl. support for circular domains",
   "type": "module",
   "module": "./index.js",
   "typings": "./index.d.ts",
@@ -41,7 +41,7 @@
   "dependencies": {
     "@thi.ng/api": "^8.11.33",
     "@thi.ng/math": "^5.11.33",
-    "@thi.ng/vectors": "^8.6.0"
+    "@thi.ng/vectors": "^8.6.1"
   },
   "devDependencies": {
     "esbuild": "^0.25.8",
@@ -53,6 +53,7 @@
     "circular",
     "interval",
     "mean",
+    "median",
     "range",
     "standard-deviation",
     "typescript"
@@ -83,8 +84,7 @@
     }
   },
   "thi.ng": {
-    "status": "beta",
     "year": 2025
   },
-  "gitHead": "1df8a3a9061257ea73ccf1ab9cdf63c81a9f519f\n"
+  "gitHead": "76ffdc6e27bced158471ed47700919e7079956ca\n"
 }