@nberlette/math 0.7.0

package/src/constants/negative_zero.ts

@@ -0,0 +1,34 @@
+/**
+ * This module provides a constant value and a branded nominal type for the
+ * special number negative zero (`-0`). This is a non-standard extension of the
+ * native JavaScript language, provided for stronger type-safety when working
+ * with negative zero values.
+ *
+ * @module negative-zero
+ */
+
+// deno-lint-ignore no-unused-vars
+const NegativeZero: unique symbol = Symbol("-0");
+
+interface NegativeZero {
+  readonly [NegativeZero]: never;
+}
+
+/**
+ * Represents the special number negative zero (`-0`).
+ *
+ * @category Constants
+ * @tags Negative Zero
+ */
+export const NEGATIVE_ZERO: NEGATIVE_ZERO = -0 as NEGATIVE_ZERO;
+
+/**
+ * @remarks
+ * TypeScript is not capable of distinguishing `-0` from `0` on a type level.
+ * This type helps fill that gap by providing a branded nominal type for it,
+ * allowing you to perform strict type checking and narrowing against negative
+ * zero values.
+ *
+ * @see {@linkcode isNegativeZero} to check runtime values against this type.
+ */
+export type NEGATIVE_ZERO = -0 & NegativeZero;

package/src/constants/pi.ts

@@ -0,0 +1,9 @@
+/**
+ * Represents the mathematical constant `π` (pi), the ratio of a circle's
+ * circumference to its diameter, approximately equal to `3.141592653589793`.
+ *
+ * This is a local implementation of the native `Math.PI` constant.
+ * @category Constants
+ */
+export const PI: PI = 3.141592653589793;
+export type PI = 3.141592653589793;

package/src/constants/positive_infinity.ts

@@ -0,0 +1,30 @@
+/**
+ * Positive Infinity is a special value representing positive infinity, which
+ * is greater than any other number. It is approximately equal to
+ * `1.7976931348623159e+308`.
+ *
+ * This is a local implementation of the native `Number.POSITIVE_INFINITY`
+ * constant.
+ * @category Constants
+ * @tags Infinity
+ */
+export const POSITIVE_INFINITY: POSITIVE_INFINITY = 1 / 0 as POSITIVE_INFINITY;
+
+/**
+ * Special type used to represent `+Infinity` (positive infinity). TypeScript's
+ * built-in types do not distinguish between positive/negative infinity and any
+ * other `number`. However, its type checker _is_ capable of differentiating
+ * between those types and other literal numbers.
+ *
+ * This type simply (ab)uses the type system's handling of scientific notation:
+ * by using an arbitrary exponent in excess of `308`, the type checker can now
+ * recognize and represent the type as `Infinity`. Great success!
+ *
+ * NB: Credit to Sindre Sorhus and his type-fest project for this approach.
+ *
+ * @category Types
+ * @tags Infinity
+ */
+export type POSITIVE_INFINITY = 1e333;
+
+export { POSITIVE_INFINITY as Infinity };

package/src/constants/positive_zero.ts

@@ -0,0 +1,41 @@
+/**
+ * This module provides a constant value and a branded nominal type for the
+ * special number positive zero (`-0`). This is a non-standard extension of the
+ * native JavaScript language, provided for stronger type-safety when working
+ * with positive zero values.
+ *
+ * @module positive-zero
+ */
+
+// deno-lint-ignore no-unused-vars
+const PositiveZero: unique symbol = Symbol("0");
+
+interface PositiveZero {
+  readonly [PositiveZero]: never;
+}
+
+/**
+ * Represents a value that has been verified at runtime to be positive zero,
+ * (i.e. exactly `0`, and not `-0`).
+ *
+ * This is provided as both a constant runtime value and as a branded nominal
+ * type alias for `0`, for use in type-level checks and narrowing where you
+ * need a higher level of type-safety than just a standard literal `0`.
+ *
+ * @category Constants
+ * @tags Positive Zero
+ * @example
+ * ```ts
+ * import { POSITIVE_ZERO } from "@nick/math/constants/positive-zero";
+ * import { isPositiveZero } from "@nick/math/is/positive-zero";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(isPositiveZero(-0), false); // OK
+ * assert.strictEqual(isPositiveZero(POSITIVE_ZERO), true); // OK
+ * assert.strictEqual(POSITIVE_ZERO, 0); // OK
+ * ```
+ */
+export const POSITIVE_ZERO: POSITIVE_ZERO = 0 as POSITIVE_ZERO;
+
+/** @inheritdoc */
+export type POSITIVE_ZERO = 0 & PositiveZero;

