cmath-js 1.0.6 → 1.0.8

package/README.md

@@ -14,3 +14,11 @@ Implementations of some of C's math functions in TypeScript/JavaScript.
 ## Integer functions
 These accept either a `number` or a `bigint`:
 - abs
+
+## Test coverage
+The test coverage is a perfect 100% and enforced by the publishing and pull request verification workflows.
+
+## Contributing
+Contributions are welcomed! Feel free to make a pull request. Please add your name to `contributors` in `package.json` and run `npm run build-and-verify` before submitting your PR. By making a pull request you agree to license your contribution under [the CC0 license](https://creativecommons.org/publicdomain/zero/1.0/legalcode.en#legal-code-title) unless otherwise specified.
+
+ESLint is used to enforce code quality and consistent formatting (with the help of Prettier). If ESLint complains when you run `npm run build-and-verify`, you can run `npm run lint-fix` to apply automatic fixes and and then fix the rest of the errors manually. I recommend configuring your IDE for ESLint and Prettier. If you are using Visual Studio Code, simply installing [Microsoft's ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [the official Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) takes care of that.

package/package.json

@@ -1,55 +1,61 @@
 {
 	"name": "cmath-js",
-	"homepage": "https://github.com/oskarlh/cmath.js",
-	"repository": "github:oskarlh/cmath.js",
-	"version": "1.0.6",
+	"homepage": "https://github.com/oskarlh/cmath-js",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/oskarlh/cmath-js.git"
+	},
+	"version": "1.0.8",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"type": "module",
 	"author": "Oskar Larsson Högfeldt <oskar@oskar.pm>",
+	"contributors": [
+		"Oskar Larsson Högfeldt <oskar@oskar.pm>"
+	],
 	"license": "MIT",
 	"description": "C's math functions implemented in TypeScript/JavaScript",
 	"keywords": [
-		"cmath",
+		"Browser",
 		"C",
 		"C++",
+		"cmath",
+		"ECMAScript",
+		"JavaScript",
 		"Math",
 		"Maths",
-		"JavaScript",
-		"ECMAScript",
-		"TypeScript",
 		"Node",
 		"NodeJS",
-		"Web",
-		"Browser"
+		"TypeScript",
+		"Web"
 	],
 	"devDependencies": {
-		"@swc/cli": "^0.1.57",
-		"@swc/core": "^1.3.18",
-		"@swc/jest": "^0.2.23",
+		"@swc/cli": "^0.1",
+		"@swc/core": "^1",
+		"@swc/jest": "^0.2",
 		"@types/jest": "^29",
 		"@types/node": "^20",
-		"@typescript-eslint/eslint-plugin": "^6.2",
-		"@typescript-eslint/parser": "^6.2",
-		"eslint": "^8.5.0",
-		"eslint-config-prettier": "^8.3.0",
+		"@typescript-eslint/eslint-plugin": "^6",
+		"@typescript-eslint/parser": "^6",
+		"eslint": "^8",
+		"eslint-config-prettier": "^9",
 		"eslint-plugin-prettier": "^5",
-		"jest": "^29.3.1",
+		"jest": "^29",
 		"prettier": "^3",
-		"ts-jest": "^29.0.3",
-		"typescript": "~5.1"
+		"ts-jest": "^29",
+		"typescript": "~5.2"
 	},
 	"scripts": {
 		"build": "tsc",
 		"build-and-verify": "npm run test-with-typechecking --ci && npm run lint && npm run build",
 		"build-without-typechecking": "swc -C exclude=.test.ts -d dist -s true -- src",
 		"lint": "eslint .",
+		"lint-fix": "eslint . --fix",
+		"prepack": "npm run build",
 		"test": "jest",
 		"test-with-typechecking": "jest --config=jest.config.with-typechecking.js"
 	},
 	"files": [
-		"dist",
-		"LICENSE",
-		"README.md"
+		"dist"
 	]
 }

package/dist/double/copysign.d.ts

@@ -1 +0,0 @@
-export declare function copysign(num: number, sign: number): number;

package/dist/double/copysign.js

@@ -1,4 +0,0 @@
-export function copysign(num, sign) {
-    return Math.abs(num) * (Object.is(0 * Math.sign(sign), -0) ? -1 : 1);
-}
-//# sourceMappingURL=copysign.js.map

package/dist/double/copysign.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"copysign.js","sourceRoot":"","sources":["../../src/double/copysign.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,QAAQ,CAAY,GAAW,EAAa,IAAY;IACvE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC"}

package/dist/double/fabs.d.ts

@@ -1 +0,0 @@
-export declare const fabs: (x: number) => number;

package/dist/double/fabs.js

@@ -1,2 +0,0 @@
-export const fabs = Math.abs;
-//# sourceMappingURL=fabs.js.map

package/dist/double/fabs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fabs.js","sourceRoot":"","sources":["../../src/double/fabs.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC"}

package/dist/double/frexp.d.ts

@@ -1 +0,0 @@
-export declare function frexp(num: number): [fraction: number, exponent: number];

package/dist/double/frexp.js

@@ -1,23 +0,0 @@
-export function frexp(num) {
-    const result = [num, 0];
-    if (num !== 0 && Number.isFinite(num)) {
-        const absNum = Math.abs(num);
-        let exp = Math.max(-1023, Math.floor(Math.log2(absNum)) + 1);
-        let x = absNum * 2 ** -exp;
-        while (x < 0.5) {
-            x *= 2;
-            --exp;
-        }
-        while (x >= 1) {
-            x *= 0.5;
-            ++exp;
-        }
-        if (num < 0) {
-            x = -x;
-        }
-        result[0] = x;
-        result[1] = exp;
-    }
-    return result;
-}
-//# sourceMappingURL=frexp.js.map

package/dist/double/frexp.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"frexp.js","sourceRoot":"","sources":["../../src/double/frexp.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,KAAK,CACT,GAAW;IAEtB,MAAM,MAAM,GAAqB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE1C,IAAI,GAAG,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACtC,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,GAAG,GAAW,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,GAAW,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;QAInC,OAAO,CAAC,GAAG,GAAG,EAAE;YACf,CAAC,IAAI,CAAC,CAAC;YACP,EAAE,GAAG,CAAC;SACN;QAGD,OAAO,CAAC,IAAI,CAAC,EAAE;YACd,CAAC,IAAI,GAAG,CAAC;YACT,EAAE,GAAG,CAAC;SACN;QAED,IAAI,GAAG,GAAG,CAAC,EAAE;YACZ,CAAC,GAAG,CAAC,CAAC,CAAC;SACP;QACD,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;KAChB;IACD,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/double/hypot.d.ts

@@ -1 +0,0 @@
-export declare function hypot(x: number, y: number, z?: number): number;

package/dist/double/hypot.js

@@ -1,19 +0,0 @@
-export function hypot(x, y, z) {
-    let result = 0;
-    if (z !== undefined) {
-        result = Math.hypot(x, y, z);
-    }
-    else {
-        result = Infinity;
-        if (x !== Infinity && x !== -Infinity && y !== Infinity && y !== -Infinity) {
-            if (x === 0 || y === 0) {
-                result = Math.max(Math.abs(x), Math.abs(y));
-            }
-            else {
-                result = Math.hypot(x, y);
-            }
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=hypot.js.map

package/dist/double/hypot.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hypot.js","sourceRoot":"","sources":["../../src/double/hypot.ts"],"names":[],"mappings":"AASA,MAAM,UAAU,KAAK,CAAY,CAAS,EAAa,CAAS,EAAa,CAAU;IACtF,IAAI,MAAM,GAAW,CAAC,CAAC;IACvB,IAAI,CAAC,KAAK,SAAS,EAAE;QACpB,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;SAAM;QACN,MAAM,GAAG,QAAQ,CAAC;QAClB,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC3E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aAC5C;iBAAM;gBACN,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC1B;SACD;KACD;IACD,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/double/index.d.ts

@@ -1,8 +0,0 @@
-export { copysign } from "./copysign.js";
-export { fabs } from "./fabs.js";
-export { frexp } from "./frexp.js";
-export { hypot } from "./hypot.js";
-export { ldexp } from "./ldexp.js";
-export { nextafter } from "./nextafter.js";
-export { pow } from "./pow.js";
-export { signbit } from "./signbit.js";

package/dist/double/index.js

@@ -1,9 +0,0 @@
-export { copysign } from "./copysign.js";
-export { fabs } from "./fabs.js";
-export { frexp } from "./frexp.js";
-export { hypot } from "./hypot.js";
-export { ldexp } from "./ldexp.js";
-export { nextafter } from "./nextafter.js";
-export { pow } from "./pow.js";
-export { signbit } from "./signbit.js";
-//# sourceMappingURL=index.js.map

package/dist/double/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/double/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/dist/double/ldexp.d.ts

@@ -1 +0,0 @@
-export declare function ldexp(factor: number, exponent: number): number;

package/dist/double/ldexp.js

@@ -1,5 +0,0 @@
-export function ldexp(factor, exponent) {
-    const halfPowerRoundedTowardZero = 2 ** Math.trunc(exponent * 0.5);
-    return (factor * halfPowerRoundedTowardZero * halfPowerRoundedTowardZero * 2 ** Math.sign(exponent % 2));
-}
-//# sourceMappingURL=ldexp.js.map

package/dist/double/ldexp.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ldexp.js","sourceRoot":"","sources":["../../src/double/ldexp.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,KAAK,CAAY,MAAc,EAAU,QAAgB;IACxE,MAAM,0BAA0B,GAAW,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC;IAC3E,OAAO,CACN,MAAM,GAAG,0BAA0B,GAAG,0BAA0B,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAC/F,CAAC;AACH,CAAC"}

package/dist/double/nextafter.d.ts

@@ -1 +0,0 @@
-export declare function nextafter(num: number, toward: number): number;

package/dist/double/nextafter.js

@@ -1,22 +0,0 @@
-export function nextafter(num, toward) {
-    if (num === toward) {
-        return toward;
-    }
-    if (num === 0) {
-        return Math.sign(toward) * Number.MIN_VALUE;
-    }
-    if (num === Infinity || num === -Infinity) {
-        return Number.MAX_VALUE * Math.sign(num);
-    }
-    if (num === -Number.MIN_VALUE && toward > num) {
-        return -0;
-    }
-    let differenceMultiplier = 0.5 * Math.sign(num) * (num < toward ? 1 : -1);
-    let result;
-    do {
-        result = num + num * (Number.EPSILON * differenceMultiplier);
-        differenceMultiplier *= 2;
-    } while (result === num);
-    return result;
-}
-//# sourceMappingURL=nextafter.js.map

package/dist/double/nextafter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nextafter.js","sourceRoot":"","sources":["../../src/double/nextafter.ts"],"names":[],"mappings":"AACA,MAAM,UAAU,SAAS,CAAY,GAAW,EAAa,MAAc;IAC1E,IAAI,GAAG,KAAK,MAAM,EAAE;QACnB,OAAO,MAAM,CAAC;KACd;IACD,IAAI,GAAG,KAAK,CAAC,EAAE;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;KAC5C;IACD,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE;QAC1C,OAAO,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACzC;IACD,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,EAAE;QAC9C,OAAO,CAAC,CAAC,CAAC;KACV;IACD,IAAI,oBAAoB,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,IAAI,MAAc,CAAC;IACnB,GAAG;QACF,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC,CAAC;QAC7D,oBAAoB,IAAI,CAAC,CAAC;KAC1B,QAAQ,MAAM,KAAK,GAAG,EAAE;IACzB,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/double/pow.d.ts

@@ -1 +0,0 @@
-export declare function pow(base: number, exponent: number): number;

package/dist/double/pow.js

@@ -1,8 +0,0 @@
-export function pow(base, exponent) {
-    let result = base ** exponent;
-    if (base === 1 || (base === -1 && (exponent === Infinity || exponent === -Infinity))) {
-        result = 1;
-    }
-    return result;
-}
-//# sourceMappingURL=pow.js.map

package/dist/double/pow.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pow.js","sourceRoot":"","sources":["../../src/double/pow.ts"],"names":[],"mappings":"AACA,MAAM,UAAU,GAAG,CAAY,IAAY,EAAa,QAAgB;IACvE,IAAI,MAAM,GAAG,IAAI,IAAI,QAAQ,CAAC;IAC9B,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE;QACrF,MAAM,GAAG,CAAC,CAAC;KACX;IACD,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/double/signbit.d.ts

@@ -1 +0,0 @@
-export declare function signbit(num: number): boolean;

package/dist/double/signbit.js

@@ -1,4 +0,0 @@
-export function signbit(num) {
-    return Object.is(num, -0) || num < 0;
-}
-//# sourceMappingURL=signbit.js.map

package/dist/double/signbit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signbit.js","sourceRoot":"","sources":["../../src/double/signbit.ts"],"names":[],"mappings":"AACA,MAAM,UAAU,OAAO,CAAY,GAAW;IAC7C,OAAO,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AACtC,CAAC"}

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./double/index.js";
-export * from "./integer/index.js";

package/dist/index.js

@@ -1,3 +0,0 @@
-export * from "./double/index.js";
-export * from "./integer/index.js";
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

package/dist/integer/abs.d.ts

@@ -1 +0,0 @@
-export declare function abs(number: bigint | number): number | bigint;

package/dist/integer/abs.js

@@ -1,7 +0,0 @@
-export function abs(number) {
-    if (number < 0 || Object.is(number, -0)) {
-        return -number;
-    }
-    return number;
-}
-//# sourceMappingURL=abs.js.map

package/dist/integer/abs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"abs.js","sourceRoot":"","sources":["../../src/integer/abs.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,GAAG,CAAC,MAAuB;IAC1C,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE;QACxC,OAAO,CAAC,MAAM,CAAC;KACf;IACD,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/integer/index.d.ts

@@ -1 +0,0 @@
-export { abs } from "./abs.js";

package/dist/integer/index.js

@@ -1,2 +0,0 @@
-export { abs } from "./abs.js";
-//# sourceMappingURL=index.js.map

package/dist/integer/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/integer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}