mathjs/docs/reference/functions/mod.md

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser and offers an integrated solution to work with numbers, big numbers, complex numbers, units, and matrices.

# 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 http://en.wikipedia.org/wiki/Modulo_operation.


## Syntax

```js
math.mod(x, y)
```

### Parameters

Parameter | Type | Description
--------- | ---- | -----------
`x` | Number | BigNumber | Boolean | Array | Matrix | null | Dividend
`y` | Number | BigNumber | Boolean | Array | Matrix | null | Divisor

### Returns

Type | Description
---- | -----------
Number | BigNumber | Array | Matrix | Returns the remainder of `x` divided by `y`.


## 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)


<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->