ts-data-forge
    Preparing search index...

    Variable NonZeroSafeInt

    NonZeroSafeInt: {
        abs: (x: WithSmallInt) => IntersectBrand<NonZeroSafeInt>;
        clamp: (x: number) => NonZeroSafeInt;
        is: (a: number) => a is NonZeroSafeInt;
        max: (...values: readonly WithSmallInt<NonZeroSafeInt>[]) => NonZeroSafeInt;
        MAX_VALUE: SafeUint;
        min: (...values: readonly WithSmallInt<NonZeroSafeInt>[]) => NonZeroSafeInt;
        MIN_VALUE: SafeInt;
        mul: (x: WithSmallInt, y: WithSmallInt) => NonZeroSafeInt;
        pow: (x: WithSmallInt, y: WithSmallInt) => NonZeroSafeInt;
        random: (
            min?: WithSmallInt<NonZeroSafeInt>,
            max?: WithSmallInt<NonZeroSafeInt>,
        ) => NonZeroSafeInt;
    }

    Namespace providing type-safe arithmetic operations for non-zero safe integers.

    All operations automatically clamp results to the non-zero safe integer range, excluding zero. This ensures that all arithmetic maintains both the non-zero constraint and IEEE 754 precision guarantees, preventing precision loss while ensuring results are never zero.

    Type Declaration

    • abs: (x: WithSmallInt) => IntersectBrand<NonZeroSafeInt>

      Returns the absolute value of a non-zero safe integer.

    • clamp: (x: number) => NonZeroSafeInt

      Clamps a number to the non-zero safe integer range.

    • is: (a: number) => a is NonZeroSafeInt

      Type guard to check if a value is a NonZeroSafeInt.

    • Readonlymax: (...values: readonly WithSmallInt<NonZeroSafeInt>[]) => NonZeroSafeInt

      Returns the larger of two NonZeroSafeInt values.

    • ReadonlyMAX_VALUE: SafeUint

      The maximum safe integer value (2^53 - 1).

    • Readonlymin: (...values: readonly WithSmallInt<NonZeroSafeInt>[]) => NonZeroSafeInt

      Returns the smaller of two NonZeroSafeInt values.

    • ReadonlyMIN_VALUE: SafeInt

      The minimum safe integer value (-(2^53 - 1)).

    • mul: (x: WithSmallInt, y: WithSmallInt) => NonZeroSafeInt

      Multiplies two NonZeroSafeInt values.

      The product of two non-zero safe integers is always non-zero, so this stays closed; for the non-closed operations (add/sub/div, whose result may be 0) use Num.add/Num.sub/Num.divInt.

    • pow: (x: WithSmallInt, y: WithSmallInt) => NonZeroSafeInt

      Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.

    • random: (
          min?: WithSmallInt<NonZeroSafeInt>,
          max?: WithSmallInt<NonZeroSafeInt>,
      ) => NonZeroSafeInt

      Generates a random NonZeroSafeInt value within the valid range.

    Settings

    Member Visibility