@nberlette/math 0.7.0

package/esm/sin.js

@@ -0,0 +1,28 @@
+/**
+ * Calculates the sine of a number, returning a value in the range `[-1, 1]`.
+ *
+ * @module sin
+ */
+import { abs } from "./abs.js";
+import { EPSILON } from "./constants/epsilon.js";
+import { NAN } from "./constants/nan.js";
+import { isFinite } from "./guards/finite.js";
+/**
+ * Calculates the sine of a number, returning a value in the range `[-1, 1]`.
+ *
+ * @param x The angle in radians whose sine is to be calculated.
+ * @returns The sine of the provided angle.
+ * @category Trigonometry
+ */
+export function sin(x) {
+    if (!isFinite(x))
+        return NAN;
+    let sum = (x = +x), term = x, n = 1;
+    while (abs(term) > EPSILON) {
+        n += 2;
+        term *= -x * x / (n * (n - 1));
+        sum += term;
+    }
+    return sum;
+}
+//# sourceMappingURL=sin.js.map

package/esm/sin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sin.js","sourceRoot":"","sources":["../src/sin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAS;IAC3B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IAE7B,IAAI,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,EAAE,CAAC;QAC3B,CAAC,IAAI,CAAC,CAAC;QACP,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/B,GAAG,IAAI,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/esm/sinh.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Calculates the hyperbolic sine of a number.
+ *
+ * @module sinh
+ */
+/**
+ * Calculates the hyperbolic sine of a number.
+ *
+ * @param x The number whose hyperbolic sine is to be calculated.
+ * @returns The hyperbolic sine of the provided number.
+ * @category Trigonometry
+ */
+export declare function sinh(x: number): number;
+//# sourceMappingURL=sinh.d.ts.map

package/esm/sinh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinh.d.ts","sourceRoot":"","sources":["../src/sinh.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAGtC"}

package/esm/sinh.js

@@ -0,0 +1,19 @@
+/**
+ * Calculates the hyperbolic sine of a number.
+ *
+ * @module sinh
+ */
+import { exp } from "./exp.js";
+/**
+ * Calculates the hyperbolic sine of a number.
+ *
+ * @param x The number whose hyperbolic sine is to be calculated.
+ * @returns The hyperbolic sine of the provided number.
+ * @category Trigonometry
+ */
+export function sinh(x) {
+    if (x === 0)
+        return x;
+    return (exp(x) - exp(-x)) / 2;
+}
+//# sourceMappingURL=sinh.js.map

package/esm/sinh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinh.js","sourceRoot":"","sources":["../src/sinh.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,CAAS;IAC5B,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC"}

package/esm/sqrt.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Calculates the square root of a number.
+ *
+ * @param x The number to calculate the square root of
+ * @returns The square root of the provided number.
+ * @example
+ * ```ts
+ * import * as math from "@nick/math";
+ *
+ * math.sqrt(4); // 2
+ * math.sqrt(16); // 4
+ * math.sqrt(0); // 0
+ * math.sqrt(1); // 1
+ * math.sqrt(-1); // NaN
+ * math.sqrt(-4); // NaN
+ * ```
+ */
+export declare function sqrt(x: number): number;
+//# sourceMappingURL=sqrt.d.ts.map

package/esm/sqrt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqrt.d.ts","sourceRoot":"","sources":["../src/sqrt.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAYtC"}

package/esm/sqrt.js

@@ -0,0 +1,42 @@
+/**
+ * Calculates the square root of a number.
+ *
+ * @module sqrt
+ */
+import { EPSILON } from "./constants/epsilon.js";
+import { NAN } from "./constants/nan.js";
+import { POSITIVE_INFINITY } from "./constants/positive_infinity.js";
+import { abs } from "./abs.js";
+/**
+ * Calculates the square root of a number.
+ *
+ * @param x The number to calculate the square root of
+ * @returns The square root of the provided number.
+ * @example
+ * ```ts
+ * import * as math from "@nick/math";
+ *
+ * math.sqrt(4); // 2
+ * math.sqrt(16); // 4
+ * math.sqrt(0); // 0
+ * math.sqrt(1); // 1
+ * math.sqrt(-1); // NaN
+ * math.sqrt(-4); // NaN
+ * ```
+ */
+export function sqrt(x) {
+    if (x < 0)
+        return NAN; // negative numbers have no real square root
+    if (x === 0 || x === 1)
+        return x; // sqrt(0) = 0, sqrt(1) = 1
+    if (x === POSITIVE_INFINITY)
+        return x;
+    // use Newton's method to approximate the square root
+    let z = x / 2, prev;
+    do {
+        prev = z;
+        z = (z + x / z) / 2;
+    } while (abs(z - prev) > EPSILON);
+    return z;
+}
+//# sourceMappingURL=sqrt.js.map

