math-mod

v0.9.6

STATUS

Passing

DOWNLOADS

VISIBILITY

Public

PUBLISHED

5 years ago

SIZE

860 B

`mathMod` behaves like the modulo operator should mathematically, unlike the `%` operator (and by extension, [`R.modulo`](#modulo)).

Extension

Math

Utils

1 contributor

Install math-mod as a package?

Copied

npm i @bit/justin-capalbo.ramda.math-mod

Set Bit as a scoped registryLearn more

npm config set '@bit:registry' https://node.bit.cloud

Component Example

React

Vue

Angular

React Native

Add dependency...

Just

import

any of the 1 million components

and packages in Bit or NPM to the example.

import Button from '@bit/grommet.grommet.button';
import Lodash from 'lodash';

No preview available

modifieddraft

mathMod (

m:Number,

p:Number

) : Number

mathMod behaves like the modulo operator should mathematically, unlike the % operator (and by extension, R.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.

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

Arguments

m: Number

The dividend.

p: Number

the modulus.

Returns

Number

The result of `b mod a`.