@thi.ng/metrics 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+- **Last updated**: 2025-07-30T22:32:35Z
+- **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
+
+All notable changes to this project will be documented in this file.
+Only versions published since **2022-01-01** are listed here.
+Please consult the Git history for older version information.
+See [Conventional Commits](https://conventionalcommits.org/) for commit guidelines.
+
+**Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
+and/or version bumps of transitive dependencies.
+
+## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/metrics@0.1.0) (2025-07-30)
+
+#### 🚀 Features
+
+- import as new pkg ([6c9b8f6](https://github.com/thi-ng/umbrella/commit/6c9b8f6))

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,94 @@
+<!-- This file is generated - DO NOT EDIT! -->
+<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
+# ![@thi.ng/metrics](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/banners/thing-metrics.svg?97bb52ce)
+
+[![npm version](https://img.shields.io/npm/v/@thi.ng/metrics.svg)](https://www.npmjs.com/package/@thi.ng/metrics)
+![npm downloads](https://img.shields.io/npm/dm/@thi.ng/metrics.svg)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
+
+> [!NOTE]
+> This is one of 210 standalone projects, maintained as part
+> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
+> and anti-framework.
+>
+> 🚀 Please help me to work full-time on these projects by [sponsoring me on
+> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
+
+- [About](#about)
+- [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [API](#api)
+- [Authors](#authors)
+- [License](#license)
+
+## About
+
+Utilities for computing & aggregating value metrics (mean, min/max, sd), incl. support for circular domains.
+
+## Status
+
+**BETA** - possibly breaking changes forthcoming
+
+[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bmetrics%5D+in%3Atitle)
+
+## Installation
+
+```bash
+yarn add @thi.ng/metrics
+```
+
+ESM import:
+
+```ts
+import * as met from "@thi.ng/metrics";
+```
+
+Browser ESM import:
+
+```html
+<script type="module" src="https://esm.run/@thi.ng/metrics"></script>
+```
+
+[JSDelivr documentation](https://www.jsdelivr.com/)
+
+For Node.js REPL:
+
+```js
+const met = await import("@thi.ng/metrics");
+```
+
+Package sizes (brotli'd, pre-treeshake): ESM: 545 bytes
+
+## Dependencies
+
+- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+- [@thi.ng/math](https://github.com/thi-ng/umbrella/tree/develop/packages/math)
+- [@thi.ng/vectors](https://github.com/thi-ng/umbrella/tree/develop/packages/vectors)
+
+Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
+
+## API
+
+[Generated API docs](https://docs.thi.ng/umbrella/metrics/)
+
+TODO
+
+## Authors
+
+- [Karsten Schmidt](https://thi.ng)
+
+If this project contributes to an academic publication, please cite it as:
+
+```bibtex
+@misc{thing-metrics,
+  title = "@thi.ng/metrics",
+  author = "Karsten Schmidt",
+  note = "https://thi.ng/metrics",
+  year = 2025
+}
+```
+
+## License
+
+&copy; 2025 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 2-tuple representing a closed [min,max] value range/interval
+ */
+export type Range = [number, number];
+export interface Metric {
+    /** Average value */
+    mean: number;
+    /** Minimum value */
+    min: number;
+    /** Maximum value */
+    max: number;
+    /** Standard deviation */
+    sd: number;
+}
+export interface WeightedMetric extends Metric {
+    /**
+     * Weighted mean value (see {@link defWeightedMetric}).
+     */
+    weighted: number;
+}
+//# sourceMappingURL=api.d.ts.map

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./api.js";
+export * from "./metrics.js";
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,2 @@
+export * from "./api.js";
+export * from "./metrics.js";

package/metrics.d.ts

@@ -0,0 +1,47 @@
+import type { NumericArray } from "@thi.ng/api";
+import type { Metric, Range, WeightedMetric } from "./api.js";
+/**
+ * Computes a {@link Metric} for given `values`.
+ *
+ * @remarks
+ * Use {@link defCircularMetric} for angular/circular values. Use
+ * {@link defWeightedMetric} if the values have assigned weights.
+ *
+ * @param values
+ */
+export declare const defMetric: (values: NumericArray) => Metric;
+/**
+ * Computes a {@link WeightedMetric} for given `values` and their `weights` (the
+ * latter MUST sum to 1.0).
+ *
+ * @remarks
+ * The `weighted` result is computed as `dot(values, weights)`.
+ *
+ * @param values
+ * @param weights
+ */
+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}.
+ *
+ * @param values
+ */
+export declare const defCircularMetric: (values: NumericArray) => Metric;
+export declare const valueRange: (values: NumericArray) => Range;
+/**
+ * Constructs the min/max range of given normalized angular `values` around
+ * given mean hue (also normalized), considering circular wrap-around. If `min >
+ * max` in the result `[min,max]`, then the hue range is crossing 0 degrees.
+ *
+ * @param values
+ * @param range
+ * @param mean
+ */
+export declare const circularRange: (values: NumericArray, mean: number) => Range;
+export declare const aggregateMetrics: (metrics: Metric[]) => Metric;
+export declare const aggregateWeightedMetrics: (metrics: WeightedMetric[]) => WeightedMetric;
+export declare const aggregateCircularMetrics: (metrics: Metric[]) => Metric;
+export declare const aggregateMetricRanges: (metrics: Metric[]) => Range;
+//# sourceMappingURL=metrics.d.ts.map

package/metrics.js

@@ -0,0 +1,99 @@
+import { TAU } from "@thi.ng/math/api";
+import { fract } from "@thi.ng/math/prec";
+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 { vmin } from "@thi.ng/vectors/min";
+import { sd } from "@thi.ng/vectors/variance";
+const defMetric = (values) => {
+  const [min, max] = valueRange(values);
+  return {
+    min,
+    max,
+    mean: vmean(values),
+    sd: sd(values)
+  };
+};
+const defWeightedMetric = (values, weights) => {
+  const [min, max] = valueRange(values);
+  const mean = vmean(values);
+  return {
+    min,
+    max,
+    mean,
+    sd: sd(values),
+    weighted: dot(values, weights)
+  };
+};
+const defCircularMetric = (values) => {
+  const scaledValues = values.map((x) => x * TAU);
+  const mean = fract(circularMean(scaledValues) / TAU);
+  const [min, max] = circularRange(values, mean);
+  return {
+    min,
+    max,
+    mean,
+    sd: circularSD(scaledValues) / TAU
+  };
+};
+const valueRange = (values) => [
+  vmin(values),
+  vmax(values)
+];
+const circularRange = (values, mean) => {
+  const range = valueRange(values);
+  const [min, max] = range;
+  if (mean < min || mean > max) {
+    return [
+      values.reduce(
+        (acc, x) => {
+          const d = fract(mean - x);
+          return d < 0.5 && d > acc[1] ? [x, d] : acc;
+        },
+        [max, fract(mean - max)]
+      )[0],
+      values.reduce(
+        (acc, x) => {
+          const d = fract(x - mean);
+          return d < 0.5 && d > acc[1] ? [x, d] : acc;
+        },
+        [min, fract(min - mean)]
+      )[0]
+    ];
+  }
+  return range;
+};
+const aggregateMetrics = (metrics) => {
+  const mean = __mean(metrics, "mean");
+  const sd2 = __mean(metrics, "sd");
+  const [min, max] = aggregateMetricRanges(metrics);
+  return { mean, min, max, sd: sd2 };
+};
+const aggregateWeightedMetrics = (metrics) => {
+  const res = aggregateMetrics(metrics);
+  res.weighted = __mean(metrics, "weighted");
+  return res;
+};
+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 aggregateMetricRanges = (metrics) => [
+  vmin(metrics.map((x) => x.min)),
+  vmax(metrics.map((x) => x.max))
+];
+const __mean = (metrics, key) => vmean(metrics.map((x) => x[key]));
+export {
+  aggregateCircularMetrics,
+  aggregateMetricRanges,
+  aggregateMetrics,
+  aggregateWeightedMetrics,
+  circularRange,
+  defCircularMetric,
+  defMetric,
+  defWeightedMetric,
+  valueRange
+};

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@thi.ng/metrics",
+  "version": "0.1.0",
+  "description": "Utilities for computing & aggregating value metrics (mean, min/max, sd), incl. support for circular domains",
+  "type": "module",
+  "module": "./index.js",
+  "typings": "./index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thi-ng/umbrella.git"
+  },
+  "homepage": "https://thi.ng/metrics",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/postspectacular"
+    },
+    {
+      "type": "patreon",
+      "url": "https://patreon.com/thing_umbrella"
+    },
+    {
+      "type": "liberapay",
+      "url": "https://liberapay.com/thi.ng"
+    }
+  ],
+  "author": "Karsten Schmidt (https://thi.ng)",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
+    "clean": "bun ../../tools/src/clean-package.ts",
+    "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
+    "pub": "yarn npm publish --access public",
+    "test": "bun test",
+    "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
+  },
+  "dependencies": {
+    "@thi.ng/api": "^8.11.33",
+    "@thi.ng/math": "^5.11.33",
+    "@thi.ng/vectors": "^8.6.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.8",
+    "typedoc": "^0.28.7",
+    "typescript": "^5.8.3"
+  },
+  "keywords": [
+    "aggregation",
+    "circular",
+    "interval",
+    "mean",
+    "range",
+    "standard-deviation",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "browser": {
+    "process": false,
+    "setTimeout": false
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "./*.js",
+    "./*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "default": "./index.js"
+    },
+    "./api": {
+      "default": "./api.js"
+    },
+    "./metrics": {
+      "default": "./metrics.js"
+    }
+  },
+  "thi.ng": {
+    "status": "beta",
+    "year": 2025
+  },
+  "gitHead": "1df8a3a9061257ea73ccf1ab9cdf63c81a9f519f\n"
+}