@nberlette/math 0.7.0 → 0.7.1

package/esm/constants/epsilon.js

@@ -8,6 +8,13 @@
  * This is approximately equal to `2.220446049250313e-16`, and is provided as a
  * local implementation of the native `Number.EPSILON` constant.
  *
+ * @example
+ * ```ts
+ * import { EPSILON } from "@nick/math/constants/epsilon";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(EPSILON, Number.EPSILON);
+ * ```
  * @module epsilon
  */
 /**

package/esm/constants/epsilon.js.map

@@ -1 +1 @@
-{"version":3,"file":"epsilon.js","sourceRoot":"","sources":["../../src/constants/epsilon.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAY,qBAAqB,CAAC"}
+{"version":3,"file":"epsilon.js","sourceRoot":"","sources":["../../src/constants/epsilon.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAY,qBAAqB,CAAC"}

package/esm/constants/index.d.ts

@@ -1,6 +1,15 @@
 /**
  * This module re-exports all of the `@nick/math/constants/*` submodules.
  *
+ * @example
+ * ```ts
+ * import { E, PI } from "@nick/math/constants";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(E, Math.E);
+ * assert.strictEqual(PI, Math.PI);
+ * ```
+ * @category Constants
  * @module constants
  */
 export * from "./e.js";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/esm/constants/index.js

@@ -1,6 +1,15 @@
 /**
  * This module re-exports all of the `@nick/math/constants/*` submodules.
  *
+ * @example
+ * ```ts
+ * import { E, PI } from "@nick/math/constants";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(E, Math.E);
+ * assert.strictEqual(PI, Math.PI);
+ * ```
+ * @category Constants
  * @module constants
  */
 export * from "./e.js";

package/esm/constants/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/esm/constants/infinity.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Re-exports the positive and negative infinity constants and their
+ * matching type aliases from the constants submodules.
+ *
+ * @example
+ * ```ts
+ * import { NEGATIVE_INFINITY, POSITIVE_INFINITY } from "@nick/math/constants/infinity";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(POSITIVE_INFINITY, Number.POSITIVE_INFINITY);
+ * assert.strictEqual(NEGATIVE_INFINITY, Number.NEGATIVE_INFINITY);
+ * ```
+ * @category Constants
+ * @module constants/infinity
+ */
 export * from "./positive_infinity.js";
 export * from "./negative_infinity.js";
 //# sourceMappingURL=infinity.d.ts.map

