@nberlette/math 0.7.0 → 0.7.1

package/esm/tanh.d.ts

@@ -3,6 +3,13 @@
  * range `[-1, 1]`.
  *
  * @category Trigonometry
+ * @example
+ * ```ts
+ * import { tanh } from "@nick/math/tanh";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(tanh(0), 0);
+ * ```
  * @module tanh
  */
 /**

package/esm/tanh.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"tanh.d.ts","sourceRoot":"","sources":["../src/tanh.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAOH;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMtC"}

package/esm/tanh.js

@@ -3,6 +3,13 @@
  * range `[-1, 1]`.
  *
  * @category Trigonometry
+ * @example
+ * ```ts
+ * import { tanh } from "@nick/math/tanh";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(tanh(0), 0);
+ * ```
  * @module tanh
  */
 import { exp } from "./exp.js";

package/esm/tanh.js.map

@@ -1 +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"}
+{"version":3,"file":"tanh.js","sourceRoot":"","sources":["../src/tanh.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;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.map

@@ -1 +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"}
+{"version":3,"file":"trunc.d.ts","sourceRoot":"","sources":["../src/trunc.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAMvC"}

package/esm/trunc.js

@@ -3,13 +3,11 @@
  *
  * @example
  * ```ts
- * import * as math from "@nick/math";
+ * import { trunc } from "@nick/math/trunc";
+ * import assert from "node:assert";
  *
- * math.trunc(13.37); // 13
- * math.trunc(42.195); // 42
- * math.trunc(-7.8); // -7
- * math.trunc(-0.123); // 0
- * math.trunc(0); // 0
+ * assert.strictEqual(trunc(13.37), 13);
+ * assert.strictEqual(trunc(-7.8), -7);
  * ```
  * @module trunc
  */

package/esm/trunc.js.map

@@ -1 +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"}
+{"version":3,"file":"trunc.js","sourceRoot":"","sources":["../src/trunc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;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

@@ -1,3 +1,18 @@
+/**
+ * Provides the `Finite` branded type for numbers that are neither
+ * infinite nor `NaN`.
+ *
+ * @example
+ * ```ts
+ * import type { Finite } from "@nick/math/types/finite";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * const value = 42 as Finite;
+ * expectType<Finite>(value);
+ * ```
+ * @category Types
+ * @module types/finite
+ */
 import type { NEGATIVE_INFINITY, POSITIVE_INFINITY } from "../constants/infinity.js";
 import type { NAN } from "../constants/nan.js";
 declare const Finite: unique symbol;

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

@@ -1 +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"}
+{"version":3,"file":"finite.d.ts","sourceRoot":"","sources":["../../src/types/finite.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,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

@@ -1,3 +1,18 @@
+/**
+ * Provides the `Finite` branded type for numbers that are neither
+ * infinite nor `NaN`.
+ *
+ * @example
+ * ```ts
+ * import type { Finite } from "@nick/math/types/finite";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * const value = 42 as Finite;
+ * expectType<Finite>(value);
+ * ```
+ * @category Types
+ * @module types/finite
+ */
 const Finite = Symbol("Finite");
 export {};
 //# sourceMappingURL=finite.js.map

package/esm/types/finite.js.map

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

package/esm/types/float.d.ts

@@ -7,6 +7,14 @@
  * specific to floating-point numbers, and are designed to be used as generic
  * type arguments to other functions and classes that work with floats.
  *
+ * @example
+ * ```ts
+ * import type { Float32 } from "@nick/math/types/float";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * const value = 1 as Float32;
+ * expectType<Float32>(value);
+ * ```
  * @module types/float
  */
 import type { FloatPrecision, P32 } from "./precision.js";

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

@@ -1 +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"}
+{"version":3,"file":"float.d.ts","sourceRoot":"","sources":["../../src/types/float.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;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.map

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

package/esm/types/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Re-exports the branded numeric types used throughout the library for
+ * type-safe arithmetic and predicates.
+ *
+ * @category Types
+ * @module types
+ */
 export * from "./finite.js";
 export * from "./float.js";
 export * from "./integer.js";

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,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

@@ -1,3 +1,10 @@
+/**
+ * Re-exports the branded numeric types used throughout the library for
+ * type-safe arithmetic and predicates.
+ *
+ * @category Types
+ * @module types
+ */
 export * from "./finite.js";
 export * from "./float.js";
 export * from "./integer.js";

package/esm/types/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,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

@@ -2,6 +2,14 @@
  * This module provides branded nominal types for signed and unsigned integers
  * of various precisions, as well as bigints for 64-bit integers.
  *
+ * @example
+ * ```ts
+ * import type { Int32 } from "@nick/math/types/integer";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * const value = 42 as Int32;
+ * expectType<Int32>(value);
+ * ```
  * @module types/integer
  */
 import type { P32, Precision } from "./precision.js";

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

@@ -1 +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"}
+{"version":3,"file":"integer.d.ts","sourceRoot":"","sources":["../../src/types/integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;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.map

@@ -1 +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"}
+{"version":3,"file":"integer.js","sourceRoot":"","sources":["../../src/types/integer.ts"],"names":[],"mappings":"AAgBA,MAAM,OAAO,GAAkB,MAAM,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,QAAQ,GAAkB,MAAM,CAAC,UAAU,CAAC,CAAC"}

package/esm/types/precision.d.ts

@@ -2,6 +2,14 @@
  * This module provides type aliases for various levels of precision, for use
  * with floating-point or integer numbers.
  *
+ * @example
+ * ```ts
+ * import type { P32, Precision } from "@nick/math/types/precision";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * expectType<P32>(32);
+ * expectType<Precision>(32);
+ * ```
  * @module precision
  */
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"precision.d.ts","sourceRoot":"","sources":["../../src/types/precision.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;GAIG;AACH,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC"}
+{"version":3,"file":"precision.d.ts","sourceRoot":"","sources":["../../src/types/precision.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;GAIG;AACH,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC"}

package/esm/types/precision.js

@@ -2,6 +2,14 @@
  * This module provides type aliases for various levels of precision, for use
  * with floating-point or integer numbers.
  *
+ * @example
+ * ```ts
+ * import type { P32, Precision } from "@nick/math/types/precision";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * expectType<P32>(32);
+ * expectType<Precision>(32);
+ * ```
  * @module precision
  */
 export {};

package/esm/types/precision.js.map

@@ -1 +1 @@
-{"version":3,"file":"precision.js","sourceRoot":"","sources":["../../src/types/precision.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}
+{"version":3,"file":"precision.js","sourceRoot":"","sources":["../../src/types/precision.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG"}

package/esm/types/safe_integer.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Provides the `SafeInteger` branded type for numbers that fall within
+ * the safe integer range.
+ *
+ * @example
+ * ```ts
+ * import { isSafeInteger } from "@nick/math/is/safe-integer";
+ * import type { SafeInteger } from "@nick/math/types/safe-integer";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * let user_input: number = 42;
+ * if (isSafeInteger(user_input)) {
+ *   expectType<SafeInteger>(user_input);
+ * }
+ * ```
+ * @category Types
+ * @module types/safe-integer
+ */
 declare const Safe_Integer: unique symbol;
 interface Safe_Integer {
     readonly [Safe_Integer]: true;

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

@@ -1 +1 @@
-{"version":3,"file":"safe_integer.d.ts","sourceRoot":"","sources":["../../src/types/safe_integer.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,YAAY,EAAE,OAAO,MAA8B,CAAC;AAE1D,UAAU,YAAY;IACpB,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,YAAY,CAAC"}
+{"version":3,"file":"safe_integer.d.ts","sourceRoot":"","sources":["../../src/types/safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,QAAA,MAAM,YAAY,EAAE,OAAO,MAA8B,CAAC;AAE1D,UAAU,YAAY;IACpB,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,YAAY,CAAC"}

package/esm/types/safe_integer.js

@@ -1,3 +1,21 @@
+/**
+ * Provides the `SafeInteger` branded type for numbers that fall within
+ * the safe integer range.
+ *
+ * @example
+ * ```ts
+ * import { isSafeInteger } from "@nick/math/is/safe-integer";
+ * import type { SafeInteger } from "@nick/math/types/safe-integer";
+ * import { expectType } from "jsr:@nick/is@0.2.0-rc.6/type/expect";;
+ *
+ * let user_input: number = 42;
+ * if (isSafeInteger(user_input)) {
+ *   expectType<SafeInteger>(user_input);
+ * }
+ * ```
+ * @category Types
+ * @module types/safe-integer
+ */
 // deno-lint-ignore no-unused-vars
 const Safe_Integer = Symbol("SafeInteger");
 export {};

package/esm/types/safe_integer.js.map

@@ -1 +1 @@
-{"version":3,"file":"safe_integer.js","sourceRoot":"","sources":["../../src/types/safe_integer.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,MAAM,YAAY,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC"}
+{"version":3,"file":"safe_integer.js","sourceRoot":"","sources":["../../src/types/safe_integer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,kCAAkC;AAClC,MAAM,YAAY,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nberlette/math",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Standalone implementation of the entire native Math interface, along with other useful type guards, constants, and utilities. Zero dependencies.",
   "keywords": [
     "math",

package/src/abs.ts

@@ -1,6 +1,13 @@
 /**
  * Performant local implementation of the `Math.abs` function.
  *
+ * @example
+ * ```ts
+ * import { abs } from "@nick/math/abs";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(abs(-3.5), 3.5);
+ * ```
  * @module abs
  */
 

package/src/acos.ts

@@ -2,6 +2,13 @@
  * Calculates the arccosine (inverse cosine) of a number, returning a value in
  * the range `[0, π]`.
  *
+ * @example
+ * ```ts
+ * import { acos } from "@nick/math/acos";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(acos(1), 0);
+ * ```
  * @module acos
  */
 

package/src/acosh.ts

@@ -3,6 +3,13 @@
  * the range `[0, +Infinity]`.
  *
  * @category Trigonometry
+ * @example
+ * ```ts
+ * import { acosh } from "@nick/math/acosh";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(acosh(1), 0);
+ * ```
  * @module acosh
  */
 import { NAN } from "./constants/nan.js";

package/src/asin.ts

@@ -3,6 +3,13 @@
  * range `[-π/2, π/2]`.
  *
  * @category Trigonometry
+ * @example
+ * ```ts
+ * import { asin } from "@nick/math/asin";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(asin(0), 0);
+ * ```
  * @module asin
  */
 import { NAN } from "./constants/nan.js";

package/src/asinh.ts

@@ -1,6 +1,13 @@
 /**
  * Calculates the inverse hyperbolic sine of a number.
  *
+ * @example
+ * ```ts
+ * import { asinh } from "@nick/math/asinh";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(asinh(0), 0);
+ * ```
  * @module asinh
  */
 import { isFinite } from "./guards/finite.js";

package/src/atan.ts

@@ -2,6 +2,13 @@
  * Calculates the arctangent (inverse tangent) of a number, returning a value
  * in the range `[-π/2, π/2]`.
  *
+ * @example
+ * ```ts
+ * import { atan } from "@nick/math/atan";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(atan(0), 0);
+ * ```
  * @module atan
  */
 import { abs } from "./abs.js";

package/src/atan2.ts

@@ -2,6 +2,13 @@
  * Calculates the arctangent of the quotient of its arguments, `y / x`,
  * returning a value in the range `(-π, π]`.
  *
+ * @example
+ * ```ts
+ * import { atan2 } from "@nick/math/atan2";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(atan2(0, 1), 0);
+ * ```
  * @module atan2
  */
 import { NAN } from "./constants/nan.js";

package/src/atanh.ts

@@ -2,6 +2,13 @@
  * Calculates the inverse hyperbolic tangent of a number, returning a value in
  * the range `[-∞, +∞]`.
  *
+ * @example
+ * ```ts
+ * import { atanh } from "@nick/math/atanh";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(atanh(0), 0);
+ * ```
  * @module atanh
  */
 import { isNaN, NAN } from "./guards/nan.js";

package/src/cbrt.ts

@@ -1,6 +1,13 @@
 /**
  * Calculates the cube root of a number, handling negative values as well.
  *
+ * @example
+ * ```ts
+ * import { cbrt } from "@nick/math/cbrt";
+ * import assert from "node:assert";
+ *
+ * assert.ok(Math.abs(cbrt(27) - 3) < 1e-12);
+ * ```
  * @module cbrt
  */
 import { abs } from "./abs.js";

package/src/ceil.ts

@@ -1,6 +1,13 @@
 /**
  * Performant local implementation of the `Math.ceil` function.
  *
+ * @example
+ * ```ts
+ * import { ceil } from "@nick/math/ceil";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(ceil(1.2), 2);
+ * ```
  * @module ceil
  */
 

package/src/clamp.ts

@@ -6,6 +6,13 @@
  *
  * **Note**: this is a non-standard utility function.
  *
+ * @example
+ * ```ts
+ * import { clamp } from "@nick/math/clamp";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(clamp(10, 0, 5), 5);
+ * ```
  * @module clamp
  */
 import { max } from "./max.js";

package/src/clz32.ts

@@ -3,6 +3,13 @@
  * `Math.clz32` function, which counts the number of leading zero bits in the
  * 32-bit binary representation of a number.
  *
+ * @example
+ * ```ts
+ * import { clz32 } from "@nick/math/clz32";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(clz32(1), 31);
+ * ```
  * @module clz32
  */
 

package/src/constants/e.ts

@@ -2,6 +2,13 @@
  * This module provides a constant value for the mathematical constant `e` on
  * the runtime value-level, and also the compile-time type-only level.
  *
+ * @example
+ * ```ts
+ * import { E } from "@nick/math/constants/e";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(E, Math.E);
+ * ```
  * @module e
  */
 

package/src/constants/epsilon.ts

@@ -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/src/constants/index.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/src/constants/infinity.ts

@@ -1,2 +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";

package/src/constants/ln10.ts

@@ -1,9 +1,55 @@
 /**
- * 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: LN10 = 2.302585092994046;
+
+/**
+ * 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;