descriptive.mac: declare local variable to avoid possibility of name collision.

[maxima.git] / src / nummod.lisp

;; Maxima functions for floor, ceiling, and friends
;; Copyright (C) 2004, 2005, 2007 Barton Willis

;; Barton Willis
;; Department of Mathematics
;; University of Nebraska at Kearney
;; Kearney NE 68847
;; willisb@unk.edu

;; This source code is licensed under the terms of the Lisp Lesser
;; GNU Public License (LLGPL). The LLGPL consists of a preamble, published
;; by Franz Inc. (http://opensource.franz.com/preamble.html), and the GNU
;; Library General Public License (LGPL), version 2, or (at your option)
;; any later version.  When the preamble conflicts with the LGPL,
;; the preamble takes precedence.

;; This library is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; Library General Public License for details.

;; You should have received a copy of the GNU Library General Public
;; License along with this library; if not, write to the
;; Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
;; Boston, MA  02110-1301, USA.

(in-package :maxima)

(macsyma-module nummod)

;; Let's have version numbers 1,2,3,...

(eval-when (:load-toplevel :execute)
  ($put '$nummod 3 '$version)
  ;; Let's remove built-in symbols from list for user-defined properties.
  (setq $props (remove '$nummod $props)))

;; Ideally this should be removed in favor of ftake* (in mopers.lisp),
;; which is identical to what opcons used to do.  But some share files
;; use this, we need to keep this until those are fixed.
(defmacro opcons (op &rest args)
  `(ftake* ,op ,@args))

;; charfun(pred) evaluates to 1 when the predicate 'pred' evaluates
;; to true; it evaluates to 0 when 'pred' evaluates to false; otherwise,
;; it evaluates to a noun form.

(defprop $charfun simp-charfun operators)
(defprop %charfun simp-charfun operators)

(defun simp-charfun (e yy z)
  (declare (ignore yy))
  (oneargcheck e)
  (setq e (take '($is) (simplifya (specrepcheck (second e)) z)))
  (let* (($prederror nil)
         (bool (mevalp e)))
    (cond ((eq t bool) 1)
          ((eq nil bool) 0)
          ((op-equalp e '$is) `(($charfun simp) ,(second e)))
          (t `(($charfun simp) ,e)))))

(defun integer-part-of-sum (e)
  (let ((i-sum 0) (n-sum 0) (o-sum 0) (n))
    (setq e (margs e))
    (dolist (ei e)
      (cond ((maxima-integerp ei)
             (setq i-sum (add ei i-sum)))
            ((or (ratnump ei) (floatp ei) ($bfloatp ei))
             (setq n-sum (add ei n-sum)))
            (t
             (setq o-sum (add ei o-sum)))))
    (setq n (ftake* '$floor n-sum))
    (setq i-sum (add i-sum n))
    (setq o-sum (add o-sum (sub n-sum n)))
    (values i-sum o-sum)))

(defprop $floor simp-floor operators)

(defprop $floor tex-matchfix tex)
(defprop $floor (("\\left \\lfloor " ) " \\right \\rfloor") texsym)

;; $floor distributes over lists, matrices, and equations
(setf (get '$floor 'distribute_over) '(mlist $matrix mequal))

; These defprops for $entier are copied from orthopoly/orthopoly-init.lisp.

(defprop $entier tex-matchfix tex)
(defprop $entier (("\\lfloor ") " \\rfloor") texsym)

;; $entier and $fix distributes over lists, matrices, and equations
(setf (get '$entier 'distribute_over) '(mlist $matrix mequal))
(setf (get '$fix 'distribute_over) '(mlist $matrix mequal))

;; For an example, see pretty-good-floor-or-ceiling. Code courtesy of Stavros Macrakis.

(defmacro bind-fpprec (val &body exprs)
  `(let (fpprec bigfloatzero bigfloatone bfhalf bfmhalf)
     (let (($fpprec (fpprec1 nil ,val)))
       ,@exprs)))

;; Return true if the expression can be formed using rational numbers, logs, mplus, mexpt, or mtimes.

(defun use-radcan-p (e)
  (or ($ratnump e) (and (op-equalp e '%log 'mexpt 'mplus 'mtimes) (every 'use-radcan-p (cdr e)))))

;; When constantp(x) is true, we use bfloat evaluation to try to determine
;; the ceiling or floor. If numerical evaluation of e is ill-conditioned, this function
;; can misbehave.  I'm somewhat uncomfortable with this, but it is no worse
;; than some other stuff. One safeguard -- the evaluation is done with three
;; values for fpprec.  When the floating point evaluations are
;; inconsistent, bailout and return nil.  I hope that this function is
;; much more likely to return nil than it is to return a bogus value.

(defun pretty-good-floor-or-ceiling (x fn &optional digits)
  (let (($float2bf t) ($algebraic t) (f1) (f2) (f3) (eps) (lb) (ub) (n))

    (setq digits (if (and (integerp digits) (> 0 digits)) digits 25))
    (catch 'done

      ;; To handle ceiling(%i^%i), we need to apply rectform. If bfloat
      ;; is improved, it might be possible to remove this call to rectform.

      (setq x ($rectform x))
      (if (not ($freeof '$%i '$minf '$inf '$und '$infinity x)) (throw 'done nil))

      ;; When x doesn't evaluate to a bigfloat, bailout and return nil.
      ;; This happens when, for example, x = asin(2). For now, bfloatp
      ;; evaluates to nil for a complex big float. If this ever changes,
      ;; this code might need to be repaired.

      (bind-fpprec digits
        (setq f1 ($bfloat x))
        (if (not ($bfloatp f1)) (throw 'done nil)))

      (incf digits 20)
      (setq f2 (bind-fpprec digits ($bfloat x)))
      (if (not ($bfloatp f2)) (throw 'done nil))

      (incf digits 20)
      (bind-fpprec digits
        (setq f3 ($bfloat x))
        (if (not ($bfloatp f3)) (throw 'done nil))

        ;; Let's say that the true value of x is in the interval
        ;; [f3 - |f3| * eps, f3 + |f3| * eps], where eps = 10^(20 - digits).
        ;; Define n to be the number of integers in this interval; we have

        (setq eps (power ($bfloat 10) (- 20 digits)))
        (setq lb (sub f3 (mult (take '(mabs) f3) eps)))
        (setq ub (add f3 (mult (take '(mabs) f3) eps)))

        ;; If n > 1, we're going to give up. This is true iff ceiling(ub) -
        ;; ceiling(lb) > 1. However, we don't want to blindly try to calculate
        ;; that: if ub and lb are enormous, we probably won't have enough
        ;; precision in the bigfloats to calculate either ceiling. Start by
        ;; taking the difference: if it's at least 2, then we know that n >= 2.
        (when (fpgreaterp (cdr (sub ub lb)) (cdr ($bfloat 2)))
          (throw 'done nil))

        (setq n (sub (take '($ceiling) ub)
                     (take '($ceiling) lb))))

      (setq f1 (take (list fn) f1))
      (setq f2 (take (list fn) f2))
      (setq f3 (take (list fn) f3))

      ;; Provided f1 = f2 = f3 and n = 0, return f1.
      ;; If n = 1 and (use-radcan-p e) and ($radcan e) is a $ratnump, return
      ;; floor / ceiling of radcan(x).

      (cond ((and (= f1 f2 f3) (= n 0)) f1)
            ((and (=  f1 f2 f3) (= n 1) (use-radcan-p x))
             (setq x ($radcan x))
             (if ($ratnump x) (take (list fn) x) nil))
            (t nil)))))


;; (a) The function fpentier rounds a bigfloat towards zero--we need to
;;     check for that.

;; (b) Since limit(f(x))=(m)inf implies limit(floor(f(x)))=(m)inf,
;;     floor(inf/minf) = inf/minf.  Since minf<limit(f(x))<inf implies
;;     minf<limit(floor(f(x)))<inf, floor(ind)=ind

;;     I think floor(complex number) should be undefined too.  Some folks
;;     might like floor(a + %i b) --> floor(a) + %i floor(b). But
;;     this would violate the integer-valuedness of floor.
;;     So floor(infinity) remains unsimplified

(defun simp-floor (e e1 z)
  (oneargcheck e)
  (setq e (simplifya (specrepcheck (nth 1 e)) z))

  (cond ((numberp e) (floor e))

        ((ratnump e) (floor (cadr e) (caddr e)))

        (($bfloatp e)
         (setq e1 (fpentier e))
         (if (and (minusp (cadr e)) (not (zerop1 (sub e1 e))))
             (1- e1)
             e1))

        ((maxima-integerp e) e)

        (($orderlessp e (neg e))
         (sub 0 (ftake* '$ceiling (neg e))))

        ((and (setq e1 (mget e '$numer)) (floor e1)))

        ((member e '($inf $minf $ind $und)) e)
        ;; leave floor(infinity) as is
        ((or (eq e '$zerob)) -1)
        ((or (eq e '$zeroa)) 0)

        ((and ($constantp e) (pretty-good-floor-or-ceiling e '$floor)))

        ((mplusp e)
         (let ((i-sum) (o-sum))
           (multiple-value-setq (i-sum o-sum) (integer-part-of-sum e))
           (setq o-sum (if (equal i-sum 0) `(($floor simp) ,o-sum)
                         (ftake* '$floor o-sum)))
           (add i-sum o-sum)))

        ;; handle 0 <= e < 1 implies floor(e) = 0 and
        ;; -1 <= e < 0 implies floor(e) = -1.

        ((and (member ($compare 0 e) '("<" "<=") :test #'equal)
              (equal ($compare e 1) "<"))
         0)
        ((and (member ($compare -1 e) '("<" "<=") :test #'equal)
              (equal ($compare e 0) "<"))
         -1)
        (t `(($floor simp) ,e))))

(defun floor-integral (x)
  (let ((f (take '($floor) x)))
    (mul f (div 1 2) (add (mul 2 x) -1 (neg f)))))

(defun ceiling-integral (x)
  (let ((f (take '($ceiling) x)))
    (mul f (div 1 2) (add 1 (mul 2 x) (neg f)))))

(putprop '$floor `((x) ,'floor-integral) 'integral)
(putprop '$ceiling `((x) ,'ceiling-integral) 'integral)

(defprop $ceiling simp-ceiling operators)

(defprop $floor simplim%floor simplim%function)

(defun simplim%floor (expr var val)
  (let* ((arg (cadr expr))
         (b (behavior arg var val))
         (arglimab (limit arg var val 'think)) ; with $zeroa $zerob
         (arglim (ridofab arglimab)))
    (cond ((and (= b -1)
                (maxima-integerp arglim))
           (m- arglim 1))
          ((and (= b 1)
                (maxima-integerp arglim))
           arglim)
          ((and ($constantp arglim)
                (not (maxima-integerp arglim)))
           (simplify (list '($floor) arglim)))
          (t
           (throw 'limit nil)))))

(defprop $ceiling tex-matchfix tex)
(defprop $ceiling (("\\left \\lceil " ) " \\right \\rceil") texsym)

;; $ceiling distributes over lists, matrices, and equations.
(setf (get '$ceiling 'distribute_over) '(mlist $matrix mequal))

(defun simp-ceiling (e e1 z)
  (oneargcheck e)
  (setq e (simplifya (specrepcheck (nth 1 e)) z))
  (cond ((numberp e) (ceiling e))

        ((ratnump e) (ceiling (cadr e) (caddr e)))

        (($bfloatp e)
         (sub 0 (ftake* '$floor (sub 0 e))))

        ((maxima-integerp e) e)

        (($orderlessp e (neg e))
         (sub* 0 (ftake* '$floor (neg e))))

        ((and (setq e1 (mget e '$numer)) (ceiling e1)))

        ((member e '($inf $minf $ind $und)) e)
        ;; leave ceiling(infinity) as is
        ((or (eq e '$zerob)) 0)
        ((or (eq e '$zeroa)) 1)

        ((and ($constantp e) (pretty-good-floor-or-ceiling e '$ceiling)))

        ((mplusp e)
         (let ((i-sum) (o-sum))
           (multiple-value-setq (i-sum o-sum) (integer-part-of-sum e))
           (setq o-sum (if (equal i-sum 0) `(($ceiling simp) ,o-sum)
                         (ftake* '$ceiling o-sum)))
           (add i-sum o-sum)))

        ;; handle 0 < e <= 1 implies ceiling(e) = 1 and
        ;; -1 < e <= 0 implies ceiling(e) = 0.

        ((and (equal ($compare 0 e) "<")
              (member ($compare e 1) '("<" "<=") :test #'equal))
         1)
        ((and (equal ($compare -1 e) "<")
              (member ($compare e 0) '("<" "<=") :test #'equal))
         0)
        (t `(($ceiling simp) ,e))))

(defprop $ceiling simplim%ceiling simplim%function)

(defun simplim%ceiling (expr var val)
  (let* ((arg (cadr expr))
         (b (behavior arg var val))
         (arglimab (limit arg var val 'think)) ; with $zeroa $zerob
         (arglim (ridofab arglimab)))
    (cond ((and (= b -1)
                (maxima-integerp arglim))
           arglim)
          ((and (= b 1)
                (maxima-integerp arglim))
           (m+ arglim 1))
          ((and ($constantp arglim)
                (not (maxima-integerp arglim)))
           (simplify (list '($ceiling) arglim)))
          (t
           (throw 'limit nil)))))


(defprop $mod simp-nummod operators)
(defprop $mod tex-infix tex)
(defprop $mod (" \\rm{mod} ") texsym)
(defprop $mod 180. tex-lbp)
(defprop $mod 180. tex-rbp)

;; $mod distributes over lists, matrices, and equations
(setf (get '$mod 'distribute_over) '(mlist $matrix mequal))

;; See "Concrete Mathematics," Section 3.21.

(defun simp-nummod (e e1 z)
  (twoargcheck e)
  (let ((x (simplifya (specrepcheck (cadr e)) z))
        (y (simplifya (specrepcheck (caddr e)) z)))
    (cond ((or (equal 0 y) (equal 0 x)) x)
          ((equal 1 y) (sub x (ftake* '$floor x)))
          ((and ($constantp x) ($constantp y))
           (sub x (mul y (ftake* '$floor (div x y)))))
          ((not (equal 1 (setq e1 ($gcd x y))))
           (mul e1 (ftake* '$mod (div x e1) (div y e1))))
          (t `(($mod simp) ,x ,y)))))

;; The function 'round' rounds a number to the nearest integer. For a tie, round to the
;; nearest even integer.

;; This property is important to get round(round(x)) => round(x).
(setf (get '%round 'integer-valued) t)
(setf (get '%round 'reflection-rule) 'odd-function-reflect)
;; round distributes over lists, matrices, and equations.
(setf (get '%round 'distribute_over) '(mlist $matrix mequal))

(def-simplifier round (e)
  (cond (($featurep e '$integer)
         ;; takes care of round(round(x)) --> round(x).
         e)
        ((member e '($inf $minf $und $ind) :test #'eq)
         e)
        ((eq e '$zerob)
         0)
        ((eq e '$zeroa)
         0)
        (t
         (let* ((lb (take '($floor) e))
                (ub (take '($ceiling) e))
                (sgn (csign (sub (sub ub e) (sub e lb)))))
           (cond ((eq sgn t)
                  (give-up))
                 ((eq sgn '$neg)
                  ub)
                 ((eq sgn '$pos)
                  lb)
                 ((alike lb ub)
                  ;; For floats that are integers, this can
                  ;; happen. Maybe featurep should catch this.
                  lb)
                 ((and (eq sgn '$zero)
                       ($featurep lb '$even))
                  lb)
                 ((and (eq sgn '$zero)
                       ($featurep ub '$even))
                  ub)
                 ((apply-reflection-simp (mop form) e t))
                 (t (give-up)))))))

(defprop %round simplim%round simplim%function)

(defun simplim%round (expr var val)
  (let* ((arg (cadr expr))
         (b (behavior arg var val))
         (arglimab (limit arg var val 'think)) ; with $zeroa $zerob
         (arglim (ridofab arglimab)))
    (cond ((and (= b -1)
                (maxima-integerp (m+ 1//2 arglim)))
           (m- arglim 1//2))
          ((and (= b 1)
                (maxima-integerp (m+ 1//2 arglim)))
           (m+ arglim 1//2))
          ((and ($constantp arglim)
                (not (maxima-integerp (m+ 1//2 arglim))))
           (simplify (list '(%round) arglim)))
          (t
           (throw 'limit nil)))))

;; Round a number towards zero.


;; This property is important to get truncate(truncate(x)) =>
;; truncate(x).
(setf (get '%truncate 'integer-valued) t)
(setf (get '%truncate 'reflection-rule) 'odd-function-reflect)

;; truncate distributes over lists, matrices, and equations.
(setf (get '%truncate 'distribute_over) '(mlist $matrix mequal))

(def-simplifier truncate (e)
  (cond (($featurep e '$integer)
         ;; takes care of truncate(truncate(x)) --> truncate(x).
         e)
        ((member e '($inf $minf $und $ind) :test #'eq)
         e)
        ((eq e '$zerob)
         0)
        ((eq e '$zeroa)
         0)
        (t
         (let ((sgn (csign e)))
           (cond ((member sgn '($neg $nz) :test #'eq)
                  (take '($ceiling) e))
                 ((member sgn '($zero $pz $pos) :test #'eq)
                  (take '($floor) e))
                 ((apply-reflection-simp (mop form) e t))
                 (t (give-up)))))))

;;; integration for signum, unit_step, and mod.

;; integrate(signum(x),x) = |x|
(defun signum-integral (x)
                 (take '(mabs) x))

;; integrate(unit_step(x),x) = (x + |x|)/2
(defun unit-step-integral (x)
                (div (add x (take '(mabs) x)) 2))

;; We have mod(x,a) = x-a*floor(x/a). This gives
;;   integrate(mod(x,a),x) = (a^2 floor(x/a)^2 + (a^2 - 2 a x) floor(x/a) + x^2)/2
;; In terms of mod(x,a), an antiderivative is
;;   integrate(mod(x,a),x) = (mod(x,a)^2-a*mod(x,a)+a*x)/2
;; Before this function is called, Maxima checks if a explicitly depends on x. So
;; this function doesn't need to do that check.
(defun mod-integral (x a)
                (let ((q (take '($mod) x a)))
                   (div (add (mul q q) (mul -1 a q) (mul a x)) 2)))

(putprop '%signum (list (list 'x) 'signum-integral) 'integral)
(putprop '$unit_step (list (list 'x) 'unit-step-integral) 'integral)

;; integrate(mod(x,a),a) doesn't have representation in terms of functions
;; known to Maxima, I think. (Barton Willis, 2020).
(putprop '$mod (list (list 'x 'y) 'mod-integral nil) 'integral)