package/esm/sqrt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqrt.js","sourceRoot":"","sources":["../src/sqrt.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,IAAI,CAAC,CAAS;IAC5B,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,4CAA4C;IACnE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC,2BAA2B;IAC7D,IAAI,CAAC,KAAK,iBAAiB;QAAE,OAAO,CAAC,CAAC;IAEtC,qDAAqD;IACrD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IACpB,GAAG,CAAC;QACF,IAAI,GAAG,CAAC,CAAC;QACT,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE;IAClC,OAAO,CAAC,CAAC;AACX,CAAC"}

package/esm/tan.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Calculates the tangent of a number, returning a value in range `[-∞, +∞]`.
+ *
+ * @param x The angle in radians whose tangent is to be calculated.
+ * @returns The tangent of the provided angle.
+ * @category Trigonometry
+ */
+export declare function tan(x: number): number;
+//# sourceMappingURL=tan.d.ts.map

package/esm/tan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tan.d.ts","sourceRoot":"","sources":["../src/tan.ts"],"names":[],"mappings":"AAWA;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrC"}

package/esm/tan.js

@@ -0,0 +1,23 @@
+/**
+ * Calculates the tangent of `x`, returning a value in the range `[-∞, +∞]`.
+ *
+ * @category Trigonometry
+ * @module tan
+ */
+import { NAN } from "./constants/nan.js";
+import { isFinite } from "./guards/finite.js";
+import { cos } from "./cos.js";
+import { sin } from "./sin.js";
+/**
+ * Calculates the tangent of a number, returning a value in range `[-∞, +∞]`.
+ *
+ * @param x The angle in radians whose tangent is to be calculated.
+ * @returns The tangent of the provided angle.
+ * @category Trigonometry
+ */
+export function tan(x) {
+    if (!isFinite(x))
+        return NAN;
+    return sin(x) / cos(x);
+}
+//# sourceMappingURL=tan.js.map

package/esm/tan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tan.js","sourceRoot":"","sources":["../src/tan.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAS;IAC3B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IAC7B,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC"}

package/esm/tanh.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Calculates the hyperbolic tangent of a number, returning a value in the
+ * range `[-1, 1]`.
+ *
+ * @category Trigonometry
+ * @module tanh
+ */
+/**
+ * Calculates the hyperbolic tangent of a number, returning a value in the
+ * range `[-1, 1]`.
+ *
+ * @param x The number whose hyperbolic tangent is to be calculated.
+ * @returns The hyperbolic tangent of the provided number.
+ * @category Trigonometry
+ */
+export declare function tanh(x: number): number;
+//# sourceMappingURL=tanh.d.ts.map

package/esm/tanh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanh.d.ts","sourceRoot":"","sources":["../src/tanh.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAOH;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMtC"}

package/esm/tanh.js

@@ -0,0 +1,31 @@
+/**
+ * Calculates the hyperbolic tangent of a number, returning a value in the
+ * range `[-1, 1]`.
+ *
+ * @category Trigonometry
+ * @module tanh
+ */
+import { exp } from "./exp.js";
+import { isNaN, NAN } from "./guards/nan.js";
+import { isPositiveInfinity } from "./guards/positive_infinity.js";
+import { isNegativeInfinity } from "./guards/negative_infinity.js";
+/**
+ * Calculates the hyperbolic tangent of a number, returning a value in the
+ * range `[-1, 1]`.
+ *
+ * @param x The number whose hyperbolic tangent is to be calculated.
+ * @returns The hyperbolic tangent of the provided number.
+ * @category Trigonometry
+ */
+export function tanh(x) {
+    if (x === 0)
+        return x;
+    if (isNaN(x))
+        return NAN;
+    if (isPositiveInfinity(x))
+        return 1;
+    if (isNegativeInfinity(x))
+        return -1;
+    return (exp(x) - exp(-x)) / (exp(x) + exp(-x));
+}
+//# sourceMappingURL=tanh.js.map

