code.delx.au - gnu-emacs/blob - lisp/calc/calc-stuff.el

   1 ;;; calc-stuff.el --- miscellaneous functions for Calc
   2
   3 ;; Copyright (C) 1990, 1991, 1992, 1993, 2001, 2005 Free Software Foundation, Inc.
   4
   5 ;; Author: David Gillespie <daveg@synaptics.com>
   6 ;; Maintainer: Jay Belanger <belanger@truman.edu>
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is distributed in the hope that it will be useful,
  11 ;; but WITHOUT ANY WARRANTY.  No author or distributor
  12 ;; accepts responsibility to anyone for the consequences of using it
  13 ;; or for whether it serves any particular purpose or works at all,
  14 ;; unless he says so in writing.  Refer to the GNU Emacs General Public
  15 ;; License for full details.
  16
  17 ;; Everyone is granted permission to copy, modify and redistribute
  18 ;; GNU Emacs, but only under the conditions described in the
  19 ;; GNU Emacs General Public License.   A copy of this license is
  20 ;; supposed to have been given to you along with GNU Emacs so you
  21 ;; can know your rights and responsibilities.  It should be in a
  22 ;; file named COPYING.  Among other things, the copyright notice
  23 ;; and this notice must be preserved on all copies.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 ;; This file is autoloaded from calc-ext.el.
  30
  31 (require 'calc-ext)
  32 (require 'calc-macs)
  33
  34 (defun calc-num-prefix (n)
  35   "Use the number at the top of stack as the numeric prefix for the next command.
  36 With a prefix, push that prefix as a number onto the stack."
  37   (interactive "P")
  38   (calc-wrapper
  39    (if n
  40        (calc-enter-result 0 "" (prefix-numeric-value n))
  41      (let ((num (calc-top 1)))
  42        (if (math-messy-integerp num)
  43            (setq num (math-trunc num)))
  44        (or (integerp num)
  45            (error "Argument must be a small integer"))
  46        (calc-pop-stack 1)
  47        (setq prefix-arg num)
  48        (message "%d-" num)))))    ; a (lame) simulation of the real thing...
  49
  50
  51 (defun calc-more-recursion-depth (n)
  52   (interactive "P")
  53   (calc-wrapper
  54    (if (calc-is-inverse)
  55        (calc-less-recursion-depth n)
  56      (let ((n (if n (prefix-numeric-value n) 2)))
  57        (if (> n 1)
  58            (setq max-specpdl-size (* max-specpdl-size n)
  59                  max-lisp-eval-depth (* max-lisp-eval-depth n))))
  60      (message "max-lisp-eval-depth is now %d" max-lisp-eval-depth))))
  61
  62 (defun calc-less-recursion-depth (n)
  63   (interactive "P")
  64   (let ((n (if n (prefix-numeric-value n) 2)))
  65     (if (> n 1)
  66         (setq max-specpdl-size
  67               (max (/ max-specpdl-size n) 600)
  68               max-lisp-eval-depth
  69               (max (/ max-lisp-eval-depth n) 200))))
  70   (message "max-lisp-eval-depth is now %d" max-lisp-eval-depth))
  71
  72
  73 (defvar calc-which-why nil)
  74 (defvar calc-last-why-command nil)
  75 (defun calc-explain-why (why &optional more)
  76   (if (eq (car why) '*)
  77       (setq why (cdr why)))
  78   (let* ((pred (car why))
  79          (arg (nth 1 why))
  80          (msg (cond ((not pred) "Wrong type of argument")
  81                     ((stringp pred) pred)
  82                     ((eq pred 'integerp) "Integer expected")
  83                     ((eq pred 'natnump)
  84                      (if (and arg (Math-objvecp arg) (not (Math-integerp arg)))
  85                          "Integer expected"
  86                        "Nonnegative integer expected"))
  87                     ((eq pred 'posintp)
  88                      (if (and arg (Math-objvecp arg) (not (Math-integerp arg)))
  89                          "Integer expected"
  90                        "Positive integer expected"))
  91                     ((eq pred 'fixnump)
  92                      (if (and arg (Math-integerp arg))
  93                          "Small integer expected"
  94                        "Integer expected"))
  95                     ((eq pred 'fixnatnump)
  96                      (if (and arg (Math-natnump arg))
  97                          "Small integer expected"
  98                        (if (and arg (Math-objvecp arg)
  99                                 (not (Math-integerp arg)))
 100                            "Integer expected"
 101                          "Nonnegative integer expected")))
 102                     ((eq pred 'fixposintp)
 103                      (if (and arg (Math-integerp arg) (Math-posp arg))
 104                          "Small integer expected"
 105                        (if (and arg (Math-objvecp arg)
 106                                 (not (Math-integerp arg)))
 107                            "Integer expected"
 108                          "Positive integer expected")))
 109                     ((eq pred 'posp) "Positive number expected")
 110                     ((eq pred 'negp) "Negative number expected")
 111                     ((eq pred 'nonzerop) "Nonzero number expected")
 112                     ((eq pred 'realp) "Real number expected")
 113                     ((eq pred 'anglep) "Real number expected")
 114                     ((eq pred 'hmsp) "HMS form expected")
 115                     ((eq pred 'datep)
 116                      (if (and arg (Math-objectp arg)
 117                               (not (Math-realp arg)))
 118                          "Real number or date form expected"
 119                        "Date form expected"))
 120                     ((eq pred 'numberp) "Number expected")
 121                     ((eq pred 'scalarp) "Number expected")
 122                     ((eq pred 'vectorp) "Vector or matrix expected")
 123                     ((eq pred 'numvecp) "Number or vector expected")
 124                     ((eq pred 'matrixp) "Matrix expected")
 125                     ((eq pred 'square-matrixp)
 126                      (if (and arg (math-matrixp arg))
 127                          "Square matrix expected"
 128                        "Matrix expected"))
 129                     ((eq pred 'objectp) "Number expected")
 130                     ((eq pred 'constp) "Constant expected")
 131                     ((eq pred 'range) "Argument out of range")
 132                     (t (format "%s expected" pred))))
 133          (punc ": ")
 134          (calc-can-abbrev-vectors t))
 135     (while (setq why (cdr why))
 136       (and (car why)
 137            (setq msg (concat msg punc (if (stringp (car why))
 138                                           (car why)
 139                                         (math-format-flat-expr (car why) 0)))
 140                  punc ", ")))
 141     (message "%s%s" msg (if more "  [w=more]" ""))))
 142
 143 (defun calc-why ()
 144   (interactive)
 145   (if (not (eq this-command last-command))
 146       (if (eq last-command calc-last-why-command)
 147           (setq calc-which-why (cdr calc-why))
 148         (setq calc-which-why calc-why)))
 149   (if calc-which-why
 150       (progn
 151         (calc-explain-why (car calc-which-why) (cdr calc-which-why))
 152         (setq calc-which-why (cdr calc-which-why)))
 153     (if calc-why
 154         (progn
 155           (message "(No further explanations available)")
 156           (setq calc-which-why calc-why))
 157       (message "No explanations available"))))
 158
 159
 160 (defun calc-version ()
 161   (interactive)
 162   (message "Calc %s" calc-version))
 163
 164 ;; The following caches are declared in other files, but are
 165 ;; reset here.
 166 (defvar math-lud-cache) ; calc-mtx.el
 167 (defvar math-log2-cache) ; calc-bin.el
 168 (defvar math-radix-digits-cache) ; calc-bin.el
 169 (defvar math-radix-float-cache-tag) ; calc-bin.el
 170 (defvar math-random-cache) ; calc-comb.el
 171 (defvar math-max-digits-cache) ; calc-bin.el
 172 (defvar math-integral-cache) ; calcalg2.el
 173 (defvar math-units-table) ; calc-units.el
 174 (defvar math-decls-cache-tag) ; calc-arith.el
 175 (defvar math-format-date-cache) ; calc-forms.el
 176 (defvar math-holidays-cache-tag) ; calc-forms.el
 177
 178 (defun calc-flush-caches (&optional inhibit-msg)
 179   (interactive "P")
 180   (calc-wrapper
 181    (setq math-lud-cache nil
 182          math-log2-cache nil
 183          math-radix-digits-cache nil
 184          math-radix-float-cache-tag nil
 185          math-random-cache nil
 186          math-max-digits-cache nil
 187          math-integral-cache nil
 188          math-units-table nil
 189          math-decls-cache-tag nil
 190          math-eval-rules-cache-tag t
 191          math-format-date-cache nil
 192          math-holidays-cache-tag t)
 193    (mapcar (function (lambda (x) (set x -100))) math-cache-list)
 194    (unless inhibit-msg
 195      (message "All internal calculator caches have been reset"))))
 196
 197
 198 ;;; Conversions.
 199
 200 (defun calc-clean (n)
 201   (interactive "P")
 202   (calc-slow-wrapper
 203    (calc-with-default-simplification
 204     (let ((func (if (calc-is-hyperbolic) 'calcFunc-clean 'calcFunc-pclean)))
 205       (calc-enter-result 1 "cln"
 206                          (if n
 207                              (let ((n (prefix-numeric-value n)))
 208                                (list func
 209                                      (calc-top-n 1)
 210                                      (if (<= n 0)
 211                                          (+ n calc-internal-prec)
 212                                        n)))
 213                            (list func (calc-top-n 1))))))))
 214
 215 (defun calc-clean-num (num)
 216   (interactive "P")
 217   (calc-clean (- (if num
 218                      (prefix-numeric-value num)
 219                    (if (and (>= last-command-char ?0)
 220                             (<= last-command-char ?9))
 221                        (- last-command-char ?0)
 222                      (error "Number required"))))))
 223
 224
 225 (defvar math-chopping-small nil)
 226 (defun calcFunc-clean (a &optional prec)   ; [X X S] [Public]
 227   (if prec
 228       (cond ((Math-messy-integerp prec)
 229              (calcFunc-clean a (math-trunc prec)))
 230             ((or (not (integerp prec))
 231                  (< prec 3))
 232              (calc-record-why "*Precision must be an integer 3 or above")
 233              (list 'calcFunc-clean a prec))
 234             ((not (Math-objvecp a))
 235              (list 'calcFunc-clean a prec))
 236             (t (let ((calc-internal-prec prec)
 237                      (math-chopping-small t))
 238                  (calcFunc-clean (math-normalize a)))))
 239     (cond ((eq (car-safe a) 'polar)
 240            (let ((theta (math-mod (nth 2 a)
 241                                   (if (eq calc-angle-mode 'rad)
 242                                       (math-two-pi)
 243                                     360))))
 244              (math-neg
 245               (math-neg
 246                (math-normalize
 247                 (list 'polar
 248                       (calcFunc-clean (nth 1 a))
 249                       (calcFunc-clean theta)))))))
 250           ((memq (car-safe a) '(vec date hms))
 251            (cons (car a) (mapcar 'calcFunc-clean (cdr a))))
 252           ((memq (car-safe a) '(cplx mod sdev intv))
 253            (math-normalize (cons (car a) (mapcar 'calcFunc-clean (cdr a)))))
 254           ((eq (car-safe a) 'float)
 255            (if math-chopping-small
 256                (if (or (> (nth 2 a) (- calc-internal-prec))
 257                        (Math-lessp (- calc-internal-prec) (calcFunc-xpon a)))
 258                    (if (and (math-num-integerp a)
 259                             (math-lessp (calcFunc-xpon a) calc-internal-prec))
 260                        (math-trunc a)
 261                      a)
 262                  0)
 263              a))
 264           ((Math-objectp a) a)
 265           ((math-infinitep a) a)
 266           (t (list 'calcFunc-clean a)))))
 267
 268 (defun calcFunc-pclean (a &optional prec)
 269   (math-map-over-constants (function (lambda (x) (calcFunc-clean x prec)))
 270                            a))
 271
 272 (defun calcFunc-pfloat (a)
 273   (math-map-over-constants 'math-float a))
 274
 275 (defun calcFunc-pfrac (a &optional tol)
 276   (math-map-over-constants (function (lambda (x) (calcFunc-frac x tol)))
 277                            a))
 278
 279 ;; The variable math-moc-func is local to math-map-over-constants,
 280 ;; but is used by math-map-over-constants-rec, which is called by
 281 ;; math-map-over-constants.
 282 (defvar math-moc-func)
 283
 284 (defun math-map-over-constants (math-moc-func expr)
 285   (math-map-over-constants-rec expr))
 286
 287 (defun math-map-over-constants-rec (expr)
 288   (cond ((or (Math-primp expr)
 289              (memq (car expr) '(intv sdev)))
 290          (or (and (Math-objectp expr)
 291                   (funcall math-moc-func expr))
 292              expr))
 293         ((and (memq (car expr) '(^ calcFunc-subscr))
 294               (eq math-moc-func 'math-float)
 295               (= (length expr) 3)
 296               (Math-integerp (nth 2 expr)))
 297          (list (car expr)
 298                (math-map-over-constants-rec (nth 1 expr))
 299                (nth 2 expr)))
 300         (t (cons (car expr) (mapcar 'math-map-over-constants-rec (cdr expr))))))
 301
 302 (provide 'calc-stuff)
 303
 304 ;;; arch-tag: 789332ef-a178-49d3-8fb7-5d7ed7e21f56
 305 ;;; calc-stuff.el ends here