API Reference / Mathematics / mathMod

mathMod

Returns the remainder of integer division. Takes dividend (number to divide), divisor (number to divide by). Returns the remainder.

Mathematics

Parameters & Returns

Parameters

dividend Int
divisor Int

Returns

Int

Quick Summary

Returns the remainder of integer division. Takes dividend (number to divide), divisor (number to divide by). Returns the remainder.

Technical Exegesis...

Returns the remainder when dividing dividend by divisor using the modulo operation.

Examples: mathMod(17, 5) returns 2, mathMod(10, 3) returns 1

Returns 0 if the divisor is 0 (division by zero protection). Commonly used for wrapping values, cyclic patterns, and determining divisibility.

Example

Example.bam 
; No example implemented yet
Since: 1.0 Status: Stable
← Back to Mathematics