package/esm/tanh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanh.js","sourceRoot":"","sources":["../src/tanh.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAC,CAAS;IAC5B,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACtB,IAAI,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IACzB,IAAI,kBAAkB,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IACpC,IAAI,kBAAkB,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjD,CAAC"}

package/esm/trunc.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Truncates a number to an integer, removing any fractional digits.
+ *
+ * This is a local implementation of the native `Math.trunc` function.
+ *
+ * @param x The number to truncate
+ * @returns The integer part of the provided number.
+ * @category Rounding
+ * @example
+ * ```ts
+ * import * as math from "@nick/math";
+ *
+ * math.trunc(13.37); // 13
+ * math.trunc(42.195); // 42
+ * math.trunc(-7.8); // -7
+ * math.trunc(-0.123); // 0
+ * math.trunc(0); // 0
+ * ```
+ */
+export declare function trunc(x: number): number;
+//# sourceMappingURL=trunc.d.ts.map

package/esm/trunc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trunc.d.ts","sourceRoot":"","sources":["../src/trunc.ts"],"names":[],"mappings":"AAkBA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMvC"}

package/esm/trunc.js

@@ -0,0 +1,47 @@
+/**
+ * Truncates a number to an integer, removing any fractional digits.
+ *
+ * @example
+ * ```ts
+ * import * as math from "@nick/math";
+ *
+ * math.trunc(13.37); // 13
+ * math.trunc(42.195); // 42
+ * math.trunc(-7.8); // -7
+ * math.trunc(-0.123); // 0
+ * math.trunc(0); // 0
+ * ```
+ * @module trunc
+ */
+import { ceil } from "./ceil.js";
+import { floor } from "./floor.js";
+/**
+ * Truncates a number to an integer, removing any fractional digits.
+ *
+ * This is a local implementation of the native `Math.trunc` function.
+ *
+ * @param x The number to truncate
+ * @returns The integer part of the provided number.
+ * @category Rounding
+ * @example
+ * ```ts
+ * import * as math from "@nick/math";
+ *
+ * math.trunc(13.37); // 13
+ * math.trunc(42.195); // 42
+ * math.trunc(-7.8); // -7
+ * math.trunc(-0.123); // 0
+ * math.trunc(0); // 0
+ * ```
+ */
+export function trunc(x) {
+    x = +x;
+    if (x !== x)
+        return x;
+    if (x === 0)
+        return x;
+    if (x > -1 && x < 0)
+        return -0;
+    return x < 0 ? ceil(x) : floor(x);
+}
+//# sourceMappingURL=trunc.js.map

package/esm/trunc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trunc.js","sourceRoot":"","sources":["../src/trunc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,KAAK,CAAC,CAAS;IAC7B,CAAC,GAAG,CAAC,CAAC,CAAC;IACP,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}

package/esm/types/finite.d.ts

@@ -0,0 +1,16 @@
+import type { NEGATIVE_INFINITY, POSITIVE_INFINITY } from "../constants/infinity.js";
+import type { NAN } from "../constants/nan.js";
+declare const Finite: unique symbol;
+interface IsFinite {
+    readonly [Finite]: never;
+}
+/**
+ * Branded nominal type that represents a finite number, which is a real number
+ * that is not infinite or `NaN`.
+ *
+ * @category Types
+ * @tags number, nominal, finite
+ */
+export type Finite<N extends number = number> = (Exclude<N, NAN | POSITIVE_INFINITY | NEGATIVE_INFINITY> & IsFinite) extends infer U extends N ? U : never;
+export {};
+//# sourceMappingURL=finite.d.ts.map

