Main Content

Modulus after division for `fi`

objects

returns the modulus after division of `m`

= mod(`x`

,`y`

)`x`

by `y`

, where
`x`

is the dividend and `y`

is the divisor. This
function is often called the modulo operation, which can be expressed as ```
m = x -
floor(x./y).*y
```

.

For fixed-point or integer input arguments, the output data type is the aggregate type of both input signedness, word lengths, and fraction lengths. For floating-point input arguments, the output data type is the same as the inputs.

The `mod`

function ignores and discards any `fimath`

attached to the inputs. The output is always associated with the default
`fimath`

.

**Note**

The combination of fixed-point and floating-point inputs is not supported.

`mod(x,y)`

for a `fi`

object uses the same definition as
the built-in MATLAB^{®}
`mod`

function.