Differences

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

--- syntax:functions:sign [2014/09/16 21:41] – created dmitry
+++ syntax:functions:sign [2021/08/01 16:13] – craigt
@@ Line 1: / Line 1: @@
 ====== Sign(number) ======
+Category:  Number function
-Sign of a number.
+\\
+=====Description=====
+This function determines whether //number// is positive, negative, or zero.  If positive the value 1 is returned.  If negative, the value -1 is returned.  If //number// is 0, then 0 is returned.
-^  Example  ^  Result  ^
+\\
-| sign(0 - 85)  |  -1 |
+=====Arguments=====
-| sign(0)  |  0 |
+^Argument^Type^Description^
-| sign(125.1231)  |  1 |
+|number|Number|The value being tested as positive, negative or zero.|
+\\
+**Return value type:**  Number (1, -1, or 0)
+\\
+=====Remarks=====
+An expression that results in a numeric answer can be used as the //number// argument.  In this case, the result of the expression is tested.
+\\
+=====Examples=====
+  sign(27) = 1
+  sign(-42) = -1
+  sign(0) = 0
+  sign(14*-3) = -1
+  sign(88 * 0) = 0
+  sign(12 * 3) = 1