package/esm/types/finite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"finite.d.ts","sourceRoot":"","sources":["../../src/types/finite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE/C,QAAA,MAAM,MAAM,EAAE,OAAO,MAAyB,CAAC;AAE/C,UAAU,QAAQ;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAC5C,OAAO,CAAC,CAAC,EAAE,GAAG,GAAG,iBAAiB,GAAG,iBAAiB,CAAC,GACvD,QAAQ,CACX,SAAS,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC"}

package/esm/types/finite.js

@@ -0,0 +1,3 @@
+const Finite = Symbol("Finite");
+export {};
+//# sourceMappingURL=finite.js.map

package/esm/types/finite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finite.js","sourceRoot":"","sources":["../../src/types/finite.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,GAAkB,MAAM,CAAC,QAAQ,CAAC,CAAC"}

package/esm/types/float.d.ts

@@ -0,0 +1,65 @@
+/**
+ * This module provides nominal (branded) types for working with floating-point
+ * numbers of various precisions, which can be used to enforce type safety and
+ * prevent accidental mixing of floating-point values of different precisions.
+ *
+ * The types provided by this module are branded with unique symbols that are
+ * specific to floating-point numbers, and are designed to be used as generic
+ * type arguments to other functions and classes that work with floats.
+ *
+ * @module types/float
+ */
+import type { FloatPrecision, P32 } from "./precision.js";
+declare const Float: unique symbol;
+interface IsFloat<N extends FloatPrecision> {
+    readonly [Float]: N;
+}
+/**
+ * Represents a floating-point number `N`, branded with the precision specified
+ * by the generic type argument `P` (default: 32).
+ *
+ * This is a branded nominal type that accepts an optional generic type
+ * argument. When passed a literal number, it will "brand" it with an
+ * unforgeable unique symbol that is specific to floating points.
+ *
+ * @template {number} [N=number] The type of numeric value to check.
+ * @template {FloatPrecision} [P=P32] Precision of the floating-point number.
+ * @category Types
+ * @tags Float, Branded
+ */
+export type Float<N extends number = number, P extends FloatPrecision = P32> = number extends N ? number & IsFloat<P> : `${N}` extends `${bigint}` ? N extends 0 ? N & IsFloat<P> : never : N & IsFloat<P>;
+/**
+ * Represents floating-point numbers of 16-bit precision.
+ *
+ * This is a branded nominal type that accepts an optional generic type
+ * argument. When passed a literal number, it will "brand" it with an
+ * unforgeable unique symbol that is specific to 16-bit floating points.
+ *
+ * @category Types
+ * @tags Float, 16-bit, Branded
+ */
+export type Float16<N extends number = number> = Float<N, 16>;
+/**
+ * Represents floating-point numbers of 32-bit precision.
+ *
+ * This is a branded nominal type that accepts an optional generic type
+ * argument. When passed a literal number, it will "brand" it with an
+ * unforgeable unique symbol that is specific to 32-bit floating points.
+ *
+ * @category Types
+ * @tags Float, 32-bit, Branded
+ */
+export type Float32<N extends number = number> = Float<N, 32>;
+/**
+ * Represents floating-point numbers of 64-bit precision.
+ *
+ * This is a branded nominal type that accepts an optional generic type
+ * argument. When passed a literal number, it will "brand" it with an
+ * unforgeable unique symbol that is specific to 64-bit floating points.
+ *
+ * @category Types
+ * @tags Float, 64-bit, Branded
+ */
+export type Float64<N extends number = number> = Float<N, 64>;
+export type { Float64 as Double };
+//# sourceMappingURL=float.d.ts.map

package/esm/types/float.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"float.d.ts","sourceRoot":"","sources":["../../src/types/float.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE1D,QAAA,MAAM,KAAK,EAAE,OAAO,MAAwB,CAAC;AAE7C,UAAU,OAAO,CAAC,CAAC,SAAS,cAAc;IACxC,QAAQ,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;CACrB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,cAAc,GAAG,GAAG,IACzE,MAAM,SAAS,CAAC,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,GAClC,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,GACjE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAErB;;;;;;;;;GASG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE9D;;;;;;;;;GASG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE9D;;;;;;;;;GASG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAE9D,YAAY,EAAE,OAAO,IAAI,MAAM,EAAE,CAAC"}

