cmath-js 1.0.17 → 1.0.18

package/README.md

@@ -1,22 +1,24 @@
 # cmath-js
-Implementations of some of C's math functions in TypeScript/JavaScript.
+Implementation of parts of C's & C++'s numerics libraries in TypeScript/JavaScript.
 
 ## Floating-point functions 
 - [`copysign`](https://en.cppreference.com/w/c/numeric/math/copysign)
 - [`fabs`](https://en.cppreference.com/w/c/numeric/math/fabs)
 - [`frexp`](https://en.cppreference.com/w/c/numeric/math/frexp)
-- [`hypot`](https://en.cppreference.com/w/cpp/numeric/math/hypot)¹
+- [`hypot`](https://en.cppreference.com/w/cpp/numeric/math/hypot)
 - [`ldexp`](https://en.cppreference.com/w/c/numeric/math/ldexp)
 - [`nextafter`](https://en.cppreference.com/w/c/numeric/math/nextafter)
 - [`pow`](https://en.cppreference.com/w/c/numeric/math/pow)
 - [`signbit`](https://en.cppreference.com/w/c/numeric/math/signbit)
 
-### Notes
-1: `hypot` is the C++ version which works just like the C version but accepts an optional third value.
-
 ## Integer functions
-This function accepts either a `number` or a `bigint`:
+These functions accept either a `number` or a `bigint`:
 - [`abs`](https://en.cppreference.com/w/c/numeric/math/abs)
+- [`countl_one`](https://en.cppreference.com/w/cpp/numeric/countl_one)
+- [`countl_zero`](https://en.cppreference.com/w/cpp/numeric/countl_zero)
+- [`countr_one`](https://en.cppreference.com/w/cpp/numeric/countr_one)
+- [`countr_zero`](https://en.cppreference.com/w/cpp/numeric/countr_zero)
+- [`popcount`](https://en.cppreference.com/w/cpp/numeric/popcount)
 
 ## Test coverage
 The test coverage is a perfect 100% and enforced by the publishing and pull request verification workflows.

package/dist/integer/abs.d.ts

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

package/dist/integer/abs.js

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

package/dist/integer/abs.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"abs.js","sourceRoot":"","sources":["../../src/integer/abs.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,GAAG,CAAC,OAAwB;IAC3C,IAAI,OAAO,GAAG,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;QAC1C,OAAO,CAAC,OAAO,CAAC;KAChB;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}

package/dist/integer/bitsInUnsignedInteger.d.ts

@@ -0,0 +1 @@
+export declare function bitsInUnsignedInteger(values: [fixedIntegerSizeInBits: number, integer: bigint | number] | [integer: bigint | number]): Uint8Array;

package/dist/integer/bitsInUnsignedInteger.js

@@ -0,0 +1,30 @@
+export function bitsInUnsignedInteger(values) {
+    let integer;
+    let fixedIntegerSizeInBits = NaN;
+    if (values.length === 1) {
+        [integer] = values;
+    }
+    else {
+        [fixedIntegerSizeInBits, integer] = values;
+        if (fixedIntegerSizeInBits <= 0 || !Number.isInteger(fixedIntegerSizeInBits)) {
+            return new Uint8Array();
+        }
+    }
+    const integerIsZeroOrInvalid = integer <= 0 || (typeof integer === "number" && !Number.isInteger(integer));
+    if (integerIsZeroOrInvalid) {
+        if (!fixedIntegerSizeInBits) {
+            return new Uint8Array();
+        }
+        integer = 0;
+    }
+    let bitString = BigInt(integer).toString(2);
+    if (bitString.length < fixedIntegerSizeInBits) {
+        bitString = bitString.padStart(fixedIntegerSizeInBits, "0");
+    }
+    const digits = Uint8Array.from(bitString);
+    if (digits.length > fixedIntegerSizeInBits) {
+        return digits.slice(-fixedIntegerSizeInBits);
+    }
+    return digits;
+}
+//# sourceMappingURL=bitsInUnsignedInteger.js.map

package/dist/integer/bitsInUnsignedInteger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitsInUnsignedInteger.js","sourceRoot":"","sources":["../../src/integer/bitsInUnsignedInteger.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,qBAAqB,CACpC,MAA+F;IAE/F,IAAI,OAAwB,CAAC;IAC7B,IAAI,sBAAsB,GAAW,GAAG,CAAC;IAEzC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;KACnB;SAAM;QACN,CAAC,sBAAsB,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;QAE3C,IAAI,sBAAsB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE;YAC7E,OAAO,IAAI,UAAU,EAAE,CAAC;SACxB;KACD;IAED,MAAM,sBAAsB,GAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7E,IAAI,sBAAsB,EAAE;QAC3B,IAAI,CAAC,sBAAsB,EAAE;YAC5B,OAAO,IAAI,UAAU,EAAE,CAAC;SACxB;QACD,OAAO,GAAG,CAAC,CAAC;KACZ;IAED,IAAI,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,SAAS,CAAC,MAAM,GAAG,sBAAsB,EAAE;QAC9C,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;KAC5D;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,SAAqD,CAAC,CAAC;IAEtF,IAAI,MAAM,CAAC,MAAM,GAAG,sBAAsB,EAAE;QAC3C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,CAAC;KAC7C;IAED,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/integer/countl_one.d.ts

@@ -0,0 +1,2 @@
+export declare function countl_one(fixedIntegerSizeInBits: number, integer: bigint | number): number;
+export declare function countl_one(integer: bigint | number): number;

package/dist/integer/countl_one.js

@@ -0,0 +1,10 @@
+import { bitsInUnsignedInteger } from "./bitsInUnsignedInteger";
+export function countl_one(...values) {
+    const digits = bitsInUnsignedInteger(values);
+    const endOfOnes = digits.indexOf(0);
+    if (endOfOnes === -1) {
+        return digits.length;
+    }
+    return endOfOnes;
+}
+//# sourceMappingURL=countl_one.js.map

package/dist/integer/countl_one.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countl_one.js","sourceRoot":"","sources":["../../src/integer/countl_one.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAShE,MAAM,UAAU,UAAU,CACzB,GAAG,MAA+F;IAElG,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC,MAAM,CAAC;KACrB;IACD,OAAO,SAAS,CAAC;AAClB,CAAC"}

package/dist/integer/countl_zero.d.ts

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

package/dist/integer/countl_zero.js

@@ -0,0 +1,10 @@
+import { bitsInUnsignedInteger } from "./bitsInUnsignedInteger";
+export function countl_zero(fixedIntegerSizeInBits, integer) {
+    const digits = bitsInUnsignedInteger([fixedIntegerSizeInBits, integer]);
+    const endOfZeroes = digits.indexOf(1);
+    if (endOfZeroes === -1) {
+        return digits.length;
+    }
+    return endOfZeroes;
+}
+//# sourceMappingURL=countl_zero.js.map

package/dist/integer/countl_zero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countl_zero.js","sourceRoot":"","sources":["../../src/integer/countl_zero.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAShE,MAAM,UAAU,WAAW,CAAC,sBAA8B,EAAE,OAAwB;IACnF,MAAM,MAAM,GAAG,qBAAqB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;IAExE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtC,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE;QACvB,OAAO,MAAM,CAAC,MAAM,CAAC;KACrB;IACD,OAAO,WAAW,CAAC;AACpB,CAAC"}

package/dist/integer/countr_one.d.ts

@@ -0,0 +1,2 @@
+export declare function countr_one(fixedIntegerSizeInBits: number, integer: bigint | number): number;
+export declare function countr_one(integer: bigint | number): number;

package/dist/integer/countr_one.js

@@ -0,0 +1,6 @@
+import { bitsInUnsignedInteger } from "./bitsInUnsignedInteger";
+export function countr_one(...values) {
+    const digits = bitsInUnsignedInteger(values);
+    return digits.length - digits.lastIndexOf(0) - 1;
+}
+//# sourceMappingURL=countr_one.js.map

package/dist/integer/countr_one.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countr_one.js","sourceRoot":"","sources":["../../src/integer/countr_one.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAUhE,MAAM,UAAU,UAAU,CACzB,GAAG,MAA+F;IAElG,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC"}

package/dist/integer/countr_zero.d.ts

@@ -0,0 +1,2 @@
+export declare function countr_zero(fixedIntegerSizeInBits: number, integer: bigint | number): number;
+export declare function countr_zero(integer: bigint | number): number;

package/dist/integer/countr_zero.js

@@ -0,0 +1,6 @@
+import { bitsInUnsignedInteger } from "./bitsInUnsignedInteger";
+export function countr_zero(...values) {
+    const digits = bitsInUnsignedInteger(values);
+    return digits.length - digits.lastIndexOf(1) - 1;
+}
+//# sourceMappingURL=countr_zero.js.map

package/dist/integer/countr_zero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countr_zero.js","sourceRoot":"","sources":["../../src/integer/countr_zero.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAUhE,MAAM,UAAU,WAAW,CAC1B,GAAG,MAA+F;IAElG,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC"}

package/dist/integer/index.d.ts

@@ -1 +1,6 @@
 export { abs } from "./abs.js";
+export { countl_one } from "./countl_one.js";
+export { countl_zero } from "./countl_zero.js";
+export { countr_one } from "./countr_one.js";
+export { countr_zero } from "./countr_zero.js";
+export { popcount } from "./popcount.js";

package/dist/integer/index.js

@@ -1,2 +1,7 @@
 export { abs } from "./abs.js";
+export { countl_one } from "./countl_one.js";
+export { countl_zero } from "./countl_zero.js";
+export { countr_one } from "./countr_one.js";
+export { countr_zero } from "./countr_zero.js";
+export { popcount } from "./popcount.js";
 //# sourceMappingURL=index.js.map

package/dist/integer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/integer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/integer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}

package/dist/integer/popcount.d.ts

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

package/dist/integer/popcount.js

@@ -0,0 +1,11 @@
+export function popcount(integer) {
+    if (integer <= 0 || (typeof integer === "number" && !Number.isInteger(integer))) {
+        return 0;
+    }
+    let count = 0;
+    for (const digit of BigInt(integer).toString(2)) {
+        count += Number(digit);
+    }
+    return count;
+}
+//# sourceMappingURL=popcount.js.map

package/dist/integer/popcount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"popcount.js","sourceRoot":"","sources":["../../src/integer/popcount.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAChD,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE;QAChF,OAAO,CAAC,CAAC;KACT;IACD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;QAChD,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;KACvB;IACD,OAAO,KAAK,CAAC;AACd,CAAC"}

package/package.json

@@ -5,7 +5,7 @@
 		"type": "git",
 		"url": "git+https://github.com/oskarlh/cmath-js.git"
 	},
-	"version": "1.0.17",
+	"version": "1.0.18",
 	"exports": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"type": "module",