@thi.ng/math 5.7.11 → 5.8.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-31T09:44:24Z
+- **Last updated**: 2024-01-26T18:03:04Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,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.
 
+## [5.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.8.0) (2024-01-26)
+
+#### 🚀 Features
+
+- add signedPow(), add docs ([5207ba3](https://github.com/thi-ng/umbrella/commit/5207ba3))
+
 ### [5.7.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.7.2) (2023-11-09)
 
 #### ♻️ Refactoring

package/README.md

@@ -68,7 +68,7 @@ For Node.js REPL:
 const math = await import("@thi.ng/math");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.07 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.09 KB
 
 ## Dependencies
 
@@ -118,4 +118,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2013 - 2023 Karsten Schmidt // Apache License 2.0
+© 2013 - 2024 Karsten Schmidt // Apache License 2.0

package/abs.d.ts

@@ -1,4 +1,26 @@
 import type { FnN2 } from "@thi.ng/api";
+/**
+ * Returns the absolute difference between `a` and `b`.
+ *
+ * @param a
+ * @param b
+ */
 export declare const absDiff: FnN2;
+/**
+ * Similar to `Math.sign()`, but uses `eps` to determine the zero value (i.e. if
+ * `x` is in [-eps,eps] interval).
+ *
+ * @param x
+ * @param eps
+ */
 export declare const sign: (x: number, eps?: number) => 0 | 1 | -1;
+/**
+ * Raises `x` to `k` power and multiplies it with the {@link sign} of `x`, using
+ * `eps` to determine zero.
+ *
+ * @param x
+ * @param k
+ * @param eps
+ */
+export declare const signedPow: (x: number, k: number, eps?: number) => number;
 //# sourceMappingURL=abs.d.ts.map

package/abs.js

@@ -1,7 +1,9 @@
 import { EPS } from "./api.js";
-const absDiff = (x, y) => Math.abs(x - y);
+const absDiff = (a, b) => Math.abs(a - b);
 const sign = (x, eps = EPS) => x > eps ? 1 : x < -eps ? -1 : 0;
+const signedPow = (x, k, eps = EPS) => sign(x, eps) * Math.abs(x) ** k;
 export {
   absDiff,
-  sign
+  sign,
+  signedPow
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.7.11",
+  "version": "5.8.0",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -38,7 +38,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.16"
+    "@thi.ng/api": "^8.9.18"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.39.0",
@@ -138,5 +138,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "b3db173682e1148cf08a6bd907b8d90b47b7c066\n"
+  "gitHead": "7426e2ae6fca5482c6eaf649872296fc89955374\n"
 }