Differences

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

--- syntax:functions:div [2017/12/23 09:01] – created dmitry
+++ syntax:functions:div [2021/08/11 15:16] (current) – [Examples] craigt
@@ Line 1: / Line 1: @@
-===== div(number, number) =======
+====== Div(dividend, divisor) ======
+Category:  Number function
-Returns the quotient of two numbers. Example:
+\\
+=====Description=====
+This function returns the quotient of two numbers.
-^  Example  ^  Result  ^
+\\
-| div(10,3)   |  3 |
+=====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 __whole number__ portion is returned.  The decimal portion (remainder) is not returned.  Refer to the [[syntax:functions:rem|Rem(number, number)]] function to capture any remainder.
+\\
+=====Examples=====
+  div(12,4) //Returns 3
+  div(15,3) //Returns 5
+  div(21,5) //Returns 4  (Decimal portion (remainder) is not returned)
+  div(-14,5) //Returns -2  (Decimal portion (remainder) is not returned)
+\\
+===== See also =====
+  * [[syntax:functions:rem|Rem(number, number)]]
-See also:
-  * [[syntax:functions:rem]]