package/esm/types/float.js

@@ -0,0 +1,3 @@
+const Float = Symbol("Float");
+export {};
+//# sourceMappingURL=float.js.map

package/esm/types/float.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"float.js","sourceRoot":"","sources":["../../src/types/float.ts"],"names":[],"mappings":"AAaA,MAAM,KAAK,GAAkB,MAAM,CAAC,OAAO,CAAC,CAAC"}

package/esm/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./finite.js";
+export * from "./float.js";
+export * from "./integer.js";
+export * from "./precision.js";
+export * from "./safe_integer.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC"}

package/esm/types/index.js

@@ -0,0 +1,6 @@
+export * from "./finite.js";
+export * from "./float.js";
+export * from "./integer.js";
+export * from "./precision.js";
+export * from "./safe_integer.js";
+//# sourceMappingURL=index.js.map

package/esm/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC"}

package/esm/types/integer.d.ts

@@ -0,0 +1,147 @@
+/**
+ * This module provides branded nominal types for signed and unsigned integers
+ * of various precisions, as well as bigints for 64-bit integers.
+ *
+ * @module types/integer
+ */
+import type { P32, Precision } from "./precision.js";
+declare const Integer: unique symbol;
+declare const Unsigned: unique symbol;
+interface IsInt<N extends Precision = P32> {
+    readonly [Integer]: N;
+}
+interface IsUint<N extends Precision = P32> extends IsInt<N> {
+    readonly [Unsigned]: true;
+}
+/**
+ * Represents a signed/unsigned integer of a specific precision (default: 32).
+ *
+ * This type can be provided with a literal number for its first type argument,
+ * which will be checked at compile-time to ensure it is a valid integer.
+ *
+ * There is currently no realistic solution for checking that the value is
+ * within the range of the specified precision, so that part is left up to the
+ * runtime. This type will, however, brand the number with a unique symbol for
+ * the specified precision level `P`, preventing other numbers of different
+ * precisions from being assigned to the same variable/parameter.
+ *
+ * If you need to allow multiple precisions or multiple numbers, simply provide
+ * a union of the desired types to each of the type parameters.
+ *
+ * @category Types
+ * @tags integer, nominal
+ * @see {@linkcode Unsigned} for unsigned integers.
+ */
+export type Integer<N extends number = number, P extends Precision = P32> = number extends N ? number & IsInt<P> : `${N}` extends `${bigint}` ? N & IsInt<P> : never;
+/**
+ * Represents an unsigned integer of a specific precision (default: 32).
+ *
+ * This type can be provided with a literal number for its first type argument,
+ * which will be checked at compile-time to ensure it is a positive integer.
+ *
+ * There is currently no realistic solution for checking that the value is
+ * within the range of the specified precision, so that part is left up to the
+ * runtime. This type will, however, brand the number with a unique symbol for
+ * the specified precision level `P`, preventing other numbers of different
+ * precisions from being assigned to the same variable/parameter.
+ *
+ * If you need to allow multiple precisions or multiple numbers, simply provide
+ * a union of the desired types to each of the type parameters.
+ *
+ * @category Types
+ * @tags integer, nominal, unsigned
+ * @see {@linkcode Integer} for signed/unsigned integers.
+ */
+export type Unsigned<N extends number = number, P extends Precision = P32> = number extends N ? number & IsUint<P> : `${N}` extends `${bigint}` ? `${N}` extends `-${string}` ? never : N & IsUint<P> : never;
+/**
+ * Represents a signed/unsigned 8-bit integer. When given a number, this will
+ * verify it is an integer and brand it with the `Int8` symbol.
+ *
+ * @see {@linkcode Integer} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, int8
+ */
+export type Int8<N extends number = number> = N & IsInt<8>;
+/**
+ * Represents an unsigned 8-bit integer. When given a number, this will verify
+ * it is an integer and brand it with the `Uint8` symbol.
+ *
+ * @see {@linkcode Unsigned} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, unsigned, uint8
+ */
+export type Uint8<N extends number = number> = N & IsUint<8>;
+/**
+ * Represents a signed/unsigned 16-bit integer. When given a number, this will
+ * verify it is an integer and brand it with the `Int16` symbol.
+ *
+ * @see {@linkcode Integer} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, int16
+ */
+export type Int16<N extends number = number> = N & IsInt<16>;
+/**
+ * Represents an unsigned 16-bit integer. When given a number, this will verify
+ * it is an integer and brand it with the `Uint16` symbol.
+ *
+ * @see {@linkcode Unsigned} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, unsigned, uint16
+ */
+export type Uint16<N extends number = number> = N & IsUint<16>;
+/**
+ * Represents a signed/unsigned 32-bit integer. When given a number, this will
+ * verify it is an integer and brand it with the `Int32` symbol.
+ *
+ * @see {@linkcode Integer} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, int32
+ */
+export type Int32<N extends number = number> = N & IsInt<32>;
+/**
+ * Represents an unsigned 32-bit integer. When given a number, this will verify
+ * it is an integer and brand it with the `Uint32` symbol.
+ *
+ * @see {@linkcode Unsigned} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, unsigned, uint32
+ */
+export type Uint32<N extends number = number> = N & IsUint<32>;
+/**
+ * Represents a signed/unsigned 64-bit integer. When given a number, this will
+ * verify it is an integer and brand it with the `Int64` symbol.
+ *
+ * @see {@linkcode Integer} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, int64
+ */
+export type Int64<N extends number = number> = N & IsInt<64>;
+/**
+ * Represents an unsigned 64-bit integer. When given a number, this will verify
+ * it is an integer and brand it with the `Uint64` symbol.
+ *
+ * @see {@linkcode Unsigned} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, nominal, unsigned, uint64
+ */
+export type Uint64<N extends number = number> = N & IsUint<64>;
+/**
+ * Represents a signed/unsigned 64-bit bigint. This is like {@linkcode Int64},
+ * but for bigints instead of numbers.
+ *
+ * @see {@linkcode Integer} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, bigint, nominal
+ */
+export type BigInt64<I extends bigint = bigint> = I & IsInt<64>;
+/**
+ * Represents an unsigned 64-bit bigint. This is like {@linkcode Uint64}, but
+ * for bigints instead of numbers.
+ *
+ * @see {@linkcode Unsigned} for more information about how nominal types work.
+ * @category Types
+ * @tags integer, bigint, nominal, unsigned
+ */
+export type BigUint64<I extends bigint = bigint> = I & IsUint<64>;
+export {};
+//# sourceMappingURL=integer.d.ts.map

