xotic750 / modulo-x Goto Github PK

modulo - floored division implementation.

The notation “x modulo y” (y must be finite and nonzero) computes a value k of the same sign as y (or zero) such that abs(k) < abs(y) and x-k = q × y for some integer q.

Donald Knuth described floored division where the quotient is defined by the floor function q = ⌊a/n⌋ and thus according to equation the remainder would have the same sign as the divisor. Due to the floor function, the quotient is always rounded downwards, even if it is already negative.

Kind: Exported function
Returns: number - The integer remainder.
See

• http://www.ecma-international.org/ecma-262/6.0/#sec-algorithm-conventions
• https://en.wikipedia.org/wiki/Modulo_operation

Example

import modulo from 'modulo-x';

console.log(modulo(1, 0x1000000)); // 1
console.log(modulo(-1, 0x1000000)); // 16777215 (2^24-1)