ts-data-forge
    Preparing search index...

    Variable PositiveFiniteNumber

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

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

    The PositiveFiniteNumber type represents a positive finite number.

    Type Declaration

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

      Adds two positive finite numbers, returning a + b as a PositiveFiniteNumber.

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

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

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

      Divides two positive finite numbers, returning a / b as a PositiveFiniteNumber.

    • floor: (x: PositiveFiniteNumber) => RemoveNonZeroBrandKey<ToInt<PositiveFiniteNumber>>

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

    • fromNumber: (x: number) => PositiveFiniteNumber

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

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

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

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

      isPositiveFiniteNumber for usage examples

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

      Returns the largest of the given positive finite numbers.

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

      Returns the smallest of the given positive finite numbers.

    • MIN_VALUE: number

      The smallest value representable as PositiveFiniteNumber (the lower saturation target of fromNumber). The domain is open at 0 (excluded), so this is Number.MIN_VALUE — the smallest positive double — rather than 0.

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

      Multiplies two positive finite numbers, returning a * b as a PositiveFiniteNumber.

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

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

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

      Generates a random PositiveFiniteNumber within the given range.

      The range is inclusive on both ends.

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

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

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

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

    Settings
    Member Visibility