package/src/constants/sqrt1_2.ts

@@ -0,0 +1,8 @@
+/**
+ * The square root of `1/2`, approximately equal to `0.7071067811865476`.
+ *
+ * This is a local implementation of the native `Math.SQRT1_2` constant.
+ * @category Constants
+ */
+export const SQRT1_2: SQRT1_2 = 0.7071067811865476;
+export type SQRT1_2 = 0.7071067811865476;

package/src/constants/sqrt2.ts

@@ -0,0 +1,8 @@
+/**
+ * The square root of `2`, approximately equal to `1.4142135623730951`.
+ *
+ * This is a local implementation of the native `Math.SQRT2` constant.
+ * @category Constants
+ */
+export const SQRT2: SQRT2 = 1.4142135623730951;
+export type SQRT2 = 1.4142135623730951;

package/src/cos.ts

@@ -0,0 +1,29 @@
+/**
+ * Calculates the cosine of a number, returning a value in the range `[-1, 1]`.
+ *
+ * @module cos
+ */
+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 cosine of a number, returning a value in the range `[-1, 1]`.
+ *
+ * @param x The angle in radians whose cosine is to be calculated.
+ * @returns The cosine of the provided angle.
+ * @category Trigonometry
+ * @tags cosine
+ */
+export function cos(x: number): number {
+  if (!isFinite(x)) return NAN;
+
+  let sum = 1, term = 1, n = 0;
+  while (abs(term) > EPSILON) {
+    n += 2;
+    term *= -x * x / (n * (n - 1));
+    sum += term;
+  }
+  return sum;
+}

package/src/cosh.ts

@@ -0,0 +1,18 @@
+/**
+ * Calculates the hyperbolic cosine of a number.
+ *
+ * @module cosh
+ */
+import { exp } from "./exp.js";
+
+/**
+ * Calculates the hyperbolic cosine of a number.
+ *
+ * @param x The number whose hyperbolic cosine is to be calculated.
+ * @returns The hyperbolic cosine of the provided number.
+ * @category Trigonometry
+ * @tags hyperbolic, cosine
+ */
+export function cosh(x: number): number {
+  return (exp(x) + exp(-x)) / 2;
+}

package/src/exp.ts

@@ -0,0 +1,45 @@
+/**
+ * @category Exponential
+ * @module exp
+ */
+import { EPSILON } from "./constants/epsilon.js";
+import { isNegativeInfinity } from "./guards/negative_infinity.js";
+import { isPositiveInfinity } from "./guards/positive_infinity.js";
+import { isNaN } from "./guards/nan.js";
+import { abs } from "./abs.js";
+
+/**
+ * Calculates the exponential function of a number, returning `e^x`.
+ *
+ * This is functionally equivalent to the `Math.exp` function.
+ *
+ * @param x The number to calculate the exponential function of (e^x)
+ * @returns The exponential function of the provided number.
+ * @category Exponential
+ * @example
+ * ```ts no-eval
+ * import { exp } from "@nick/math";
+ * import assert from "node:assert";
+ *
+ * assert.equal(exp(0), 1);
+ * assert.equal(exp(1), 2.7182818284590455);
+ * assert.equal(exp(2), 7.389056098930649);
+ * ```
+ */
+export function exp(x: number): number {
+  if (isNegativeInfinity(x)) return 0;
+  if (isPositiveInfinity(x) || isNaN(x)) return x;
+  if (x === 0) return 1;
+
+  const a = abs(x);
+  let result = 1, term = 1, iteration = 1;
+
+  // Using Taylor series expansion to approximate e^x
+  while (term > EPSILON) {
+    term *= a / iteration;
+    result += term;
+    iteration += 1;
+  }
+
+  return x < 0 ? 1 / result : result;
+}

