60 lines
1.1 KiB
Markdown
60 lines
1.1 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function mod
|
||
|
|
|
||
|
|
Calculates the modulus, the remainder of an integer division.
|
||
|
|
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
The modulus is defined as:
|
||
|
|
|
||
|
|
x - y * floor(x / y)
|
||
|
|
|
||
|
|
See https://en.wikipedia.org/wiki/Modulo_operation.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.mod(x, y)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Fraction | Array | Matrix | Dividend
|
||
|
|
`y` | number | BigNumber | Fraction | Array | Matrix | Divisor
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | BigNumber | Fraction | Array | Matrix | Returns the remainder of `x` divided by `y`.
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.mod(8, 3) // returns 2
|
||
|
|
math.mod(11, 2) // returns 1
|
||
|
|
|
||
|
|
function isOdd(x) {
|
||
|
|
return math.mod(x, 2) != 0
|
||
|
|
}
|
||
|
|
|
||
|
|
isOdd(2) // returns false
|
||
|
|
isOdd(3) // returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[divide](divide.md)
|