From 10eda95d8ed320f2dc10edd23bd7bdd238f13ace Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Tue, 7 Aug 2018 06:25:56 -0700
Subject: New function: signum.

arith.c (signum): New function.
(arith_init): signum intrinsic registered.

* txr.1: Documented.
---
 txr.1 | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index 4f04d3aa..bced33a0 100644
--- a/txr.1
+++ b/txr.1
@@ -34863,6 +34863,31 @@ is positive, it is returned. If
 is negative, its additive inverse is
 returned: a positive number of the same type with exactly the same magnitude.
 
+.coNP Function @ signum
+.synb
+.mets (signum << number )
+.syne
+.desc
+The
+.code signum
+function calculates a representation of the sign of
+.meta number
+as a numeric value.
+
+If
+.meta number
+is an integer, then
+.code signum
+returns -1 if the integer is negative, 1 if the integer is positive,
+or else 0.
+
+If
+.meta number
+is a floating-point value then
+.code signum
+returns -1.0 if the value is negative, 1.0 if the value is positive or
+else 0.0.
+
 .coNP Functions @, trunc @, floor @ ceil and @ round
 .synb
 .mets (trunc < dividend <> [ divisor ])
-- 
cgit v1.2.3