package/src/expm1.ts

@@ -0,0 +1,31 @@
+/**
+ * Calculates the exponential of `x` minus 1 (`exp(x) - 1`) with a high degree
+ * of accuracy, even for very small values of `x`.
+ *
+ * @module expm1
+ */
+import { EPSILON } from "./constants/epsilon.js";
+import { abs } from "./abs.js";
+import { exp } from "./exp.js";
+import { NEGATIVE_INFINITY } from "./constants/negative_infinity.js";
+import { POSITIVE_INFINITY } from "./constants/positive_infinity.js";
+
+/**
+ * Calculates `exp(x) - 1` (the exponential of x minus 1).
+ *
+ * Accurate even for very small values of x.
+ *
+ * @param x The number whose exponential minus 1 is to be calculated.
+ * @returns The value of `exp(x) - 1`.
+ * @category Exponential
+ */
+export function expm1(x: number): number {
+  // fast paths for common cases
+  if ((x = +x) === 0) return x; // respect -0
+  if (x === POSITIVE_INFINITY) return x;
+  if (x === NEGATIVE_INFINITY) return -1;
+  // for very small values of x, exp(x) - 1 is approximately equal to x
+  if (abs(x) < EPSILON) return x;
+  // for all other values of x, exp(x) - 1 is accurate
+  return exp(x) - 1;
+}

package/src/f16round.ts

@@ -0,0 +1,39 @@
+/**
+ * Rounds a number to the nearest 16-bit floating point value (half precision).
+ *
+ * Based on `Math.f16round` function from the TC39 Proposal for [Float16Array],
+ * which began shipping in ES2024, this function follows the same rounding and
+ * conversion rules as per the IEEE 754-2008 specification for half-precision
+ * floating-point numbers (also known as binary16).
+ *
+ * [Float16Array]: https://github.com/tc39/proposal-float16array
+ *
+ * @module f16round
+ */
+import { roundFloat16 } from "./float16/round.js";
+
+/**
+ * Rounds a number to the nearest 16-bit floating point value (half precision).
+ *
+ * Based on `Math.f16round` function from the TC39 Proposal for [Float16Array],
+ * which began shipping in ES2024, this function follows the same rounding and
+ * conversion rules as per the IEEE 754-2008 specification for half-precision
+ * floating-point numbers (also known as binary16).
+ *
+ * [Float16Array]: https://github.com/tc39/proposal-float16array
+ *
+ * @param x The number to round.
+ * @returns The 16-bit floating point rounded value of the number.
+ * @category Rounding
+ * @tags float, float16
+ * @example
+ * ```ts
+ * import { f16round } from "@nick/math/f16round";
+ * import { PI } from "@nick/math/constants";
+ *
+ * console.assert(f16round(PI) === 3.140625); // OK
+ * ```
+ */
+export function f16round(x: number): number {
+  return roundFloat16(x);
+}

package/src/float16/constants.ts

