From e9b78ff2c7a7765b842588c9a93f84956de9834d Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Tue, 27 Jan 2015 06:30:11 -0800
Subject: * arith.c (width): New function.

* arith.h (width): Declared.

* eval.c (eval_init): Width registered as intrisinc.

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

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index 668a12c9..5d064cc7 100644
--- a/txr.1
+++ b/txr.1
@@ -19395,6 +19395,34 @@ In other words, the following equivalences hold:
   (mask a b c ...) <--> (logior (mask a) (mask b) (mask c) ...)
 .cble
 
+.coNP Function @ width
+.synb
+.mets (width << integer *)
+.syne
+.desc
+A two's complement representation of an integer consists of a sign bit and a
+manitssa field.
+The
+.code width
+function computes the minimum number of bits required for the mantissa portion
+of the two's complement representation of the
+.meta integer
+argument.
+
+For a nonnegative argument, the width also corresponds to the number of bits
+required for a natural binary representation of that value.
+
+Two integer values have a width of zero, namely 0 and -1. This means that these
+two values can be represented in a one-bit two's complement, consisting of only
+a sign bit: the one-bit two's complement bitfield 1 denotes -1, and 0 denotes
+0.
+
+Similarly, two integer values have a width of 1: 1 and -2. The two-bit
+two's complement bitfield 01 denotes 1, and 10 denotes -2.
+
+The argument may be a character.
+
+
 .SS* Exceptions
 .coNP Functions @, throw @ throwf and @ error
 .synb
-- 
cgit v1.2.3