kaven-basic - v6.0.0
    Preparing search index...

    Function Mod

    • Computes the true mathematical modulo of a number, ensuring a non-negative result even for negative inputs.

      This function returns the remainder of the division of num by n, always in the range [0, n). It handles negative numbers correctly, unlike the % operator in JavaScript/TypeScript.

      Parameters

      • num: number

        The dividend.

      • n: number

        The divisor (must be a non-zero number).

      Returns number

      The non-negative remainder of num divided by n.

      Mod(5, 3);    // returns 2
      Mod(-5, 3); // returns 1

      4.0.0

      2021-12-14