MATLAB Function Reference

mod

Modulus after division

Syntax

• M = mod(X,Y)
  

Definition

mod(x,y) is mod .

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. By convention, mod(X,0) is X. The inputs X and Y must be real arrays of the same size, or real scalars.

Remarks

So long as operands X and Y are of the same sign, the function mod(X,Y) returns the same result as does rem(X,Y). However, for positive X and Y,

• mod(-X,Y) = rem(-X,Y)+Y
  

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

mlock

more