# mod

### mod(number, modulo)

Returns the integer part of the remainder of number divided by modulo.

## Arguments

Argumentn | Data Type | Description
--- | --- | ---
Number | number | Number to start with
Divisor | number | Used to divide the number

## Returns

Returns the integer part of the remainder of number divided by the divisor.

For example:

- mod(1, 3) = 1
- mod(2, 3) = 2
- mod(3, 3) = 0
- mod(4, 3) = 1
- mod(5, 3) = 2
- mod(6, 3) = 0

## Description

The mod() function is typically used when you want to increment a number and have it wrap around.

### Examples

For example:

- mod(1, 3) = 1
- mod(2, 3) = 2
- mod(3, 3) = 0
- mod(4, 3) = 1
- mod(5, 3) = 2
- mod(6, 3) = 0