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