comparison lisp/cl-extra.el @ 4678:b5e1d4f6b66f

Make #'floor, #'ceiling, #'round, #'truncate conform to Common Lisp. lisp/ChangeLog addition: 2009-08-11 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (ceiling*, floor*, round*, truncate*): Implement these in terms of the C functions; mark them as obsolete. (mod*, rem*): Use #'nth-value with the C functions, not #'nth with the CL emulation functions. man/ChangeLog addition: 2009-08-11 Aidan Kehoe <kehoea@parhasard.net> * lispref/numbers.texi (Bigfloat Basics): Correct this documentation (ignoring for the moment that it breaks off in mid-sentence). tests/ChangeLog addition: 2009-08-11 Aidan Kehoe <kehoea@parhasard.net> * automated/lisp-tests.el: Test the new Common Lisp-compatible rounding functions available in C. (generate-rounding-output): Provide a function useful for generating the data for the rounding functions tests. src/ChangeLog addition: 2009-08-11 Aidan Kehoe <kehoea@parhasard.net> * floatfns.c (ROUNDING_CONVERT, CONVERT_WITH_NUMBER_TYPES) (CONVERT_WITHOUT_NUMBER_TYPES, MAYBE_TWO_ARGS_BIGNUM) (MAYBE_ONE_ARG_BIGNUM, MAYBE_TWO_ARGS_RATIO) (MAYBE_ONE_ARG_RATIO, MAYBE_TWO_ARGS_BIGFLOAT) (MAYBE_ONE_ARG_BIGFLOAT, MAYBE_EFF, MAYBE_CHAR_OR_MARKER): New macros, used in the implementation of the rounding functions. (ceiling_two_fixnum, ceiling_two_bignum, ceiling_two_ratio) (ceiling_two_bigfloat, ceiling_one_ratio, ceiling_one_bigfloat) (ceiling_two_float, ceiling_one_float, ceiling_one_mundane_arg) (floor_two_fixnum, floor_two_bignum, floor_two_ratio) (floor_two_bigfloat, floor_one_ratio, floor_one_bigfloat) (floor_two_float, floor_one_mundane_arg, round_two_fixnum) (round_two_bignum_1, round_two_bignum, round_two_ratio) (round_one_bigfloat_1, round_two_bigfloat, round_one_ratio) (round_one_bigfloat, round_two_float, round_one_float) (round_one_mundane_arg, truncate_two_fixnum) (truncate_two_bignum, truncate_two_ratio, truncate_two_bigfloat) (truncate_one_ratio, truncate_one_bigfloat, truncate_two_float) (truncate_one_float, truncate_one_mundane_arg): New functions, used in the implementation of the rounding functions. (Fceiling, Ffloor, Fround, Ftruncate, Ffceiling, Fffloor) (Ffround, Fftruncate): Revise to fully support Common Lisp conventions. This means: -- All functions have optional DIVISOR arguments -- All functions return multiple values; see #'values -- All functions do their arithmetic with the correct number types according to the contamination rules. -- #'round and #'fround always round towards the even number in ambiguous cases. * doprnt.c (emacs_doprnt_1): * number.c (internal_coerce_number): Call Ftruncate with two arguments, not one. * floatfns.c (Ffloat): Correct this, if NUMBER is a bignum. * lisp.h: Declare Ftruncate as taking two arguments. * number.c: Provide scratch_ratio2, init it appropriately. * number.h: Make scratch_ratio2 available. * number.h (BIGFLOAT_ARITH_RETURN): * number.h (BIGFLOAT_ARITH_RETURN1): Correct these functions.
author Aidan Kehoe <kehoea@parhasard.net>
date Tue, 11 Aug 2009 17:59:23 +0100
parents ecf1ebac70d8
children d0ea57eb3de4
comparison
equal deleted inserted replaced
4677:8f1ee2d15784 4678:b5e1d4f6b66f
392 (if (<= y 0) (if (= y 0) 1 (if (memq x '(-1 1)) (cl-expt x (- y)) 0)) 392 (if (<= y 0) (if (= y 0) 1 (if (memq x '(-1 1)) (cl-expt x (- y)) 0))
393 (* (if (= (% y 2) 0) 1 x) (cl-expt (* x x) (/ y 2))))) 393 (* (if (= (% y 2) 0) 1 x) (cl-expt (* x x) (/ y 2)))))
394 (or (and (fboundp 'expt) (subrp (symbol-function 'expt))) 394 (or (and (fboundp 'expt) (subrp (symbol-function 'expt)))
395 (defalias 'expt 'cl-expt)) 395 (defalias 'expt 'cl-expt))
396 396
397 (defun floor* (x &optional y) 397 ;; We can't use macrolet in this file; whence the literal macro
398 "Return a list of the floor of X and the fractional part of X. 398 ;; definition-and-call:
399 With two arguments, return floor and remainder of their quotient." 399 ((macro . (lambda (&rest symbols)
400 (let ((q (floor x y))) 400 "Make some old CL package truncate and round functions available.
401 (list q (- x (if y (* y q) q))))) 401
402 402 These functions are now implemented in C; their Lisp implementations in this
403 (defun ceiling* (x &optional y) 403 XEmacs are trivial, so we provide them and mark them obsolete."
404 "Return a list of the ceiling of X and the fractional part of X. 404 (let (symbol result)
405 With two arguments, return ceiling and remainder of their quotient." 405 (while symbols
406 (let ((res (floor* x y))) 406 (setq symbol (car symbols)
407 (if (= (car (cdr res)) 0) res 407 symbols (cdr symbols))
408 (list (1+ (car res)) (- (car (cdr res)) (or y 1)))))) 408 (push `(make-obsolete ',(intern (format "%s*" symbol))
409 409 ',symbol "21.5.29")
410 (defun truncate* (x &optional y) 410 result)
411 "Return a list of the integer part of X and the fractional part of X. 411 (push
412 With two arguments, return truncation and remainder of their quotient." 412 `(defun ,(intern (format "%s*" symbol)) (number &optional divisor)
413 (if (eq (>= x 0) (or (null y) (>= y 0))) 413 ,(format "See `%s'. This returns a list, not multiple values."
414 (floor* x y) (ceiling* x y))) 414 symbol)
415 415 (multiple-value-list (,symbol number divisor)))
416 (defun round* (x &optional y) 416 result))
417 "Return a list of X rounded to the nearest integer and the remainder. 417 (cons 'progn result))))
418 With two arguments, return rounding and remainder of their quotient." 418 ceiling floor round truncate)
419 (if y
420 (if (and (integerp x) (integerp y))
421 (let* ((hy (/ y 2))
422 (res (floor* (+ x hy) y)))
423 (if (and (= (car (cdr res)) 0)
424 (= (+ hy hy) y)
425 (/= (% (car res) 2) 0))
426 (list (1- (car res)) hy)
427 (list (car res) (- (car (cdr res)) hy))))
428 (let ((q (round (/ x y))))
429 (list q (- x (* q y)))))
430 (if (integerp x) (list x 0)
431 (let ((q (round x)))
432 (list q (- x q))))))
433 419
434 (defun mod* (x y) 420 (defun mod* (x y)
435 "The remainder of X divided by Y, with the same sign as Y." 421 "The remainder of X divided by Y, with the same sign as Y."
436 (nth 1 (floor* x y))) 422 (nth-value 1 (floor x y)))
437 423
438 (defun rem* (x y) 424 (defun rem* (x y)
439 "The remainder of X divided by Y, with the same sign as X." 425 "The remainder of X divided by Y, with the same sign as X."
440 (nth 1 (truncate* x y))) 426 (nth-value 1 (truncate x y)))
441 427
442 (defun signum (a) 428 (defun signum (a)
443 "Return 1 if A is positive, -1 if negative, 0 if zero." 429 "Return 1 if A is positive, -1 if negative, 0 if zero."
444 (cond ((> a 0) 1) ((< a 0) -1) (t 0))) 430 (cond ((> a 0) 1) ((< a 0) -1) (t 0)))
445
446 431
447 ;; Random numbers. 432 ;; Random numbers.
448 433
449 (defvar *random-state*) 434 (defvar *random-state*)
450 (defun random* (lim &optional state) 435 (defun random* (lim &optional state)