[[modding:function:modulo]]

=== modulo ===

[[modding:function:modulo]]

^ Syntax | (modulo dividend divisor) -> remainder |
^ Arguments | dividend: The dividend of the two numbers. |
^ | divisor: The divisor of the two numbers. |
^ Returns | remainder: The remainder of the two numbers passed |
^ Category | [[0.99 functions|0.99]], [[math functions|math]] |
^ Description | Finds the remainder of the two numbers and returns it. |

Important for many things including bounding an arbitrary number between two numbers.

=== Example ===

<code lisp>(modulo 3 2)</code>
This code will return 1.

<code lisp>(modulo 56 34)</code>
This code will return the number 22.

<code lisp>(modulo 10 4)</code>
This code will return 2.

IMPORTANT: This function changed name to modulo from [[modulus]] in 0.98d.

See also [[divide]]

Return to [[:Functions]] list