@@ -0,0 +1,106 @@
+/**
+ * This module provides constants used by the encoding/decoding APIs in the
+ * `@nick/math/float16` suite. These are primarily used to handle special cases
+ * such as `NaN`, `Infinity`, and `-0`, which have unique representations in
+ * the IEEE-754 half-precision floating point format.
+ *
+ * These are intended for primarily internal use, but are exported for the sake
+ * of completeness and transparency, as well as for potential userland usage in
+ * cases where the constants are needed for custom encoding/decoding logic.
+ *
+ * @module float16/constants
+ */
+
+import type { FloatFormat } from "../internal/ieee754.js";
+
+/**
+ * Well-known bit pattern representing `NaN` in the IEEE-754 half-precision (or
+ * "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, NaN
+ */
+export const FLOAT16_NAN = 0x7E00;
+
+/**
+ * Well-known bit pattern representing `+Infinity` (positive infinity) in the
+ * IEEE-754 half-precision (or "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, Infinity
+ */
+export const FLOAT16_POSITIVE_INFINITY = 0x7C00;
+
+/**
+ * Well-known bit pattern representing `-Infinity` (negative infinity) in the
+ * IEEE-754 half-precision (or "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, Infinity
+ */
+export const FLOAT16_NEGATIVE_INFINITY = 0xFC00;
+
+/**
+ * Well-known bit pattern representing `-0` (negative zero) in the IEEE-754
+ * half-precision (or "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, zero
+ */
+export const FLOAT16_NEGATIVE_ZERO = 0x8000;
+
+/**
+ * Well-known bit pattern representing `+0` (positive zero) in the IEEE-754
+ * half-precision (or "binary16") format.
+ *
+ * **Note**: This constant, unlike the others, is equivalent to its bit pattern
+ * representation (all bits are zero). As such, this is not strictly necessary
+ * for encoding/decoding, but is included for completeness and consistency.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, zero
+ */
+export const FLOAT16_POSITIVE_ZERO = 0x0000;
+
+/**
+ * The number of bits used for the exponent in the IEEE-754 half-precision
+ * (or "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, exponent
+ */
+export const FLOAT16_EXPONENT_BITS = 0x5;
+
+/**
+ * The number of bits used for the mantissa in the IEEE-754 half-precision
+ * (or "binary16") format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, mantissa
+ */
+export const FLOAT16_MANTISSA_BITS = 0xA;
+
+/**
+ * The exponent bias used in the IEEE-754 half-precision (or "binary16")
+ * format.
+ *
+ * @category Constants
+ * @tags float16, ieee-754, bias
+ */
+export const FLOAT16_EXPONENT_BIAS = 0xF;
+
+/**
+ * Represents the IEEE-754 binary16 (half-precision) floating-point format.
+ *
+ * @internal
+ */
+export default {
+  exponent: FLOAT16_EXPONENT_BITS,
+  mantissa: FLOAT16_MANTISSA_BITS,
+  bias: FLOAT16_EXPONENT_BIAS,
+  nan: FLOAT16_NAN,
+  positive_infinity: FLOAT16_POSITIVE_INFINITY,
+  negative_infinity: FLOAT16_NEGATIVE_INFINITY,
+  negative_zero: FLOAT16_NEGATIVE_ZERO,
+  positive_zero: FLOAT16_POSITIVE_ZERO,
+} as const satisfies FloatFormat;

package/src/float16/decode.ts

