Document "sign"

Macaulay2 · Jan 20, 2025 · 6042140 · 6042140
1 parent 2fe9d89
commit 6042140
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/M2/Macaulay2/packages/Macaulay2Doc/functions.m2 b/M2/Macaulay2/packages/Macaulay2Doc/functions.m2
@@ -227,6 +227,7 @@ load "./functions/setRandomSeed-doc.m2"
 load "./functions/setupLift-doc.m2"
 load "./functions/setupPromote-doc.m2"
 load "./functions/show-doc.m2"
+load "./functions/sign-doc.m2"
 load "./functions/sin-doc.m2"
 load "./functions/sinh-doc.m2"
 load "./functions/smithNormalForm-doc.m2"

diff --git a/M2/Macaulay2/packages/Macaulay2Doc/functions/sign-doc.m2 b/M2/Macaulay2/packages/Macaulay2Doc/functions/sign-doc.m2
@@ -0,0 +1,26 @@
+doc ///
+  Key
+    sign
+    (sign, Number)
+    (sign, Constant)
+  Headline
+    sign (signum) function
+  Usage
+    sign x
+  Inputs
+    x:Number
+  Outputs
+    :{ZZ,CC}
+  Description
+    Text
+      When @VAR "x"@ is real, then this returns 1 if it is positive, -1 if it
+      is negative, and 0 if it is zero.
+    Example
+      sign 5
+      sign (-3)
+      sign 0
+    Text
+      If @VAR "x"@ is complex and nonzero, then this returns $x/|x|$.
+    Example
+      sign(-7*ii)
+///