ts-data-forge
    Preparing search index...

    Variable NonZeroInt

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

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

    All operations maintain the non-zero constraint, ensuring that results are always valid NonZeroInt values. Division operations return floor division results, and all arithmetic maintains integer precision.

    Type Declaration

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

      Returns the absolute value of a non-zero integer.

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

      Type guard to check if a value is a NonZeroInt.

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

      Returns the larger of two non-zero integers.

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

      Returns the smaller of two non-zero integers.

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

      Multiplies two non-zero integers.

      The product of two non-zero 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) => NonZeroInt

      Raises a non-zero integer to the power of another non-zero integer.

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

      Generates a random non-zero integer.

    Settings

    Member Visibility