ts-data-forge
    Preparing search index...

    Variable FiniteNumber

    FiniteNumber: {
        abs: (x: FiniteNumber) => IntersectBrand<FiniteNumber>;
        add: (x: FiniteNumber, y: FiniteNumber) => FiniteNumber;
        ceil: (x: FiniteNumber) => ToInt<FiniteNumber>;
        div: (x: FiniteNumber, y: ToNonZero<FiniteNumber>) => FiniteNumber;
        floor: (x: FiniteNumber) => ToInt<FiniteNumber>;
        is: (a: number) => a is FiniteNumber;
        max: (...values: readonly FiniteNumber[]) => FiniteNumber;
        min: (...values: readonly FiniteNumber[]) => FiniteNumber;
        mul: (x: FiniteNumber, y: FiniteNumber) => FiniteNumber;
        pow: (x: FiniteNumber, y: FiniteNumber) => FiniteNumber;
        random: (min?: FiniteNumber, max?: FiniteNumber) => FiniteNumber;
        round: (x: FiniteNumber) => ToInt<FiniteNumber>;
        sub: (x: FiniteNumber, y: FiniteNumber) => FiniteNumber;
    }

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

    The FiniteNumber type represents a finite number.

    Type Declaration

    • abs: (x: FiniteNumber) => IntersectBrand<FiniteNumber>

      Returns the absolute value of a finite number.

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

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

      Adds two finite numbers, returning a + b as a FiniteNumber.

    • ceil: (x: FiniteNumber) => ToInt<FiniteNumber>

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

    • div: (x: FiniteNumber, y: ToNonZero<FiniteNumber>) => FiniteNumber

      Divides two finite numbers, returning a / b as a FiniteNumber.

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

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

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

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

      isFiniteNumber for usage examples

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

      Returns the largest of the given finite numbers.

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

      Returns the smallest of the given finite numbers.

    • mul: (x: FiniteNumber, y: FiniteNumber) => FiniteNumber

      Multiplies two finite numbers, returning a * b as a FiniteNumber.

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

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

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

      Generates a random FiniteNumber within the given range.

      The range is inclusive on both ends.

    • round: (x: FiniteNumber) => ToInt<FiniteNumber>

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

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

      Subtracts two finite numbers, returning a - b as a FiniteNumber.

    Settings
    Member Visibility