@@ -0,0 +1,61 @@
+/**
+ * This module provides functions for decoding 16-bit half-precision floating
+ * point numbers (`Float16`) from IEEE 754-2008 encoded `Uint16` values, like
+ * those returned by {@linkcode encodeFloat16} or DataView's `geUint16` method.
+ *
+ * The `Float16` format is a 16-bit representation of a floating point number
+ * that follows the IEEE 754-2008 standard for half-precision binary16 floating
+ * point numbers. This format is used to store floating point values in a
+ * DataView or TypedArray, and is used in graphics programming and other
+ * performance-sensitive applications.
+ *
+ * The `decodeFloat16` function decodes a 16-bit half-precision floating point
+ * value into a standard JavaScript number, which can be used in arithmetic
+ * operations or passed to other functions.
+ *
+ * @module float16/decode
+ */
+import float16 from "./constants.js";
+import { decode } from "../internal/ieee754.js";
+
+/**
+ * Decodes a 16-bit unsigned integer (`Uint16`) into a 16-bit half-precision
+ * floating point value (`Float16`) with 10 bits of mantissa. This function
+ * follows the IEEE 754-2008 spec for half-precision floating point numbers.
+ *
+ * The input value is expected to be the result of an encoding operation, such
+ * as the value returned by the {@linkcode encodeFloat16} function, or by
+ * DataView's `getUint16` method when reading a half-precision float.
+ *
+ * This function is used internally by the {@linkcode f16round} function to
+ * convert the intermediate value back into a standard JavaScript number. The
+ * returned value is a standard JavaScript number, which can be used in
+ * arithmetic operations or passed to other functions.
+ *
+ * ## Special Cases
+ *
+ * The following special cases are handled separately, short-circuiting the
+ * decoding process to return a well-known constant value (as per IEEE spec):
+ *
+ * - `0x7E00` (32256) decodes to `NaN`
+ * - `0x7C00` (31744) decodes to `+Infinity`
+ * - `0xFC00` (64512) decodes to `-Infinity`
+ * - `0x8000` (32768) decodes to `-0`
+ *
+ * @param bits The encoded 16-bit half-precision floating point value.
+ * @returns The decoded standard JavaScript number.
+ * @example
+ * ```ts
+ * import { decodeFloat16 } from "@nick/math/float16";
+ *
+ * console.log(decodeFloat16(0x4248)); // 3.140625
+ *
+ * const view = new DataView(new Float16Array([3.14]).buffer);
+ * console.log(decodeFloat16(view.getUint16(0))); // 3.140625
+ * ```
+ * @category IEEE-754
+ * @tags float, float16, decode
+ */
+export function decodeFloat16(bits: number): number {
+  return decode(bits, float16);
+}

package/src/float16/encode.ts

@@ -0,0 +1,72 @@
+/**
+ * This module provides functions for encoding standard JavaScript numbers into
+ * 16-bit half-precision floating point numbers (`Float16`) that follow the
+ * IEEE 754-2008 standard for half-precision binary16 floating point numbers.
+ *
+ * The `Float16` format is a 16-bit representation of a floating point number
+ * that is used to store floating point values in a DataView or TypedArray.
+ * This format is used in graphics programming and other performance-sensitive
+ * applications.
+ *
+ * The `encodeFloat16` function encodes a standard JavaScript number into a
+ * 16-bit half-precision floating point value, which can be stored in a
+ * DataView via `setUint16`, or used in other applications that require the
+ * `Float16` format.
+ *
+ * @module float16/encode
+ */
+
+import float16 from "./constants.js";
+import { encode } from "../internal/ieee754.js";
+
+/**
+ * Encodes a standard JavaScript number (a 64-bit double-precision floating
+ * point value, 52 bits of mantissa) into a 16-bit unsigned integer (Uint16).
+ * This function follows the IEEE 754-2008 standard for half-precision 16-bit
+ * floating point numbers, also known as `Float16` (or `binary16` in the spec).
+ *
+ * This function is used internally by the {@linkcode f16round} function to
+ * convert the input number into a portable intermediate form, which it then
+ * transforms into the `Float16` format via the {@linkcode decodeFloat16}.
+ *
+ * The returned value can be used to store half-precision floating point values
+ * in a DataView via `setUint16`, since it is equivalent to the result of the
+ * method `DataView.prototype.getUint16` when reading a half-precision float.
+ *
+ * ## Encoding Scheme
+ *
+ * The encoding scheme varies based on the input value classification:
+ *
+ * - Normal (within the normal range of representable values)
+ * - Subnormal (too small to be represented with full precision)
+ * - Special cases
+ *
+ * ## Special Cases
+ *
+ * The following special cases are handled separately, short-circuiting the
+ * encoding process to return a well-known constant value:
+ *
+ * - `NaN` is encoded as `0x7E00` (32256).
+ * - `Infinity` is encoded as `0x7C00` (31744).
+ * - `-Infinity` is encoded as `0xFC00` (64512).
+ * - `-0` is encoded as `0x8000` (32768).
+ *
+ * @param value The standard JavaScript number to encode.
+ * @returns An encoded unsigned 16-bit integer that represents the input value.
+ * @example
+ * ```ts
+ * import { encodeFloat16 } from "@nick/math/float16";
+ *
+ * console.log(encodeFloat16(3.14)); // 0x4248 (16968)
+ *
+ * const view = new DataView(new ArrayBuffer(2));
+ * view.setUint16(0, encodeFloat16(3.14));
+ * console.log(view.getUint16(0)); // 16968
+ * console.log(view.getFloat16(0)); // 3.140625
+ * ```
+ * @category IEEE-754
+ * @tags float16, float, encode
+ */
+export function encodeFloat16(value: number): number {
+  return encode(value, float16);
+}

