====== mod ======

===== Description =====

Calculate the modulo of two integers (i.e. the remainder of //arg1// divided by //arg2//).

===== Function prototype =====

<code>
variant mod <variant:arg1> <variant:arg2>
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //arg1//  |  variant  | The dividend of the modulo operation. |
|  //arg2//  |  variant  | The divisor of the modulo operation. |

===== Return value =====

The value of //arg1// modulo //arg2//, in the data type of //arg1//. 

===== Example =====

<code>
echo <zs:mod 17 3>
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
2
</file>

===== Comments =====

None.

===== See also =====

  * [[plugins:general:zeoscript:reference:functions:add]]
  * [[plugins:general:zeoscript:reference:functions:sub]]
  * [[plugins:general:zeoscript:reference:functions:mul]]
  * [[plugins:general:zeoscript:reference:functions:div]]