Variable NonZeroInt16

Type Declaration

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

  Returns the absolute value of a non-zero integer in [-2^15, 2^15).

  The result is non-negative and keeps the NonZeroInt16 brand.

• fromNumber: (x: number) => NonZeroInt16

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

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

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

  Type guard that checks if a value is a non-zero integer in [-2^15, 2^15).

  See

  isNonZeroInt16 for usage examples

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

  Returns the largest of the given non-zero integers.

• MAX_VALUE: number

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

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

  Returns the smallest of the given non-zero integers.

• MIN_VALUE: number

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

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

  Multiplies two non-zero integers, returning a * b as a NonZeroInt16.

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

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

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

  Generates a random NonZeroInt16 within the given range.

  The range is inclusive on both ends.