package/src/float16/guards.ts

@@ -0,0 +1,33 @@
+/**
+ * This submodule provides type guards specific to the float16 module of the
+ * `@nick/math` library, namely the {@linkcode isFloat16} predicate function.
+ *
+ * @module float16/guards
+ */
+import { isNaN } from "../guards/nan.js";
+import type { Float16 } from "../types/float.js";
+import { roundFloat16 } from "./round.js";
+
+/**
+ * Checks if a value is a valid {@linkcode Float16} as per IEEE 754-2008.
+ *
+ * @param it The value to check.
+ * @returns `true` if the value is a float16 number, `false` otherwise.
+ * @see https://en.wikipedia.org/wiki/Half-precision_floating-point_format
+ * @see https://en.wikipedia.org/wiki/IEEE_754
+ * @example
+ * ```ts
+ * import { isFloat16 } from "@nick/math/float16/guards";
+ *
+ * console.log(isFloat16(0.5)); // true
+ * console.log(isFloat16(0.1)); // false
+ * ```
+ * @see {@linkcode isFloat32} for a similar function for float32 numbers.
+ * @category Guards
+ * @tags float16
+ */
+export function isFloat16<N extends number>(it: N): it is Float16<N>;
+export function isFloat16(it: unknown): it is Float16<number>;
+export function isFloat16(it: unknown): it is Float16 {
+  return typeof it === "number" && !isNaN(it) && it === roundFloat16(it);
+}

package/src/float16/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Utilities for working with `float16` values (16-bit half precision floating
+ * point numbers), as defined by IEEE 754-2008.
+ *
+ * @module float16
+ */
+export * from "./decode.js";
+export * from "./encode.js";
+export * from "./guards.js";
+export * from "./round.js";

package/src/float16/round.ts

@@ -0,0 +1,43 @@
+/**
+ * This module provides functions for rounding numbers to 16-bit floating point
+ * values that follow the IEEE 754-2008 standard for half-precision binary16
+ * floating point numbers.
+ *
+ * The `roundFloat16` function rounds a number to the nearest 16-bit floating
+ * point value (half precision), following the same rounding and conversion
+ * rules as the native `Math.f16round` function from the TC39 Proposal for
+ * [Float16Array], which began shipping in ES2024.
+ *
+ * [Float16Array]: https://github.com/tc39/proposal-float16array
+ *
+ * @module float16/round
+ */
+import { encodeFloat16 } from "./encode.js";
+import { decodeFloat16 } from "./decode.js";
+
+/**
+ * Rounds a number to the nearest 16-bit floating point value (half precision).
+ *
+ * Based on `Math.f16round` function from the TC39 Proposal for [Float16Array],
+ * which began shipping in ES2024, this function follows the same rounding and
+ * conversion rules as per the IEEE 754-2008 specification for half-precision
+ * floating-point numbers (also known as binary16).
+ *
+ * [Float16Array]: https://github.com/tc39/proposal-float16array
+ *
+ * @param x The number to round.
+ * @returns The 16-bit floating point rounded value of the number.
+ * @category Rounding
+ * @tags float, float16
+ * @example
+ * ```ts
+ * import { roundFloat16 } from "@nick/math/float16/round";
+ * import { PI } from "@nick/math/constants";
+ * import assert from "node:assert";
+ *
+ * assert.strictEqual(roundFloat16(PI), 3.140625); // OK
+ * ```
+ */
+export function roundFloat16(x: number): number {
+  return decodeFloat16(encodeFloat16(+x));
+}