package/esm/types/integer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integer.d.ts","sourceRoot":"","sources":["../../src/types/integer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAErD,QAAA,MAAM,OAAO,EAAE,OAAO,MAA0B,CAAC;AACjD,QAAA,MAAM,QAAQ,EAAE,OAAO,MAA2B,CAAC;AAEnD,UAAU,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,GAAG;IACvC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;CACvB;AAED,UAAU,MAAM,CAAC,CAAC,SAAS,SAAS,GAAG,GAAG,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAC1D,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,SAAS,GAAG,GAAG,IACtE,MAAM,SAAS,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAChC,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GACzC,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,SAAS,GAAG,GAAG,IACvE,MAAM,SAAS,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GACjC,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,SAAS,IAAI,MAAM,EAAE,GAAG,KAAK,GAC9D,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GACf,KAAK,CAAC;AAEZ;;;;;;;GAOG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC"}

package/esm/types/integer.js

@@ -0,0 +1,4 @@
+const Integer = Symbol("Integer");
+const Unsigned = Symbol("Unsigned");
+export {};
+//# sourceMappingURL=integer.js.map

package/esm/types/integer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integer.js","sourceRoot":"","sources":["../../src/types/integer.ts"],"names":[],"mappings":"AAQA,MAAM,OAAO,GAAkB,MAAM,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,QAAQ,GAAkB,MAAM,CAAC,UAAU,CAAC,CAAC"}