-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
mathMod.js
43 lines (41 loc) · 1.26 KB
/
mathMod.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import _curry2 from './internal/_curry2.js';
import _isInteger from './internal/_isInteger.js';
/**
* `mathMod` behaves like the modulo operator should mathematically, unlike the
* `%` operator (and by extension, [`R.modulo`](#modulo)). So while
* `-17 % 5` is `-2`, `mathMod(-17, 5)` is `3`. `mathMod` requires Integer
* arguments, and returns NaN when the modulus is zero or negative.
*
* @func
* @memberOf R
* @since v0.3.0
* @category Math
* @sig Number -> Number -> Number
* @param {Number} m The dividend.
* @param {Number} p the modulus.
* @return {Number} The result of `b mod a`.
* @see R.modulo
* @example
*
* R.mathMod(-17, 5); //=> 3
* R.mathMod(17, 5); //=> 2
* R.mathMod(17, -5); //=> NaN
* R.mathMod(17, 0); //=> NaN
* R.mathMod(17.2, 5); //=> NaN
* R.mathMod(17, 5.3); //=> NaN
*
* const clock = R.mathMod(R.__, 12);
* clock(15); //=> 3
* clock(24); //=> 0
*
* const seventeenMod = R.mathMod(17);
* seventeenMod(3); //=> 2
* seventeenMod(4); //=> 1
* seventeenMod(10); //=> 7
*/
var mathMod = _curry2(function mathMod(m, p) {
if (!_isInteger(m)) { return NaN; }
if (!_isInteger(p) || p < 1) { return NaN; }
return ((m % p) + p) % p;
});
export default mathMod;