annotate lispref/numbers.texi @ 9524:f42e5fd15f6f

(term_get_fkeys_1): Workaround for IBM's dialect of terminfo.
author Karl Heuer <kwzh@gnu.org>
date Fri, 14 Oct 1994 02:43:58 +0000
parents ae1a594ebb1d
children 89f8d7f3bd73
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 @c See the file elisp.texi for copying conditions.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @setfilename ../info/numbers
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
6 @node Numbers, Strings and Characters, Lisp Data Types, Top
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 @chapter Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @cindex integers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 GNU Emacs supports two numeric data types: @dfn{integers} and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 @dfn{floating point numbers}. Integers are whole numbers such as
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 @minus{}3, 0, 7, 13, and 511. Their values are exact. Floating point
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 numbers are numbers with fractional parts, such as @minus{}4.5, 0.0, or
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
15 2.71828. They can also be expressed in exponential notation:
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
16 1.5e2 equals 150; in this example, @samp{e2} stands for ten to the
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 second power, and is multiplied by 1.5. Floating point values are not
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 exact; they have a fixed, limited amount of precision.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 Support for floating point numbers is a new feature in Emacs 19, and it
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 is controlled by a separate compilation option, so you may encounter a site
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 where Emacs does not support them.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 @menu
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 * Integer Basics:: Representation and range of integers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 * Float Basics:: Representation and range of floating point.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 * Predicates on Numbers:: Testing for numbers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 * Comparison of Numbers:: Equality and inequality predicates.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 * Numeric Conversions:: Converting float to integer and vice versa.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 * Arithmetic Operations:: How to add, subtract, multiply and divide.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 * Rounding Operations:: Explicitly rounding floating point numbers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 * Bitwise Operations:: Logical and, or, not, shifting.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 * Transcendental Functions:: Trig, exponential and logarithmic functions.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 * Random Numbers:: Obtaining random integers, predictable or not.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 @end menu
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @node Integer Basics
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 @comment node-name, next, previous, up
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 @section Integer Basics
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 The range of values for an integer depends on the machine. The
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 range is @minus{}8388608 to 8388607 (24 bits; i.e.,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 @ifinfo
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 -2**23
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 @end ifinfo
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 @tex
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 $-2^{23}$
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 @end tex
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 @ifinfo
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 2**23 - 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 @end ifinfo
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 @tex
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 $2^{23}-1$)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 @end tex
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 on most machines, but on others it is @minus{}16777216 to 16777215 (25
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 bits), or @minus{}33554432 to 33554431 (26 bits). Many examples in this
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 chapter assume an integer has 24 bits.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 @cindex overflow
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 The Lisp reader reads an integer as a sequence of digits with optional
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 initial sign and optional final period.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 1 ; @r{The integer 1.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 1. ; @r{The integer 1.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 +1 ; @r{Also the integer 1.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 -1 ; @r{The integer @minus{}1.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 16777217 ; @r{Also the integer 1, due to overflow.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 0 ; @r{The integer 0.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 -0 ; @r{The integer 0.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 To understand how various functions work on integers, especially the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 bitwise operators (@pxref{Bitwise Operations}), it is often helpful to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 view the numbers in their binary form.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
78 In 24-bit binary, the decimal integer 5 looks like this:
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 0000 0000 0000 0000 0000 0101
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 (We have inserted spaces between groups of 4 bits, and two spaces
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 between groups of 8 bits, to make the binary integer easier to read.)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 The integer @minus{}1 looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 1111 1111 1111 1111 1111 1111
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 @cindex two's complement
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 @minus{}1 is represented as 24 ones. (This is called @dfn{two's
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 complement} notation.)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 The negative integer, @minus{}5, is creating by subtracting 4 from
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 @minus{}1. In binary, the decimal integer 4 is 100. Consequently,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @minus{}5 looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 1111 1111 1111 1111 1111 1011
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
107 In this implementation, the largest 24-bit binary integer is the
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 decimal integer 8,388,607. In binary, it looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 0111 1111 1111 1111 1111 1111
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 Since the arithmetic functions do not check whether integers go
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
115 outside their range, when you add 1 to 8,388,607, the value is the
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
116 negative integer @minus{}8,388,608:
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (+ 1 8388607)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 @result{} -8388608
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 @result{} 1000 0000 0000 0000 0000 0000
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 Many of the following functions accept markers for arguments as well
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 as integers. (@xref{Markers}.) More precisely, the actual arguments to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 such functions may be either integers or markers, which is why we often
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 give these arguments the name @var{int-or-marker}. When the argument
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 value is a marker, its position value is used and its buffer is ignored.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 @ignore
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 In version 19, except where @emph{integer} is specified as an
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 argument, all of the functions for markers and integers also work for
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 floating point numbers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 @end ignore
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 @node Float Basics
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 @section Floating Point Basics
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 @cindex @code{LISP_FLOAT_TYPE} configuration macro
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 Emacs version 19 supports floating point numbers, if compiled with the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 macro @code{LISP_FLOAT_TYPE} defined. The precise range of floating
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 point numbers is machine-specific; it is the same as the range of the C
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 data type @code{double} on the machine in question.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 The printed representation for floating point numbers requires either
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 a decimal point (with at least one digit following), an exponent, or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 both. For example, @samp{1500.0}, @samp{15e2}, @samp{15.0e2},
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 @samp{1.5e3}, and @samp{.15e4} are five ways of writing a floating point
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 number whose value is 1500. They are all equivalent. You can also use
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 a minus sign to write negative floating point numbers, as in
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 @samp{-1.0}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 @cindex IEEE floating point
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 @cindex positive infinity
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 @cindex negative infinity
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 @cindex infinity
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 @cindex NaN
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 Most modern computers support the IEEE floating point standard, which
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 provides for positive infinity and negative infinity as floating point
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
160 values. It also provides for a class of values called NaN or
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
161 ``not-a-number''; numerical functions return such values in cases where
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
162 there is no correct answer. For example, @code{(sqrt -1.0)} returns a
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
163 NaN. For practical purposes, there's no significant difference between
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
164 different NaN values in Emacs Lisp, and there's no rule for precisely
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
165 which NaN value should be used in a particular case, so this manual
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
166 doesn't try to distinguish them. Emacs Lisp has no read syntax for NaNs
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
167 or infinities; perhaps we should create a syntax in the future.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 You can use @code{logb} to extract the binary exponent of a floating
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170 point number (or estimate the logarithm of an integer):
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 @defun logb number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173 This function returns the binary exponent of @var{number}. More
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174 precisely, the value is the logarithm of @var{number} base 2, rounded
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175 down to an integer.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
177
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 @node Predicates on Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 @section Type Predicates for Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 The functions in this section test whether the argument is a number or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 whether it is a certain sort of number. The functions @code{integerp}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 and @code{floatp} can take any type of Lisp object as argument (the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 predicates would not be of much use otherwise); but the @code{zerop}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 predicate requires a number as its argument. See also
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 @code{integer-or-marker-p} and @code{number-or-marker-p}, in
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 @ref{Predicates on Markers}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 @defun floatp object
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 This predicate tests whether its argument is a floating point
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 number and returns @code{t} if so, @code{nil} otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 @code{floatp} does not exist in Emacs versions 18 and earlier.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 @defun integerp object
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 This predicate tests whether its argument is an integer, and returns
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 @code{t} if so, @code{nil} otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 @defun numberp object
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 This predicate tests whether its argument is a number (either integer or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 floating point), and returns @code{t} if so, @code{nil} otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
206 @defun wholenump object
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 @cindex natural numbers
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
208 The @code{wholenump} predicate (whose name comes from the phrase
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
209 ``whole-number-p'') tests to see whether its argument is a nonnegative
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 integer, and returns @code{t} if so, @code{nil} otherwise. 0 is
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 considered non-negative.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
213 @findex natnump
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
214 @code{natnump} is an obsolete synonym for @code{wholenump}.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 @defun zerop number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 This predicate tests whether its argument is zero, and returns @code{t}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 if so, @code{nil} otherwise. The argument must be a number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 These two forms are equivalent: @code{(zerop x)} @equiv{} @code{(= x 0)}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @node Comparison of Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 @section Comparison of Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 @cindex number equality
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
228 To test numbers for numerical equality, you should normally use
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
229 @code{=}, not @code{eq}. There can be many distinct floating point
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
230 number objects with the same numeric value. If you use @code{eq} to
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
231 compare them, then you test whether two values are the same
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
232 @emph{object}. By contrast, @code{=} compares only the numeric values
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
233 of the objects.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
235 At present, each integer value has a unique Lisp object in Emacs Lisp.
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
236 Therefore, @code{eq} is equivalent @code{=} where integers are
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
237 concerned. It is sometimes convenient to use @code{eq} for comparing an
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
238 unknown value with an integer, because @code{eq} does not report an
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
239 error if the unknown value is not a number---it accepts arguments of any
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
240 type. By contrast, @code{=} signals an error if the arguments are not
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
241 numbers or markers. However, it is a good idea to use @code{=} if you
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
242 can, even for comparing integers, just in case we change the
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
243 representation of integers in a future Emacs version.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 There is another wrinkle: because floating point arithmetic is not
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 exact, it is often a bad idea to check for equality of two floating
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 point values. Usually it is better to test for approximate equality.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 Here's a function to do this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (defvar fuzz-factor 1.0e-6)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 (defun approx-equal (x y)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253 (< (/ (abs (- x y))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 (max (abs x) (abs y)))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255 fuzz-factor))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
256 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258 @cindex CL note---integers vrs @code{eq}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 @quotation
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
260 @b{Common Lisp note:} Comparing numbers in Common Lisp always requires
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 @code{=} because Common Lisp implements multi-word integers, and two
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 distinct integer objects can have the same numeric value. Emacs Lisp
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 can have just one integer object for any given value because it has a
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 limited range of integer values.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 @end quotation
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 @defun = number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 This function tests whether its arguments are numerically equal, and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 returns @code{t} if so, @code{nil} otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 @defun /= number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 This function tests whether its arguments are numerically equal, and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274 returns @code{t} if they are not, and @code{nil} if they are.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 @defun < number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 This function tests whether its first argument is strictly less than
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 its second argument. It returns @code{t} if so, @code{nil} otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 @defun <= number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 This function tests whether its first argument is less than or equal
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 to its second argument. It returns @code{t} if so, @code{nil}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 @defun > number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 This function tests whether its first argument is strictly greater
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 than its second argument. It returns @code{t} if so, @code{nil}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 @defun >= number-or-marker1 number-or-marker2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 This function tests whether its first argument is greater than or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 equal to its second argument. It returns @code{t} if so, @code{nil}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297 otherwise.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 @defun max number-or-marker &rest numbers-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 This function returns the largest of its arguments.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304 (max 20)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 @result{} 20
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 (max 1 2.5)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 @result{} 2.5
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 (max 1 3 2.5)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 @result{} 3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 @defun min number-or-marker &rest numbers-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 This function returns the smallest of its arguments.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 (min -4 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 @result{} -4
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 @node Numeric Conversions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323 @section Numeric Conversions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
324 @cindex rounding in conversions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
325
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326 To convert an integer to floating point, use the function @code{float}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328 @defun float number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
329 This returns @var{number} converted to floating point.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
330 If @var{number} is already a floating point number, @code{float} returns
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
331 it unchanged.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
332 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
333
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 There are four functions to convert floating point numbers to integers;
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 they differ in how they round. These functions accept integer arguments
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 also, and return such arguments unchanged.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338 @defun truncate number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 This returns @var{number}, converted to an integer by rounding towards
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 zero.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343 @defun floor number &optional divisor
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
344 This returns @var{number}, converted to an integer by rounding downward
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 (towards negative infinity).
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
346
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 If @var{divisor} is specified, @var{number} is divided by @var{divisor}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 before the floor is taken; this is the division operation that
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 corresponds to @code{mod}. An @code{arith-error} results if
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 @var{divisor} is 0.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 @defun ceiling number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 This returns @var{number}, converted to an integer by rounding upward
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 (towards positive infinity).
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 @defun round number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 This returns @var{number}, converted to an integer by rounding towards the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 nearest integer.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 @node Arithmetic Operations
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 @section Arithmetic Operations
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366 Emacs Lisp provides the traditional four arithmetic operations:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 addition, subtraction, multiplication, and division. Remainder and modulus
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 functions supplement the division functions. The functions to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 add or subtract 1 are provided because they are traditional in Lisp and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370 commonly used.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 All of these functions except @code{%} return a floating point value
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 if any argument is floating.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 It is important to note that in GNU Emacs Lisp, arithmetic functions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 do not check for overflow. Thus @code{(1+ 8388607)} may evaluate to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 @minus{}8388608, depending on your hardware.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 @defun 1+ number-or-marker
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 This function returns @var{number-or-marker} plus 1.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 For example,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 (setq foo 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 @result{} 4
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 (1+ foo)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 @result{} 5
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 This function is not analogous to the C operator @code{++}---it does
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 not increment a variable. It just computes a sum. Thus,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 foo
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 @result{} 4
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 If you want to increment the variable, you must use @code{setq},
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 (setq foo (1+ foo))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 @result{} 5
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 @defun 1- number-or-marker
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 This function returns @var{number-or-marker} minus 1.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 @defun abs number
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 This returns the absolute value of @var{number}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 @defun + &rest numbers-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 This function adds its arguments together. When given no arguments,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 @code{+} returns 0. It does not check for overflow.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 (+)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 @result{} 0
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 (+ 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 (+ 1 2 3 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 @result{} 10
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 @defun - &optional number-or-marker &rest other-numbers-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430 The @code{-} function serves two purposes: negation and subtraction.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 When @code{-} has a single argument, the value is the negative of the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 argument. When there are multiple arguments, @code{-} subtracts each of
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433 the @var{other-numbers-or-markers} from @var{number-or-marker},
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
434 cumulatively. If there are no arguments, the result is 0. This
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
435 function does not check for overflow.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
436
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 (- 10 1 2 3 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 @result{} 0
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 (- 10)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 @result{} -10
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 (-)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 @result{} 0
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
446
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
447 @defun * &rest numbers-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448 This function multiplies its arguments together, and returns the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 product. When given no arguments, @code{*} returns 1. It does
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 not check for overflow.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
451
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453 (*)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 (* 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 (* 1 2 3 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 @result{} 24
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 @defun / dividend divisor &rest divisors
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
463 This function divides @var{dividend} by @var{divisor} and returns the
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 quotient. If there are additional arguments @var{divisors}, then it
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465 divides @var{dividend} by each divisor in turn. Each argument may be a
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 number or a marker.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 If all the arguments are integers, then the result is an integer too.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 This means the result has to be rounded. On most machines, the result
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 is rounded towards zero after each division, but some machines may round
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 differently with negative arguments. This is because the Lisp function
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 @code{/} is implemented using the C division operator, which also
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 permits machine-dependent rounding. As a practical matter, all known
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 machines round in the standard fashion.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 @cindex @code{arith-error} in division
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 If you divide by 0, an @code{arith-error} error is signaled.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 (@xref{Errors}.)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 (/ 6 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 @result{} 3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 (/ 5 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 @result{} 2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 (/ 25 3 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 @result{} 4
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 (/ -17 6)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 @result{} -2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 The result of @code{(/ -17 6)} could in principle be -3 on some
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 machines.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 @defun % dividend divisor
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 @cindex remainder
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 This function returns the integer remainder after division of @var{dividend}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 by @var{divisor}. The arguments must be integers or markers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 For negative arguments, the remainder is in principle machine-dependent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 since the quotient is; but in practice, all known machines behave alike.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 An @code{arith-error} results if @var{divisor} is 0.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 (% 9 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508 (% -9 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 @result{} -1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 (% 9 -4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 (% -9 -4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 @result{} -1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 For any two integers @var{dividend} and @var{divisor},
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 (+ (% @var{dividend} @var{divisor})
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 (* (/ @var{dividend} @var{divisor}) @var{divisor}))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 always equals @var{dividend}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 @defun mod dividend divisor
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @cindex modulus
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 This function returns the value of @var{dividend} modulo @var{divisor};
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 in other words, the remainder after division of @var{dividend}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 by @var{divisor}, but with the same sign as @var{divisor}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 The arguments must be numbers or markers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 Unlike @code{%}, @code{mod} returns a well-defined result for negative
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 arguments. It also permits floating point arguments; it rounds the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 quotient downward (towards minus infinity) to an integer, and uses that
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 quotient to compute the remainder.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 An @code{arith-error} results if @var{divisor} is 0.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 (mod 9 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 (mod -9 4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 @result{} 3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 (mod 9 -4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 @result{} -3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (mod -9 -4)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 @result{} -1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 (mod 5.5 2.5)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 @result{} .5
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 For any two numbers @var{dividend} and @var{divisor},
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 (+ (mod @var{dividend} @var{divisor})
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 (* (floor @var{dividend} @var{divisor}) @var{divisor}))
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 always equals @var{dividend}, subject to rounding error if
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 either argument is floating point.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 @node Rounding Operations
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 @section Rounding Operations
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 @cindex rounding without conversion
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573
8017
ae1a594ebb1d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
574 The functions @code{ffloor}, @code{fceiling}, @code{fround} and
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 @code{ftruncate} take a floating point argument and return a floating
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 point result whose value is a nearby integer. @code{ffloor} returns the
8017
ae1a594ebb1d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
577 nearest integer below; @code{fceiling}, the nearest integer above;
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
578 @code{ftruncate}, the nearest integer in the direction towards zero;
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 @code{fround}, the nearest integer.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 @defun ffloor float
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 This function rounds @var{float} to the next lower integral value, and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 returns that value as a floating point number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585
8017
ae1a594ebb1d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
586 @defun fceiling float
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 This function rounds @var{float} to the next higher integral value, and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 returns that value as a floating point number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
591 @defun ftruncate float
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 This function rounds @var{float} towards zero to an integral value, and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 returns that value as a floating point number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 @defun fround float
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 This function rounds @var{float} to the nearest integral value,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 and returns that value as a floating point number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 @node Bitwise Operations
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 @section Bitwise Operations on Integers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 In a computer, an integer is represented as a binary number, a
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 sequence of @dfn{bits} (digits which are either zero or one). A bitwise
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 operation acts on the individual bits of such a sequence. For example,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 @dfn{shifting} moves the whole sequence left or right one or more places,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 reproducing the same pattern ``moved over''.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 The bitwise operations in Emacs Lisp apply only to integers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 @defun lsh integer1 count
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 @cindex logical shift
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 @code{lsh}, which is an abbreviation for @dfn{logical shift}, shifts the
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
615 bits in @var{integer1} to the left @var{count} places, or to the right
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
616 if @var{count} is negative, bringing zeros into the vacated bits. If
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
617 @var{count} is negative, @code{lsh} shifts zeros into the leftmost
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
618 (most-significant) bit, producing a positive result even if
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
619 @var{integer1} is negative. Contrast this with @code{ash}, below.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
621 Here are two examples of @code{lsh}, shifting a pattern of bits one
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
622 place to the left. We show only the low-order eight bits of the binary
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
623 pattern; the rest are all zero.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 (lsh 5 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 @result{} 10
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 ;; @r{Decimal 5 becomes decimal 10.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 00000101 @result{} 00001010
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 (lsh 7 1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 @result{} 14
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 ;; @r{Decimal 7 becomes decimal 14.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 00000111 @result{} 00001110
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 As the examples illustrate, shifting the pattern of bits one place to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 the left produces a number that is twice the value of the previous
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
644 The function @code{lsh}, like all Emacs Lisp arithmetic functions, does
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
645 not check for overflow, so shifting left can discard significant bits
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
646 and change the sign of the number. For example, left shifting 8,388,607
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
647 produces @minus{}2 on a 24-bit machine:
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 (lsh 8388607 1) ; @r{left shift}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 @result{} -2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
654 In binary, in the 24-bit implementation, the argument looks like this:
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 ;; @r{Decimal 8,388,607}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 0111 1111 1111 1111 1111 1111
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 which becomes the following when left shifted:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 ;; @r{Decimal @minus{}2}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 1111 1111 1111 1111 1111 1110
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 Shifting the pattern of bits two places to the left produces results
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 like this (with 8-bit binary numbers):
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 (lsh 3 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 @result{} 12
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 ;; @r{Decimal 3 becomes decimal 12.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 00000011 @result{} 00001100
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 On the other hand, shifting the pattern of bits one place to the right
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 (lsh 6 -1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @result{} 3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 ;; @r{Decimal 6 becomes decimal 3.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 00000110 @result{} 00000011
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 (lsh 5 -1)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 @result{} 2
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 ;; @r{Decimal 5 becomes decimal 2.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 00000101 @result{} 00000010
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 As the example illustrates, shifting the pattern of bits one place to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 the right divides the value of the binary number by two, rounding downward.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 @defun ash integer1 count
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 @cindex arithmetic shift
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 @code{ash} (@dfn{arithmetic shift}) shifts the bits in @var{integer1}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 to the left @var{count} places, or to the right if @var{count}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 is negative.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 @code{ash} gives the same results as @code{lsh} except when
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716 @var{integer1} and @var{count} are both negative. In that case,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717 @code{ash} puts a one in the leftmost position, while @code{lsh} puts
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718 a zero in the leftmost position.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 Thus, with @code{ash}, shifting the pattern of bits one place to the right
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 (ash -6 -1) @result{} -3
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 ;; @r{Decimal @minus{}6 becomes decimal @minus{}3.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 1111 1111 1111 1111 1111 1010
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 @result{}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 1111 1111 1111 1111 1111 1101
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733 In contrast, shifting the pattern of bits one place to the right with
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 @code{lsh} looks like this:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738 (lsh -6 -1) @result{} 8388605
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739 ;; @r{Decimal @minus{}6 becomes decimal 8,388,605.}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 1111 1111 1111 1111 1111 1010
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 @result{}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 0111 1111 1111 1111 1111 1101
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 Here are other examples:
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748 @c !!! Check if lined up in smallbook format! XDVI shows problem
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 @c with smallbook but not with regular book! --rjc 16mar92
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 @smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 ; @r{ 24-bit binary values}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 (lsh 5 2) ; 5 = @r{0000 0000 0000 0000 0000 0101}
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
755 @result{} 20 ; = @r{0000 0000 0000 0000 0001 0100}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758 (ash 5 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
759 @result{} 20
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 (lsh -5 2) ; -5 = @r{1111 1111 1111 1111 1111 1011}
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
761 @result{} -20 ; = @r{1111 1111 1111 1111 1110 1100}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762 (ash -5 2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @result{} -20
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766 (lsh 5 -2) ; 5 = @r{0000 0000 0000 0000 0000 0101}
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
767 @result{} 1 ; = @r{0000 0000 0000 0000 0000 0001}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 (ash 5 -2)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
771 @result{} 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
772 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
773 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
774 (lsh -5 -2) ; -5 = @r{1111 1111 1111 1111 1111 1011}
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
775 @result{} 4194302 ; = @r{0011 1111 1111 1111 1111 1110}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
776 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
777 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
778 (ash -5 -2) ; -5 = @r{1111 1111 1111 1111 1111 1011}
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
779 @result{} -2 ; = @r{1111 1111 1111 1111 1111 1110}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
780 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
781 @end smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
782 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
784 @defun logand &rest ints-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
785 @cindex logical and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
786 @cindex bitwise and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787 This function returns the ``logical and'' of the arguments: the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788 @var{n}th bit is set in the result if, and only if, the @var{n}th bit is
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 set in all the arguments. (``Set'' means that the value of the bit is 1
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790 rather than 0.)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 For example, using 4-bit binary numbers, the ``logical and'' of 13 and
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793 12 is 12: 1101 combined with 1100 produces 1100.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794 In both the binary numbers, the leftmost two bits are set (i.e., they
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795 are 1's), so the leftmost two bits of the returned value are set.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796 However, for the rightmost two bits, each is zero in at least one of
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 the arguments, so the rightmost two bits of the returned value are 0's.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799 @noindent
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 Therefore,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
803 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 (logand 13 12)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805 @result{} 12
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 If @code{logand} is not passed any argument, it returns a value of
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 @minus{}1. This number is an identity element for @code{logand}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811 because its binary representation consists entirely of ones. If
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812 @code{logand} is passed just one argument, it returns that argument.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 @smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 ; @r{ 24-bit binary values}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 (logand 14 13) ; 14 = @r{0000 0000 0000 0000 0000 1110}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 ; 13 = @r{0000 0000 0000 0000 0000 1101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820 @result{} 12 ; 12 = @r{0000 0000 0000 0000 0000 1100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 (logand 14 13 4) ; 14 = @r{0000 0000 0000 0000 0000 1110}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 ; 13 = @r{0000 0000 0000 0000 0000 1101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826 ; 4 = @r{0000 0000 0000 0000 0000 0100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 @result{} 4 ; 4 = @r{0000 0000 0000 0000 0000 0100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 (logand)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 @result{} -1 ; -1 = @r{1111 1111 1111 1111 1111 1111}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 @end smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 @defun logior &rest ints-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 @cindex logical inclusive or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839 @cindex bitwise or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 This function returns the ``inclusive or'' of its arguments: the @var{n}th bit
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 is set in the result if, and only if, the @var{n}th bit is set in at least
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842 one of the arguments. If there are no arguments, the result is zero,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 which is an identity element for this operation. If @code{logior} is
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844 passed just one argument, it returns that argument.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 @smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 ; @r{ 24-bit binary values}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
850 (logior 12 5) ; 12 = @r{0000 0000 0000 0000 0000 1100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851 ; 5 = @r{0000 0000 0000 0000 0000 0101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @result{} 13 ; 13 = @r{0000 0000 0000 0000 0000 1101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856 (logior 12 5 7) ; 12 = @r{0000 0000 0000 0000 0000 1100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 ; 5 = @r{0000 0000 0000 0000 0000 0101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 ; 7 = @r{0000 0000 0000 0000 0000 0111}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 @result{} 15 ; 15 = @r{0000 0000 0000 0000 0000 1111}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 @end smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
863
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864 @defun logxor &rest ints-or-markers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865 @cindex bitwise exclusive or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866 @cindex logical exclusive or
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 This function returns the ``exclusive or'' of its arguments: the
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
868 @var{n}th bit is set in the result if, and only if, the @var{n}th bit is
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
869 set in an odd number of the arguments. If there are no arguments, the
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
870 result is 0, which is an identity element for this operation. If
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
871 @code{logxor} is passed just one argument, it returns that argument.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
872
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
873 @smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
874 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
875 ; @r{ 24-bit binary values}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
876
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
877 (logxor 12 5) ; 12 = @r{0000 0000 0000 0000 0000 1100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
878 ; 5 = @r{0000 0000 0000 0000 0000 0101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 @result{} 9 ; 9 = @r{0000 0000 0000 0000 0000 1001}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
881
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882 @group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 (logxor 12 5 7) ; 12 = @r{0000 0000 0000 0000 0000 1100}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 ; 5 = @r{0000 0000 0000 0000 0000 0101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 ; 7 = @r{0000 0000 0000 0000 0000 0111}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 @result{} 14 ; 14 = @r{0000 0000 0000 0000 0000 1110}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
887 @end group
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888 @end smallexample
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891 @defun lognot integer
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 @cindex logical not
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 @cindex bitwise not
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 This function returns the logical complement of its argument: the @var{n}th
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 bit is one in the result if, and only if, the @var{n}th bit is zero in
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 @var{integer}, and vice-versa.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898 @example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
899 (lognot 5)
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 @result{} -6
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 ;; 5 = @r{0000 0000 0000 0000 0000 0101}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 ;; @r{becomes}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 ;; -6 = @r{1111 1111 1111 1111 1111 1010}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 @end example
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907 @node Transcendental Functions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908 @section Transcendental Functions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909 @cindex transcendental functions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 @cindex mathematical functions
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912 These mathematical functions are available if floating point is
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913 supported. They allow integers as well as floating point numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914 as arguments.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 @defun sin arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 @defunx cos arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 @defunx tan arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 These are the ordinary trigonometric functions, with argument measured
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920 in radians.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 @defun asin arg
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
924 The value of @code{(asin @var{arg})} is a number between @minus{}pi/2
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
925 and pi/2 (inclusive) whose sine is @var{arg}; if, however, @var{arg}
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926 is out of range (outside [-1, 1]), then the result is a NaN.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 @defun acos arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930 The value of @code{(acos @var{arg})} is a number between 0 and pi
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931 (inclusive) whose cosine is @var{arg}; if, however, @var{arg}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
932 is out of range (outside [-1, 1]), then the result is a NaN.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
933 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 @defun atan arg
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
936 The value of @code{(atan @var{arg})} is a number between @minus{}pi/2
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
937 and pi/2 (exclusive) whose tangent is @var{arg}.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 @defun exp arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
941 This is the exponential function; it returns @i{e} to the power
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
942 @var{arg}. @i{e} is a fundamental mathematical constant also called the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
943 base of natural logarithms.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
945
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
946 @defun log arg &optional base
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
947 This function returns the logarithm of @var{arg}, with base @var{base}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
948 If you don't specify @var{base}, the base @var{e} is used. If @var{arg}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 is negative, the result is a NaN.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 @ignore
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953 @defun expm1 arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 This function returns @code{(1- (exp @var{arg}))}, but it is more
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955 accurate than that when @var{arg} is negative and @code{(exp @var{arg})}
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
956 is close to 1.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
957 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
958
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
959 @defun log1p arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
960 This function returns @code{(log (1+ @var{arg}))}, but it is more
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
961 accurate than that when @var{arg} is so small that adding 1 to it would
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
962 lose accuracy.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
963 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
964 @end ignore
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
965
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
966 @defun log10 arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967 This function returns the logarithm of @var{arg}, with base 10. If
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
968 @var{arg} is negative, the result is a NaN. @code{(log10 @var{x})}
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6510
diff changeset
969 @equiv{} @code{(log @var{x} 10)}, at least approximately.
6510
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
970 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
971
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
972 @defun expt x y
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
973 This function returns @var{x} raised to power @var{y}.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
975
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976 @defun sqrt arg
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 This returns the square root of @var{arg}. If @var{arg} is negative,
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
978 the value is a NaN.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979 @end defun
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
981 @node Random Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
982 @section Random Numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
983 @cindex random numbers
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
984
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
985 A deterministic computer program cannot generate true random numbers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
986 For most purposes, @dfn{pseudo-random numbers} suffice. A series of
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
987 pseudo-random numbers is generated in a deterministic fashion. The
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
988 numbers are not truly random, but they have certain properties that
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
989 mimic a random series. For example, all possible values occur equally
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
990 often in a pseudo-random series.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 In Emacs, pseudo-random numbers are generated from a ``seed'' number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
993 Starting from any given seed, the @code{random} function always
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
994 generates the same sequence of numbers. Emacs always starts with the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
995 same seed value, so the sequence of values of @code{random} is actually
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
996 the same in each Emacs run! For example, in one operating system, the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
997 first call to @code{(random)} after you start Emacs always returns
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
998 -1457731, and the second one always returns -7692030. This
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999 repeatability is helpful for debugging.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 If you want truly unpredictable random numbers, execute @code{(random
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 t)}. This chooses a new seed based on the current time of day and on
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1003 Emacs's process @sc{id} number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1004
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 @defun random &optional limit
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 This function returns a pseudo-random integer. Repeated calls return a
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 series of pseudo-random integers.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009 If @var{limit} is @code{nil}, then the value may in principle be any
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1010 integer. If @var{limit} is a positive integer, the value is chosen to
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1011 be nonnegative and less than @var{limit} (only in Emacs 19).
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1012
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1013 If @var{limit} is @code{t}, it means to choose a new seed based on the
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1014 current time of day and on Emacs's process @sc{id} number.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015 @c "Emacs'" is incorrect usage!
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1016
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1017 On some machines, any integer representable in Lisp may be the result
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1018 of @code{random}. On other machines, the result can never be larger
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1019 than a certain maximum or less than a certain (negative) minimum.
e18202af3602 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1020 @end defun