ts-data-forge
    Preparing search index...

    Variable NonNegativeInt32

    NonNegativeInt32: {
        add: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32;
        div: (
            x: WithSmallInt,
            y: ToNonZeroIntWithSmallInt<NonNegativeInt32>,
        ) => NonNegativeInt32;
        fromNumber: (x: number) => NonNegativeInt32;
        is: (a: number) => a is NonNegativeInt32;
        max: (
            ...values: readonly WithSmallInt<NonNegativeInt32>[],
        ) => NonNegativeInt32;
        MAX_VALUE: number;
        min: (
            ...values: readonly WithSmallInt<NonNegativeInt32>[],
        ) => NonNegativeInt32;
        MIN_VALUE: 0;
        mul: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32;
        pow: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32;
        random: (
            min?: WithSmallInt<NonNegativeInt32>,
            max?: WithSmallInt<NonNegativeInt32>,
        ) => NonNegativeInt32;
        sub: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32;
    }

    Namespace providing type-safe operations for the NonNegativeInt32 branded type.

    The NonNegativeInt32 type represents a non-negative integer in [0, 2^31). Division (div) uses floor division.

    Type Declaration

    • add: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32

      Adds two non-negative integers, returning a + b as a NonNegativeInt32.

    • div: (
          x: WithSmallInt,
          y: ToNonZeroIntWithSmallInt<NonNegativeInt32>,
      ) => NonNegativeInt32

      Divides two non-negative integers using floor division (⌊a / b⌋): the result is a / b rounded toward negative infinity, as a NonNegativeInt32.

    • fromNumber: (x: number) => NonNegativeInt32

      Converts an arbitrary number into a NonNegativeInt32, rounding to the nearest integer and saturating the result into the range [MIN_VALUE, MAX_VALUE].

      Unlike asNonNegativeInt32, this is total: out-of-range inputs are clamped to the nearest representable NonNegativeInt32 instead of throwing.

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

      Type guard that checks if a value is a non-negative integer in [0, 2^31).

      isNonNegativeInt32 for usage examples

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

      Returns the largest of the given non-negative integers.

    • MAX_VALUE: number

      The largest value representable as NonNegativeInt32 (the upper saturation target of fromNumber).

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

      Returns the smallest of the given non-negative integers.

    • MIN_VALUE: 0

      The smallest value representable as NonNegativeInt32 (the lower saturation target of fromNumber).

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

      Multiplies two non-negative integers, returning a * b as a NonNegativeInt32.

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

      Raises a to the power b, returning a ** b as a NonNegativeInt32 (floored to an integer).

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

      Generates a random NonNegativeInt32 within the given range.

      The range is inclusive on both ends.

    • sub: (x: WithSmallInt, y: WithSmallInt) => NonNegativeInt32

      Subtracts two non-negative integers, returning a - b as a NonNegativeInt32.

    Settings
    Member Visibility