Differences

This shows you the differences between two versions of the page.

--- syntax:functions:rem [2017/12/23 09:01] – created dmitry
+++ syntax:functions:rem [2021/08/11 15:32] (current) – [Examples] craigt
@@ Line 1: / Line 1: @@
-===== rem(number, number) =======
+====== Rem(dividend, divisor) ======
+Category:  Number function
-returns the remainder of quotient of two numbers. Example:
+\\
+=====Description=====
+This function returns the remainder of the quotient of two numbers.
-^  Example  ^  Result  ^
+\\
-| rem(10,3)   |  1 |
+=====Arguments=====
+^Argument^Type^Description^
+|dividend|Number|The value being divided.|
+|divisor|Number (non-zero)|The value the //divident// is being divided by.|
+\\
+**Return value type:**  Number (Integer)
+\\
+=====Remarks=====
+This function performs division much as the expression //dividend// / //divisor// would, except that only the __remainder__ of the division, if there is any, is returned as a whole number.
-See also:
+\\
-  * [[syntax:functions:div]]
+=====Examples=====
+  rem(12,4) //Returns 0
+  rem(15,3) //Returns 0
+  rem(21,5) //Returns 1  (Remainder only returned as a whole number.)
+  rem(-14,5) //Returns -4  (Remainder only returned as a whole number.)
+\\
+===== See also =====
+  * [[syntax:functions:div|Div(dividend, divisor)]]