cmath-js 2.0.1 → 3.0.0

package/README.md

@@ -15,13 +15,21 @@ Implementation of parts of C's & C++'s numerics libraries in TypeScript/JavaScri
 These functions accept either a `bigint` or an integer `number`:
 - [`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)
+- [`countl_zero`](https://en.cppreference.com/w/cpp/numeric/countl_zero) in the form of
+	```ts
+	import { create_countl_zero } from "cmath-js";
+	const countl_zero_u16 = create_countl_zero({ bits: 16 });
+	const integer = 0x0FFF;
+	// Prints "0000111111111111 has 4 leading zero bits."
+	console.log(`${integer.toString(2).padStart(16, "0")} has ${countl_zero_u16(integer)} leading zero bits.`);
+	```
 - [`countr_one`](https://en.cppreference.com/w/cpp/numeric/countr_one)
 - [`countr_zero`](https://en.cppreference.com/w/cpp/numeric/countr_zero)
 - [`div`](https://en.cppreference.com/w/cpp/numeric/math/div)
 - [`gcd`](https://en.cppreference.com/w/cpp/numeric/gcd). Example:
 	```ts
 	import { gcd } from "cmath-js";
+	// Prints "The greatest common divisor of 24 and 32 is 8."
 	console.log(`The greatest common divisor of 24 and 32 is ${gcd(24, 32)}.`);
 	```
 - [`lcm`](https://en.cppreference.com/w/cpp/numeric/lcm)

package/dist/internal/index.d.ts

@@ -1,3 +1,5 @@
 export { bitsInUnsignedInteger } from "./bitsInUnsignedInteger.js";
 export { floatFromBits } from "./floatFromBits.js";
 export { floatOctets } from "./floatOctets.js";
+export { sanitizeSmallUnsignedInteger } from "./sanitizeSmallUnsignedInteger.js";
+export { sanitizeUnsignedInteger } from "./sanitizeUnsignedInteger.js";

package/dist/internal/index.js

@@ -1,4 +1,6 @@
 export { bitsInUnsignedInteger } from "./bitsInUnsignedInteger.js";
 export { floatFromBits } from "./floatFromBits.js";
 export { floatOctets } from "./floatOctets.js";
+export { sanitizeSmallUnsignedInteger } from "./sanitizeSmallUnsignedInteger.js";
+export { sanitizeUnsignedInteger } from "./sanitizeUnsignedInteger.js";
 //# sourceMappingURL=index.js.map

package/dist/internal/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/internal/sanitizeSmallUnsignedInteger.d.ts

@@ -0,0 +1 @@
+export declare function sanitizeSmallUnsignedInteger(someNumber: number): number;

package/dist/internal/sanitizeSmallUnsignedInteger.js

@@ -0,0 +1,7 @@
+export function sanitizeSmallUnsignedInteger(someNumber) {
+    if (Number.isInteger(someNumber) && someNumber > 0) {
+        return someNumber;
+    }
+    return 0;
+}
+//# sourceMappingURL=sanitizeSmallUnsignedInteger.js.map

package/dist/internal/sanitizeSmallUnsignedInteger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitizeSmallUnsignedInteger.js","sourceRoot":"","sources":["../../src/internal/sanitizeSmallUnsignedInteger.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,4BAA4B,CAAC,UAAkB;IAC9D,IAAI,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,UAAU,CAAC;IACnB,CAAC;IACD,OAAO,CAAC,CAAC;AACV,CAAC"}

package/dist/internal/sanitizeUnsignedInteger.d.ts

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

package/dist/internal/sanitizeUnsignedInteger.js

@@ -0,0 +1,11 @@
+import { sanitizeSmallUnsignedInteger } from "./index.js";
+export function sanitizeUnsignedInteger(someNumber) {
+    if (typeof someNumber === "bigint") {
+        if (someNumber < 0n) {
+            return 0n;
+        }
+        return someNumber;
+    }
+    return BigInt(sanitizeSmallUnsignedInteger(someNumber));
+}
+//# sourceMappingURL=sanitizeUnsignedInteger.js.map

package/dist/internal/sanitizeUnsignedInteger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitizeUnsignedInteger.js","sourceRoot":"","sources":["../../src/internal/sanitizeUnsignedInteger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,UAAU,uBAAuB,CAAC,UAA2B;IAClE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACpC,IAAI,UAAU,GAAG,EAAE,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,UAAU,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,4BAA4B,CAAC,UAAU,CAAC,CAAC,CAAC;AACzD,CAAC"}

package/dist/namespace-std/integers/countr_one.d.ts

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

package/dist/namespace-std/integers/countr_one.js

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

package/dist/namespace-std/integers/countr_one.js.map

@@ -1 +1 @@
-{"version":3,"file":"countr_one.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/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"}
+{"version":3,"file":"countr_one.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/countr_one.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAqBpF,MAAM,UAAU,UAAU,CAAC,OAAwB;IAClD,MAAM,MAAM,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACpD,CAAC"}

package/dist/namespace-std/integers/create_countl_zero.d.ts

@@ -0,0 +1,4 @@
+export type countl_zero_function = (integer: bigint | number) => number;
+export declare function create_countl_zero(options: {
+    bits: number;
+}): countl_zero_function;

package/dist/namespace-std/integers/create_countl_zero.js

@@ -0,0 +1,12 @@
+import { sanitizeSmallUnsignedInteger, sanitizeUnsignedInteger } from "../../internal/index.js";
+export function create_countl_zero(options) {
+    const bits = sanitizeSmallUnsignedInteger(options.bits);
+    return (integer) => {
+        const truncated = BigInt.asUintN(bits, sanitizeUnsignedInteger(integer));
+        if (truncated === 0n) {
+            return bits;
+        }
+        return bits - truncated.toString(2).length;
+    };
+}
+//# sourceMappingURL=create_countl_zero.js.map

package/dist/namespace-std/integers/create_countl_zero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_countl_zero.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/create_countl_zero.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AA4BhG,MAAM,UAAU,kBAAkB,CAAC,OAQlC;IACA,MAAM,IAAI,GAAG,4BAA4B,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,OAAO,CAAC,OAAwB,EAAU,EAAE;QAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACb,CAAC;QACD,OAAO,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5C,CAAC,CAAC;AACH,CAAC"}

package/dist/namespace-std/integers/div/div.d.ts

@@ -1,8 +1,7 @@
 import { type div_t_bigint } from "./div_bigint.js";
 import { type div_t_number } from "./div_number.js";
-export interface div_t<NumType extends bigint | number = bigint | number> {
-    quot: NumType;
-    rem: NumType;
-}
+type AnyInteger = bigint | number;
+export type div_t<NumType extends AnyInteger = AnyInteger> = (NumType extends bigint ? div_t_bigint : div_t_number) & (NumType extends number ? div_t_number : div_t_bigint);
 export declare function div(aInteger: bigint, bInteger: bigint): div_t_bigint;
 export declare function div(aInteger: number, bInteger: number): div_t_number;
+export {};

package/dist/namespace-std/integers/div/div.js.map

@@ -1 +1 @@
-{"version":3,"file":"div.js","sourceRoot":"","sources":["../../../../src/namespace-std/integers/div/div.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAqB,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAqB,MAAM,iBAAiB,CAAC;AAShE,MAAM,UAAU,GAAG,CAClB,QAAyB,EACzB,QAAyB;IAEzB,OAAO,OAAO,QAAQ,KAAK,QAAQ;QAClC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAkB,CAAC;QAC1C,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAkB,CAAC,CAAC;AAC7C,CAAC"}
+{"version":3,"file":"div.js","sourceRoot":"","sources":["../../../../src/namespace-std/integers/div/div.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAqB,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAqB,MAAM,iBAAiB,CAAC;AAWhE,MAAM,UAAU,GAAG,CAA6B,QAAiB,EAAE,QAAiB;IACnF,OAAO,OAAO,QAAQ,KAAK,QAAQ;QAClC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAkB,CAAC;QAC1C,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAkB,CAAC,CAAC;AAC7C,CAAC"}

package/dist/namespace-std/integers/index.d.ts

@@ -1,6 +1,6 @@
 export { abs } from "./abs.js";
 export { countl_one } from "./countl_one.js";
-export { countl_zero } from "./countl_zero.js";
+export { create_countl_zero, type countl_zero_function } from "./create_countl_zero.js";
 export { countr_one } from "./countr_one.js";
 export { countr_zero } from "./countr_zero.js";
 export { div, type div_t, type div_t_bigint, type div_t_number } from "./div/index.js";

package/dist/namespace-std/integers/index.js

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

package/dist/namespace-std/integers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/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,GAAG,EAAoD,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAA6B,MAAM,yBAAyB,CAAC;AACxF,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,GAAG,EAAoD,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}

package/package.json

@@ -5,7 +5,7 @@
 		"type": "git",
 		"url": "git+https://github.com/oskarlh/cmath-js.git"
 	},
-	"version": "2.0.1",
+	"version": "3.0.0",
 	"exports": {
 		".": {
 			"default": "./dist/index.js",

package/dist/namespace-std/integers/countl_zero.d.ts

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

package/dist/namespace-std/integers/countl_zero.js

@@ -1,10 +0,0 @@
-import { bitsInUnsignedInteger } from "../../internal/index.js";
-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/namespace-std/integers/countl_zero.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"countl_zero.js","sourceRoot":"","sources":["../../../src/namespace-std/integers/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,CAAC;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,WAAW,CAAC;AACpB,CAAC"}