package/esm/constants/infinity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"infinity.d.ts","sourceRoot":"","sources":["../../src/constants/infinity.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"infinity.d.ts","sourceRoot":"","sources":["../../src/constants/infinity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC"}

package/esm/constants/infinity.js

@@ -1,3 +1,18 @@
+/**
+ * Re-exports the positive and negative infinity constants and their
+ * matching type aliases from the constants submodules.
+ *
+ * @example
+ * ```ts
+ * import { NEGATIVE_INFINITY, POSITIVE_INFINITY } from "@nick/math/constants/infinity";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(POSITIVE_INFINITY, Number.POSITIVE_INFINITY);
+ * assert.strictEqual(NEGATIVE_INFINITY, Number.NEGATIVE_INFINITY);
+ * ```
+ * @category Constants
+ * @module constants/infinity
+ */
 export * from "./positive_infinity.js";
 export * from "./negative_infinity.js";
 //# sourceMappingURL=infinity.js.map

package/esm/constants/infinity.js.map

@@ -1 +1 @@
-{"version":3,"file":"infinity.js","sourceRoot":"","sources":["../../src/constants/infinity.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"infinity.js","sourceRoot":"","sources":["../../src/constants/infinity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC"}

package/esm/constants/ln10.d.ts

@@ -1,10 +1,54 @@
 /**
- * Represents the natural logarithm of `10`, approximately equal to
- * `2.302585092994046`.
+ * This module provides runtime and type-level implementations of the `LN10`
+ * constant found in the native `Math` namespace, which represents the natural
+ * logarithm of the number `10` (approximately equal to `2.302585092994046`).
  *
- * This is a local implementation of the native `Math.LN10` constant.
+ * The `LN10` constant exported by this module can be imported using a standard
+ * named import (i.e., at the _value_ level), or via a type-only import for a
+ * compile-time only reference to the same value.
+ *
+ * @example
+ * ```ts
+ * import { LN10 } from "@nick/math/constants/ln10";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN10, 2.302585092994046);
+ * ```
+ * @example
+ * ```ts
+ * import type { LN10 } from "@nick/math/constants/ln10";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";
+ *
+ * expectType<LN10>(2.302585092994046);
+ * ```
+ * @module ln10
+ */
+/**
+ * Represents the natural logarithm of the number `10`, approximately equal to
+ * `2.302585092994046`. This corresponds to the native `Math.LN10` constant.
+ * @example
+ * ```ts
+ * import { LN10 } from "@nick/math/constants/ln10";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN10, 2.302585092994046);
+ * ```
  * @category Constants
  */
 export declare const LN10: LN10;
+/**
+ * Type-level alias of the `LN10` constant exported by this module. This allows
+ * `LN10` to be imported using a standard named import (i.e. the _value_ level)
+ * or via type-only import for a compile-time only reference to the same value.
+ *
+ * @example
+ * ```ts
+ * import type { LN10 } from "@nick/math/constants/ln10";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";
+ *
+ * expectType<LN10>(2.302585092994046);
+ * ```
+ * @category Constants
+ */
 export type LN10 = 2.302585092994046;
 //# sourceMappingURL=ln10.d.ts.map

package/esm/constants/ln10.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ln10.d.ts","sourceRoot":"","sources":["../../src/constants/ln10.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,EAAE,IAAwB,CAAC;AAC5C,MAAM,MAAM,IAAI,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"ln10.d.ts","sourceRoot":"","sources":["../../src/constants/ln10.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,IAAI,EAAE,IAAwB,CAAC;AAE5C;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,IAAI,GAAG,iBAAiB,CAAC"}

package/esm/constants/ln10.js

@@ -1,8 +1,38 @@
 /**
- * Represents the natural logarithm of `10`, approximately equal to
- * `2.302585092994046`.
+ * This module provides runtime and type-level implementations of the `LN10`
+ * constant found in the native `Math` namespace, which represents the natural
+ * logarithm of the number `10` (approximately equal to `2.302585092994046`).
  *
- * This is a local implementation of the native `Math.LN10` constant.
+ * The `LN10` constant exported by this module can be imported using a standard
+ * named import (i.e., at the _value_ level), or via a type-only import for a
+ * compile-time only reference to the same value.
+ *
+ * @example
+ * ```ts
+ * import { LN10 } from "@nick/math/constants/ln10";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN10, 2.302585092994046);
+ * ```
+ * @example
+ * ```ts
+ * import type { LN10 } from "@nick/math/constants/ln10";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";
+ *
+ * expectType<LN10>(2.302585092994046);
+ * ```
+ * @module ln10
+ */
+/**
+ * Represents the natural logarithm of the number `10`, approximately equal to
+ * `2.302585092994046`. This corresponds to the native `Math.LN10` constant.
+ * @example
+ * ```ts
+ * import { LN10 } from "@nick/math/constants/ln10";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN10, 2.302585092994046);
+ * ```
  * @category Constants
  */
 export const LN10 = 2.302585092994046;

package/esm/constants/ln10.js.map

@@ -1 +1 @@
-{"version":3,"file":"ln10.js","sourceRoot":"","sources":["../../src/constants/ln10.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAS,iBAAiB,CAAC"}
+{"version":3,"file":"ln10.js","sourceRoot":"","sources":["../../src/constants/ln10.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,IAAI,GAAS,iBAAiB,CAAC"}

package/esm/constants/ln2.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LN2` constant, the natural logarithm of 2.
+ *
+ * @example
+ * ```ts
+ * import { LN2 } from "@nick/math/constants/ln2";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN2, Math.LN2);
+ * ```
+ * @category Constants
+ * @module ln2
+ */
 /**
  * Represents the natural logarithm of `2`, approximately equal to
  * `0.6931471805599453`.

package/esm/constants/ln2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ln2.d.ts","sourceRoot":"","sources":["../../src/constants/ln2.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,GAAG,EAAE,GAAwB,CAAC;AAC3C,MAAM,MAAM,GAAG,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"ln2.d.ts","sourceRoot":"","sources":["../../src/constants/ln2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,GAAG,EAAE,GAAwB,CAAC;AAC3C,MAAM,MAAM,GAAG,GAAG,kBAAkB,CAAC"}

package/esm/constants/ln2.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LN2` constant, the natural logarithm of 2.
+ *
+ * @example
+ * ```ts
+ * import { LN2 } from "@nick/math/constants/ln2";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LN2, Math.LN2);
+ * ```
+ * @category Constants
+ * @module ln2
+ */
 /**
  * Represents the natural logarithm of `2`, approximately equal to
  * `0.6931471805599453`.

package/esm/constants/ln2.js.map

@@ -1 +1 @@
-{"version":3,"file":"ln2.js","sourceRoot":"","sources":["../../src/constants/ln2.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,GAAG,GAAQ,kBAAkB,CAAC"}
+{"version":3,"file":"ln2.js","sourceRoot":"","sources":["../../src/constants/ln2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,GAAG,GAAQ,kBAAkB,CAAC"}

package/esm/constants/log10e.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LOG10E` constant, the base-10 logarithm of e.
+ *
+ * @example
+ * ```ts
+ * import { LOG10E } from "@nick/math/constants/log10e";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LOG10E, Math.LOG10E);
+ * ```
+ * @category Constants
+ * @module log10e
+ */
 /**
  * Represents the base-10 logarithm of `e` (Euler's number), approximately
  * equal to `0.4342944819032518`.

package/esm/constants/log10e.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log10e.d.ts","sourceRoot":"","sources":["../../src/constants/log10e.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE,MAA2B,CAAC;AACjD,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"log10e.d.ts","sourceRoot":"","sources":["../../src/constants/log10e.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE,MAA2B,CAAC;AACjD,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC"}

package/esm/constants/log10e.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LOG10E` constant, the base-10 logarithm of e.
+ *
+ * @example
+ * ```ts
+ * import { LOG10E } from "@nick/math/constants/log10e";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LOG10E, Math.LOG10E);
+ * ```
+ * @category Constants
+ * @module log10e
+ */
 /**
  * Represents the base-10 logarithm of `e` (Euler's number), approximately
  * equal to `0.4342944819032518`.

package/esm/constants/log10e.js.map

@@ -1 +1 @@
-{"version":3,"file":"log10e.js","sourceRoot":"","sources":["../../src/constants/log10e.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAW,kBAAkB,CAAC"}
+{"version":3,"file":"log10e.js","sourceRoot":"","sources":["../../src/constants/log10e.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAW,kBAAkB,CAAC"}

package/esm/constants/log2e.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LOG2E` constant, the base-2 logarithm of e.
+ *
+ * @example
+ * ```ts
+ * import { LOG2E } from "@nick/math/constants/log2e";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LOG2E, Math.LOG2E);
+ * ```
+ * @category Constants
+ * @module log2e
+ */
 /**
  * Represents the base-2 logarithm of `e` (Euler's number), approximately equal
  * to `1.4426950408889634`.

package/esm/constants/log2e.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log2e.d.ts","sourceRoot":"","sources":["../../src/constants/log2e.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,EAAE,KAA0B,CAAC;AAC/C,MAAM,MAAM,KAAK,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"log2e.d.ts","sourceRoot":"","sources":["../../src/constants/log2e.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,EAAE,KAA0B,CAAC;AAC/C,MAAM,MAAM,KAAK,GAAG,kBAAkB,CAAC"}

package/esm/constants/log2e.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `LOG2E` constant, the base-2 logarithm of e.
+ *
+ * @example
+ * ```ts
+ * import { LOG2E } from "@nick/math/constants/log2e";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(LOG2E, Math.LOG2E);
+ * ```
+ * @category Constants
+ * @module log2e
+ */
 /**
  * Represents the base-2 logarithm of `e` (Euler's number), approximately equal
  * to `1.4426950408889634`.

package/esm/constants/log2e.js.map

@@ -1 +1 @@
-{"version":3,"file":"log2e.js","sourceRoot":"","sources":["../../src/constants/log2e.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,KAAK,GAAU,kBAAkB,CAAC"}
+{"version":3,"file":"log2e.js","sourceRoot":"","sources":["../../src/constants/log2e.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,KAAK,GAAU,kBAAkB,CAAC"}

package/esm/constants/max_safe_integer.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MAX_SAFE_INTEGER` constant, matching `Number.MAX_SAFE_INTEGER`.
+ *
+ * @example
+ * ```ts
+ * import { MAX_SAFE_INTEGER } from "@nick/math/constants/max-safe-integer";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER);
+ * ```
+ * @category Constants
+ * @module max-safe-integer
+ */
 /**
  * Represents the largest integer that can be represented in JavaScript without
  * losing precision, which is approximately equal to `9007199254740991`.

package/esm/constants/max_safe_integer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"max_safe_integer.d.ts","sourceRoot":"","sources":["../../src/constants/max_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAAmC,CAAC;AACnE,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC"}
+{"version":3,"file":"max_safe_integer.d.ts","sourceRoot":"","sources":["../../src/constants/max_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAAmC,CAAC;AACnE,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC"}

package/esm/constants/max_safe_integer.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MAX_SAFE_INTEGER` constant, matching `Number.MAX_SAFE_INTEGER`.
+ *
+ * @example
+ * ```ts
+ * import { MAX_SAFE_INTEGER } from "@nick/math/constants/max-safe-integer";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER);
+ * ```
+ * @category Constants
+ * @module max-safe-integer
+ */
 /**
  * Represents the largest integer that can be represented in JavaScript without
  * losing precision, which is approximately equal to `9007199254740991`.

package/esm/constants/max_safe_integer.js.map

@@ -1 +1 @@
-{"version":3,"file":"max_safe_integer.js","sourceRoot":"","sources":["../../src/constants/max_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqB,gBAAgB,CAAC"}
+{"version":3,"file":"max_safe_integer.js","sourceRoot":"","sources":["../../src/constants/max_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqB,gBAAgB,CAAC"}

package/esm/constants/max_value.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MAX_VALUE` constant, matching `Number.MAX_VALUE`.
+ *
+ * @example
+ * ```ts
+ * import { MAX_VALUE } from "@nick/math/constants/max-value";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MAX_VALUE, Number.MAX_VALUE);
+ * ```
+ * @category Constants
+ * @module max-value
+ */
 /**
  * Represents the largest positive finite number that can be represented in
  * JavaScript, which is approximately equal to `1.7976931348623157e+308`.

package/esm/constants/max_value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"max_value.d.ts","sourceRoot":"","sources":["../../src/constants/max_value.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAkC,CAAC;AAC3D,MAAM,MAAM,SAAS,GAAG,sBAAsB,CAAC"}
+{"version":3,"file":"max_value.d.ts","sourceRoot":"","sources":["../../src/constants/max_value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAkC,CAAC;AAC3D,MAAM,MAAM,SAAS,GAAG,sBAAsB,CAAC"}

package/esm/constants/max_value.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MAX_VALUE` constant, matching `Number.MAX_VALUE`.
+ *
+ * @example
+ * ```ts
+ * import { MAX_VALUE } from "@nick/math/constants/max-value";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MAX_VALUE, Number.MAX_VALUE);
+ * ```
+ * @category Constants
+ * @module max-value
+ */
 /**
  * Represents the largest positive finite number that can be represented in
  * JavaScript, which is approximately equal to `1.7976931348623157e+308`.

package/esm/constants/max_value.js.map

@@ -1 +1 @@
-{"version":3,"file":"max_value.js","sourceRoot":"","sources":["../../src/constants/max_value.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAc,sBAAsB,CAAC"}
+{"version":3,"file":"max_value.js","sourceRoot":"","sources":["../../src/constants/max_value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAc,sBAAsB,CAAC"}

package/esm/constants/min_safe_integer.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MIN_SAFE_INTEGER` constant, matching `Number.MIN_SAFE_INTEGER`.
+ *
+ * @example
+ * ```ts
+ * import { MIN_SAFE_INTEGER } from "@nick/math/constants/min-safe-integer";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MIN_SAFE_INTEGER, Number.MIN_SAFE_INTEGER);
+ * ```
+ * @category Constants
+ * @module min-safe-integer
+ */
 /**
  * Represents the smallest integer that can be represented in JavaScript
  * without losing precision, which is approximately equal to

package/esm/constants/min_safe_integer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"min_safe_integer.d.ts","sourceRoot":"","sources":["../../src/constants/min_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAAoC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,gBAAgB,CAAC"}
+{"version":3,"file":"min_safe_integer.d.ts","sourceRoot":"","sources":["../../src/constants/min_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAAoC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,CAAC,gBAAgB,CAAC"}

package/esm/constants/min_safe_integer.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MIN_SAFE_INTEGER` constant, matching `Number.MIN_SAFE_INTEGER`.
+ *
+ * @example
+ * ```ts
+ * import { MIN_SAFE_INTEGER } from "@nick/math/constants/min-safe-integer";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MIN_SAFE_INTEGER, Number.MIN_SAFE_INTEGER);
+ * ```
+ * @category Constants
+ * @module min-safe-integer
+ */
 /**
  * Represents the smallest integer that can be represented in JavaScript
  * without losing precision, which is approximately equal to

package/esm/constants/min_safe_integer.js.map

@@ -1 +1 @@
-{"version":3,"file":"min_safe_integer.js","sourceRoot":"","sources":["../../src/constants/min_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqB,CAAC,gBAAgB,CAAC"}
+{"version":3,"file":"min_safe_integer.js","sourceRoot":"","sources":["../../src/constants/min_safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAqB,CAAC,gBAAgB,CAAC"}

package/esm/constants/min_value.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MIN_VALUE` constant, matching `Number.MIN_VALUE`.
+ *
+ * @example
+ * ```ts
+ * import { MIN_VALUE } from "@nick/math/constants/min-value";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MIN_VALUE, Number.MIN_VALUE);
+ * ```
+ * @category Constants
+ * @module min-value
+ */
 /**
  * Represents the smallest positive number that is greater than zero, which is
  * approximately equal to `5e-324`.

package/esm/constants/min_value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"min_value.d.ts","sourceRoot":"","sources":["../../src/constants/min_value.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAkB,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC"}
+{"version":3,"file":"min_value.d.ts","sourceRoot":"","sources":["../../src/constants/min_value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAkB,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC"}

package/esm/constants/min_value.js

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `MIN_VALUE` constant, matching `Number.MIN_VALUE`.
+ *
+ * @example
+ * ```ts
+ * import { MIN_VALUE } from "@nick/math/constants/min-value";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(MIN_VALUE, Number.MIN_VALUE);
+ * ```
+ * @category Constants
+ * @module min-value
+ */
 /**
  * Represents the smallest positive number that is greater than zero, which is
  * approximately equal to `5e-324`.

package/esm/constants/min_value.js.map

@@ -1 +1 @@
-{"version":3,"file":"min_value.js","sourceRoot":"","sources":["../../src/constants/min_value.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAc,MAAM,CAAC"}
+{"version":3,"file":"min_value.js","sourceRoot":"","sources":["../../src/constants/min_value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAc,MAAM,CAAC"}

package/esm/constants/nan.d.ts

@@ -8,6 +8,13 @@
  * mathematical operations, such as dividing zero by zero, or parsing a string
  * that does not represent a valid number with `parseInt` or `parseFloat`.
  *
+ * @example
+ * ```ts
+ * import { NAN } from "@nick/math/constants/nan";
+ * import assert from "node:assert";
+ *
+ * assert.ok(Number.isNaN(NAN));
+ * ```
  * @module nan
  */
 declare const Not_a_Number: unique symbol;

package/esm/constants/nan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nan.d.ts","sourceRoot":"","sources":["../../src/constants/nan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,QAAA,MAAM,YAAY,EAAE,OAAO,MAAyB,CAAC;AACrD,KAAK,YAAY,GAAG,OAAO,YAAY,CAAC;AAExC;;;;;;;;;;;;GAYG;AAKH,UAAU,GAAG;IACX,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,GAAG,EAAE,GAAkB,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC;AAE/B,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC"}
+{"version":3,"file":"nan.d.ts","sourceRoot":"","sources":["../../src/constants/nan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH,QAAA,MAAM,YAAY,EAAE,OAAO,MAAyB,CAAC;AACrD,KAAK,YAAY,GAAG,OAAO,YAAY,CAAC;AAExC;;;;;;;;;;;;GAYG;AAKH,UAAU,GAAG;IACX,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,GAAG,EAAE,GAAkB,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC;AAE/B,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC"}

package/esm/constants/nan.js

@@ -8,6 +8,13 @@
  * mathematical operations, such as dividing zero by zero, or parsing a string
  * that does not represent a valid number with `parseInt` or `parseFloat`.
  *
+ * @example
+ * ```ts
+ * import { NAN } from "@nick/math/constants/nan";
+ * import assert from "node:assert";
+ *
+ * assert.ok(Number.isNaN(NAN));
+ * ```
  * @module nan
  */
 // purposely kept private and local to this module only, preventing external

package/esm/constants/nan.js.map

@@ -1 +1 @@
-{"version":3,"file":"nan.js","sourceRoot":"","sources":["../../src/constants/nan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,4EAA4E;AAC5E,4CAA4C;AAC5C,MAAM,YAAY,GAAkB,MAAM,CAAC,QAAQ,CAAC,CAAC;AAwBrD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,GAAG,GAAQ,CAAC,GAAG,CAAQ,CAAC;AAQrC,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC"}
+{"version":3,"file":"nan.js","sourceRoot":"","sources":["../../src/constants/nan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,4EAA4E;AAC5E,4CAA4C;AAC5C,MAAM,YAAY,GAAkB,MAAM,CAAC,QAAQ,CAAC,CAAC;AAwBrD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,GAAG,GAAQ,CAAC,GAAG,CAAQ,CAAC;AAQrC,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC"}

package/esm/constants/negative_infinity.d.ts

@@ -1,3 +1,17 @@
+/**
+ * This module provides runtime and type-level implementations of the
+ * `NEGATIVE_INFINITY` constant, matching `Number.NEGATIVE_INFINITY`.
+ *
+ * @example
+ * ```ts
+ * import { NEGATIVE_INFINITY } from "@nick/math/constants/negative-infinity";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(NEGATIVE_INFINITY, Number.NEGATIVE_INFINITY);
+ * ```
+ * @category Constants
+ * @module negative-infinity
+ */
 /**
  * Negative Infinity is a special value representing negative infinity, which
  * is less than any other number. It is approximately equal to

package/esm/constants/negative_infinity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"negative_infinity.d.ts","sourceRoot":"","sources":["../../src/constants/negative_infinity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,EAAE,iBAA+C,CAAC;AAEhF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,CAAC"}
+{"version":3,"file":"negative_infinity.d.ts","sourceRoot":"","sources":["../../src/constants/negative_infinity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,EAAE,iBAA+C,CAAC;AAEhF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,CAAC"}