mod (MATLAB Functions)

Modulus after division

Syntax

```
M = mod(X,Y)
```

Description

M = mod(X,Y) if Y ~= 0, returns X - n.*Y where n = floor(X./Y). If Y is not an integer and the quotient X./Y is within roundoff error of an integer, then n is that integer. The inputs X and Y must be real arrays of the same size, or real scalars.

The following are true by convention:

mod(X,0) is X
mod(X,X) is 0
mod(X,Y) for X~=Y and Y~=0 has the same sign as Y.

Remarks

rem(X,Y) for X~=Y and Y~=0 has the same sign as X.

mod(X,Y) and rem(X,Y) are equal if X and Y have the same sign, but differ by Y if X and Y have different signs.

The mod function is useful for congruence relationships: x and y are congruent (mod m) if and only if mod(x,m) == mod(y,m).

Examples

mod(13,5)
ans =
     3

mod([1:5],3)
ans =
     1     2     0     1     2 

mod(magic(3),3)
ans =
     2     1     0
     0     2     1
     1     0     2

See Also

rem

mmfileinfo more