summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2014-11-20 19:59:50 -0800
committerKaz Kylheku <kaz@kylheku.com>2014-11-20 19:59:50 -0800
commitd4b9a1e45899f86dbb9d5bef1f53fffa9dc05d44 (patch)
tree72d8ed7b5ee105ce47332e46c11a4f1a799e8b55 /txr.1
parent87626d48be8c54b4aa53cb4829ff1c3fc34eb02e (diff)
downloadtxr-d4b9a1e45899f86dbb9d5bef1f53fffa9dc05d44.tar.gz
txr-d4b9a1e45899f86dbb9d5bef1f53fffa9dc05d44.tar.bz2
txr-d4b9a1e45899f86dbb9d5bef1f53fffa9dc05d44.zip
* arith.c (succ, ssucc, sssucc, pred, ppred, pppred): New functions.
* eval.c (eval_init): Register new functions as intrinsics. * lib.h (succ, ssucc, sssucc, pred, ppred, pppred): Declared. * txr.1: Documented.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.132
1 files changed, 32 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 001f7b00..fd1e1822 100644
--- a/txr.1
+++ b/txr.1
@@ -18434,6 +18434,38 @@ is not divisible by two (odd), otherwise
it returns
.codn nil .
+.coNP Functions @, succ @, ssucc @, sssucc @, pred @, ppred @ and pppred
+.synb
+.mets (succ << number )
+.mets (ssucc << number )
+.mets (sssucc << number )
+.mets (pred << number )
+.mets (ppred << number )
+.mets (pppred << number )
+.syne
+.desc
+The
+.code succ
+function adds 1 to its argument and returns the resulting value.
+If the argument is an integer, then the return value is the successor
+of that integer, and if it is a character, then the return value
+is the successor of that character according to Unicode.
+
+The
+.code pred
+function subtracts 1 from its argument, and under similar considerations
+as above, the result represents the predecessor.
+
+The
+.code ssucc
+and
+.code sssucc
+functions add 2 and 3, respectively. Similarly,
+.code ppred
+and
+.code pppred
+subtract 2 and 3 from their argument.
+
.coNP Functions @, > @, < @, >= @ <= and @ =
.synb
.mets (> < number << number *)