ts-data-forge
    Preparing search index...

    Variable NonPositiveFiniteNumber

    NonPositiveFiniteNumber: {
        add: (
            x: NonPositiveFiniteNumber,
            y: NonPositiveFiniteNumber,
        ) => NonPositiveFiniteNumber;
        ceil: (
            x: NonPositiveFiniteNumber,
        ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>;
        floor: (
            x: NonPositiveFiniteNumber,
        ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>;
        fromNumber: (x: number) => NonPositiveFiniteNumber;
        is: (a: number) => a is NonPositiveFiniteNumber;
        max: (
            ...values: readonly NonPositiveFiniteNumber[],
        ) => NonPositiveFiniteNumber;
        MAX_VALUE: 0;
        min: (
            ...values: readonly NonPositiveFiniteNumber[],
        ) => NonPositiveFiniteNumber;
        pow: (
            x: NonPositiveFiniteNumber,
            y: NonPositiveFiniteNumber,
        ) => NonPositiveFiniteNumber;
        random: (
            min?: NonPositiveFiniteNumber,
            max?: NonPositiveFiniteNumber,
        ) => NonPositiveFiniteNumber;
        round: (
            x: NonPositiveFiniteNumber,
        ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>;
        sub: (
            x: NonPositiveFiniteNumber,
            y: NonPositiveFiniteNumber,
        ) => NonPositiveFiniteNumber;
    }

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

    The NonPositiveFiniteNumber type represents a non-positive finite number.

    Type Declaration

    • add: (
          x: NonPositiveFiniteNumber,
          y: NonPositiveFiniteNumber,
      ) => NonPositiveFiniteNumber

      Adds two non-positive finite numbers, returning a + b as a NonPositiveFiniteNumber.

    • ceil: (
          x: NonPositiveFiniteNumber,
      ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>

      Returns the smallest integer greater than or equal to a non-positive finite number.

    • floor: (
          x: NonPositiveFiniteNumber,
      ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>

      Returns the greatest integer less than or equal to a non-positive finite number.

    • fromNumber: (x: number) => NonPositiveFiniteNumber

      Converts an arbitrary number into a NonPositiveFiniteNumber, saturating it into the range [MIN_VALUE, MAX_VALUE].

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

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

      Type guard that checks if a value is a non-positive finite number.

      isNonPositiveFiniteNumber for usage examples

    • Readonlymax: (...values: readonly NonPositiveFiniteNumber[]) => NonPositiveFiniteNumber

      Returns the largest of the given non-positive finite numbers.

    • MAX_VALUE: 0

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

    • Readonlymin: (...values: readonly NonPositiveFiniteNumber[]) => NonPositiveFiniteNumber

      Returns the smallest of the given non-positive finite numbers.

    • pow: (
          x: NonPositiveFiniteNumber,
          y: NonPositiveFiniteNumber,
      ) => NonPositiveFiniteNumber

      Raises a to the power b, returning a ** b as a NonPositiveFiniteNumber.

    • random: (
          min?: NonPositiveFiniteNumber,
          max?: NonPositiveFiniteNumber,
      ) => NonPositiveFiniteNumber

      Generates a random NonPositiveFiniteNumber within the given range.

      The range is inclusive on both ends.

    • round: (
          x: NonPositiveFiniteNumber,
      ) => RemoveNonZeroBrandKey<ToInt<NonPositiveFiniteNumber>>

      Returns the value of a non-positive finite number rounded to the nearest integer.

    • sub: (
          x: NonPositiveFiniteNumber,
          y: NonPositiveFiniteNumber,
      ) => NonPositiveFiniteNumber

      Subtracts two non-positive finite numbers, returning a - b as a NonPositiveFiniteNumber.

    Settings
    Member Visibility