ts-data-forge
    Preparing search index...

    Variable NonZeroInt16

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

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

    All operations automatically clamp results to the valid NonZeroInt16 range [-32768, 32767] excluding 0. This ensures that all arithmetic maintains the 16-bit non-zero signed integer constraint, preventing zero results and overflow.

    Type Declaration

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

      Returns the absolute value of a 16-bit non-zero signed integer.

    • clamp: (x: number) => NonZeroInt16

      Clamps a number to the NonZeroInt16 range (avoiding zero).

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

      Type guard to check if a value is a NonZeroInt16.

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

      Returns the larger of two NonZeroInt16 values.

    • ReadonlyMAX_VALUE: number

      The maximum value for a 16-bit non-zero signed integer.

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

      Returns the smaller of two NonZeroInt16 values.

    • ReadonlyMIN_VALUE: number

      The minimum value for a 16-bit non-zero signed integer.

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

      Multiplies two NonZeroInt16 values.

      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) => NonZeroInt16

      Raises a NonZeroInt16 to the power of another NonZeroInt16.

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

      Generates a random NonZeroInt16 value within the valid range.

    Settings

    Member Visibility