ts-data-forge
    Preparing search index...

    Variable NegativeFiniteNumber

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

    Namespace providing type-safe arithmetic operations for negative finite numbers.

    All operations keep results finite (excluding NaN and Infinity). Operations that stay within the negative finite numbers clamp their results to the valid range, while operations whose result leaves the set (mul, div, abs) are typed to reflect the actual sign of the result.

    Type Declaration

    • abs: (x: NegativeFiniteNumber) => PositiveFiniteNumber

      Returns the absolute value of a negative finite number.

      The negative finite number.

      The absolute value as a PositiveFiniteNumber.

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

      Adds two NegativeFiniteNumber values.

    • ceil: (x: NegativeFiniteNumber) => RemoveNonZeroBrandKey<ToInt<NegativeFiniteNumber>>

      Rounds up a NegativeFiniteNumber to the nearest integer.

    • clamp: (x: number) => NegativeFiniteNumber

      Clamps a number to the negative finite range.

    • floor: (x: NegativeFiniteNumber) => ToInt<NegativeFiniteNumber>

      Rounds down a NegativeFiniteNumber to the nearest integer.

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

      Type guard to check if a value is a NegativeFiniteNumber.

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

      Returns the larger of two NegativeFiniteNumber values.

    • ReadonlyMAX_VALUE: number

      The maximum value for a negative finite number.

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

      Returns the smaller of two NegativeFiniteNumber values.

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

      Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.

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

      Generates a random NegativeFiniteNumber value.

    • round: (x: NegativeFiniteNumber) => RemoveNonZeroBrandKey<ToInt<NegativeFiniteNumber>>

      Rounds a NegativeFiniteNumber to the nearest integer.

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

      Subtracts one NegativeFiniteNumber from another.

      The mathematical result can be positive, so it is clamped to the negative finite range (maximum -Number.MIN_VALUE).

    Settings

    Member Visibility