Variable SafeUint

Type Declaration

• Readonlyadd: (x: WithSmallInt<SafeUint, 40>, y: WithSmallInt<SafeUint, 40>) => SafeUint

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

• Readonlydiv: (
      x: WithSmallInt<SafeUint, 40>,
      y:
          | 20
          | 1
          | 2
          | 10
          | 3
          | 4
          | 5
          | 6
          | 7
          | 8
          | 9
          | 11
          | 30
          | 18
          | 28
          | 38
          | 12
          | 13
          | 14
          | 15
          | 16
          | 17
          | 19
          | 21
          | 22
          | 23
          | 24
          | 25
          | 26
          | 27
          | 29
          | 31
          | 32
          | 33
          | 34
          | 35
          | 36
          | 37
          | 39
          | NormalizeBrandUnion<
              number & {
                  "!=0": true;
                  "> -2^16": true;
                  "> -2^32": true;
                  ">= -2^15": true;
                  ">= -2^31": true;
                  ">=0": true;
                  Finite: true;
                  Int: true;
                  NaNValue: false;
                  SafeInt: true;
              } & Readonly<
                  {
                      "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
                  },
              >,
          >,
  ) => SafeUint

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

• ReadonlyfromNumber: (x: number) => SafeUint

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

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

• Readonlyis: (a: number) => a is SafeUint

  Type guard that checks if a value is a non-negative safe integer.

  See

  isSafeUint for usage examples

• Readonlymax: (...values: readonly WithSmallInt<SafeUint, 40>[]) => SafeUint

  Returns the largest of the given non-negative safe integers.

• ReadonlyMAX_VALUE: SafeUint

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

• Readonlymin: (...values: readonly WithSmallInt<SafeUint, 40>[]) => SafeUint

  Returns the smallest of the given non-negative safe integers.

• ReadonlyMIN_VALUE: 0

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

• Readonlymul: (x: WithSmallInt<SafeUint, 40>, y: WithSmallInt<SafeUint, 40>) => SafeUint

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

• Readonlypow: (x: WithSmallInt<SafeUint, 40>, y: WithSmallInt<SafeUint, 40>) => SafeUint

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

• Readonlyrandom: (min?: WithSmallInt<SafeUint, 40>, max?: WithSmallInt<SafeUint, 40>) => SafeUint

  Generates a random SafeUint within the given range.

  The range is inclusive on both ends.

• Readonlysub: (x: WithSmallInt<SafeUint, 40>, y: WithSmallInt<SafeUint, 40>) => SafeUint

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