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>>;
        floor: (x: NegativeFiniteNumber) => ToInt<NegativeFiniteNumber>;
        fromNumber: (x: number) => 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 operations for the NegativeFiniteNumber branded type.

    The NegativeFiniteNumber type represents a negative finite number.

    Type Declaration

    • abs: (x: NegativeFiniteNumber) => PositiveFiniteNumber

      Returns the absolute value of a negative finite number.

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

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

      Adds two negative finite numbers, returning a + b as a NegativeFiniteNumber.

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

      Returns the smallest integer greater than or equal to a negative finite number.

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

      Returns the greatest integer less than or equal to a negative finite number.

    • fromNumber: (x: number) => NegativeFiniteNumber

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

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

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

      Type guard that checks if a value is a negative finite number.

      isNegativeFiniteNumber for usage examples

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

      Returns the largest of the given negative finite numbers.

    • MAX_VALUE: number

      The largest value representable as NegativeFiniteNumber (the upper saturation target of fromNumber). The domain is open at 0 (excluded), so this is -Number.MIN_VALUE — the negative double closest to 0 — rather than 0.

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

      Returns the smallest of the given negative finite numbers.

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

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

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

      Generates a random NegativeFiniteNumber within the given range.

      The range is inclusive on both ends.

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

      Returns the value of a negative finite number rounded to the nearest integer.

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

      Subtracts two negative finite numbers, returning a - b as a NegativeFiniteNumber.

    Settings
    Member Visibility