source: trunk/source/level-0/l0-bignum64.lisp @ 8405

Last change on this file since 8405 was 8405, checked in by gb, 12 years ago

Slightly better bignum * fixnum multiply.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 75.5 KB
Line 
1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17(in-package "CCL")
18
19#+64-bit-target
20(eval-when (:compile-toplevel :execute)
21  (require "ARCH")
22  (require "NUMBER-MACROS")
23  (require "NUMBER-CASE-MACRO")
24
25  (defsetf bignum-ref bignum-set)
26 
27  (defconstant digit-size 32)
28  (defconstant half-digit-size (/ digit-size 2))
29 
30  (defconstant maximum-bignum-length (1- (ash 1 56)))
31  (defconstant all-ones-digit #xffffffff)
32  (deftype bignum-index () `(integer 0 (,maximum-bignum-length)))
33  (deftype bignum-element-type () `(unsigned-byte ,digit-size))
34  (deftype bignum-half-element-type () `(unsigned-byte ,half-digit-size))
35  (deftype bignum-type () 'bignum)
36  (defmacro %normalize-bignum-macro (big)
37    `(%normalize-bignum-2 t ,big))
38
39  (defmacro %mostly-normalize-bignum-macro (big)
40    `(%normalize-bignum-2 nil ,big))
41  (defmacro %lognot (x)
42    `(logand #xffffffff (lognot (the fixnum ,x))))
43  (defmacro %logior (x y)
44    `(logior (the fixnum ,x) (the fixnum ,y)))
45  (defmacro %logxor (x y)
46    `(logand #xffffffff (logxor (the fixnum ,x) (the fixnum ,y))))
47 
48  ;;; BIGNUM-REPLACE -- Internal.
49  ;;;
50  (defmacro bignum-replace (dest src &key (start1 '0) end1 (start2 '0) end2
51                                 from-end)
52    (once-only ((n-dest dest)
53                (n-src src))
54               (if (and (eq start1 0)(eq start2 0)(null end1)(null end2)(null from-end))
55                 ;; this is all true for some uses today <<
56                 `(%copy-ivector-to-ivector ,n-src 0 ,n-dest 0 (%ilsl 2 (min (the fixnum (%bignum-length ,n-src))
57                                                                         (the fixnum (%bignum-length ,n-dest)))))
58                 (let* ((n-start1 (gensym))
59                        (n-end1 (gensym))
60                        (n-start2 (gensym))
61                        (n-end2 (gensym)))
62                   `(let ((,n-start1 ,start1)
63                          (,n-start2 ,start2)
64                          (,n-end1 ,(or end1 `(%bignum-length ,n-dest)))
65                          (,n-end2 ,(or end2 `(%bignum-length ,n-src))))
66                     ,(if (null from-end)           
67                          `(%copy-ivector-to-ivector
68                            ,n-src (%i* 4 ,n-start2) 
69                            ,n-dest (%i* 4 ,n-start1)
70                            (%i* 4 (min (%i- ,n-end2 ,n-start2) 
71                                    (%i- ,n-end1 ,n-start1))))
72                          `(let ((nwds (min (%i- ,n-end2 ,n-start2)
73                                            (%i- ,n-end1 ,n-start1))))
74                            (%copy-ivector-to-ivector
75                             ,n-src (%ilsl 2 (%i- ,n-end2 nwds))
76                             ,n-dest (%ilsl 2 (%i- ,n-end1 nwds))
77                             (%i* 4 nwds))))))))) 
78 
79
80  ;;;; Shifting.
81 
82  (defconstant all-ones-half-digit #xFFFF) 
83 
84
85;;; %ALLOCATE-BIGNUM must zero all elements.
86;;;
87  (defmacro %allocate-bignum (ndigits)
88    `(%alloc-misc ,ndigits target::subtag-bignum))
89
90  (declaim (inline  %bignum-length))
91
92;;; This macro is used by BIGNUM-ASHIFT-RIGHT,
93;;; BIGNUM-BUFFER-ASHIFT-RIGHT, and BIGNUM-LDB-BIGNUM-RES. They supply
94;;; a termination form that references locals established by this
95;;; form. Source is the source bignum. Start-digit is the first digit
96;;; in source from which we pull bits. Start-pos is the first bit we
97;;; want. Res-len-form is the form that computes the length of the
98;;; resulting bignum. Termination is a DO termination form with a test
99;;; and body. When result is supplied, it is the variable to which
100;;; this binds a newly allocated bignum.
101;;;
102;;; Given start-pos, 1-31 inclusively, of shift, we form the j'th resulting
103;;; digit from high bits of the i'th source digit and the start-pos number of
104;;; bits from the i+1'th source digit.
105  (defmacro shift-right-unaligned (source
106                                   start-digit
107                                   start-pos
108                                   res-len-form
109                                   termination
110                                   &optional result)
111    `(let* ((high-bits-in-first-digit (- digit-size ,start-pos))
112            (res-len ,res-len-form)
113            (res-len-1 (1- res-len))
114            ,@(if result `((,result (%allocate-bignum res-len)))))
115      (declare (type bignum-index res-len res-len-1))
116      (do ((i ,start-digit i+1)
117           (i+1 (1+ ,start-digit) (1+ i+1))
118           (j 0 (1+ j)))
119          ,termination
120        (declare (type bignum-index i i+1 j))
121        (setf (bignum-ref ,(if result result source) j)
122              (%logior (%digit-logical-shift-right (bignum-ref ,source i)
123                                                   ,start-pos)
124                       (%ashl (bignum-ref ,source i+1)
125                              high-bits-in-first-digit))))))
126
127
128  )
129
130
131#+64-bit-target
132(progn
133
134;;; Extract the length of the bignum.
135;;;
136(defun %bignum-length (bignum)
137  (uvsize bignum)) 
138
139
140
141;;; We can probably do better than UVREF here, but
142;;; a) it's not -that- bad
143;;; b) it does some bounds/sanity checking, which isn't a bad idea.
144(eval-when (:compile-toplevel :execute)
145  (declaim (inline bignum-ref bignum-set)))
146
147(defun bignum-ref (b i)
148  (%typed-miscref :bignum b i))
149
150(defun bignum-set (b i val)
151  (declare (fixnum val))
152  (%typed-miscset :bignum b i (logand val all-ones-digit)))
153
154
155(defun bignum-plusp (b)
156  (not (logbitp (1- digit-size) (the bignum-element-type (bignum-ref b (1- (%bignum-length b)))))))
157
158;;; Return T if digit is positive, or NIL if negative.
159(defun %digit-0-or-plusp (digit)
160  (declare (type bignum-element-type digit))
161  (not (logbitp (1- digit-size) digit)))
162
163(defun %bignum-0-or-plusp (bignum len)
164  (declare (type bignum-type bignum)
165           (type bignum-index len))
166  (%digit-0-or-plusp (bignum-ref bignum (1- len))))
167
168(defun bignum-minusp (b)
169  (logbitp 31 (the fixnum (bignum-ref b (1- (%bignum-length b))))))
170
171(defun %sign-digit (b i)
172  (%ashr (bignum-ref b (1- i)) (1- digit-size)))
173
174;;; Return the sign of bignum (0 or -1) as a fixnum
175(defun %bignum-sign (b)
176  (if (logbitp 31 (the fixnum (bignum-ref b (1- (%bignum-length b)))))
177    -1
178    0))
179
180(defun %add-with-carry (a-digit b-digit carry-in)
181  (declare (fixnum a-digit b-digit carry-in))
182  (setq a-digit (logand all-ones-digit a-digit)
183        b-digit (logand all-ones-digit b-digit))
184  (let* ((sum (+ carry-in (the fixnum (+ a-digit b-digit)))))
185    (declare (fixnum sum))
186    (values (logand all-ones-digit sum) (logand 1 (ash sum -32)))))
187
188(defun %subtract-with-borrow (a-digit b-digit borrow-in)
189  (declare (fixnum a-digit b-digit borrow-in))
190  (setq a-digit (logand all-ones-digit a-digit)
191        b-digit (logand all-ones-digit b-digit))
192  (let* ((diff (- (the fixnum (- a-digit b-digit))
193                  (the fixnum (- 1 borrow-in)))))
194    (declare (fixnum diff))
195    (values (logand all-ones-digit diff)
196            (- 1 (logand (the fixnum (ash diff -32)) 1)))))
197
198
199
200(defun %compare-digits (bignum-a bignum-b idx)
201  (let* ((a (bignum-ref bignum-a idx))
202         (b (bignum-ref bignum-b idx)))
203    (declare (fixnum a b))
204    (if (= a b)
205      0
206      (if (> a b)
207        1
208        -1))))
209
210
211;;;; Addition.
212(defun add-bignums (a b)
213  (let* ((len-a (%bignum-length a))
214         (len-b (%bignum-length b)))
215    (declare (bignum-index len-a len-b))
216    (when (> len-b len-a)
217      (rotatef a b)
218      (rotatef len-a len-b))
219    (let* ((len-res (1+ len-a))
220           (res (%allocate-bignum len-res))
221           (carry 0)
222           (sign-b (%bignum-sign b)))
223        (dotimes (i len-b)
224          (multiple-value-bind (result-digit carry-out)
225              (%add-with-carry (bignum-ref a i) (bignum-ref b i) carry)
226            (setf (bignum-ref res i) result-digit
227                  carry carry-out)))
228        (if (/= len-a len-b)
229          (finish-bignum-add  res carry a sign-b len-b len-a)
230          (setf (bignum-ref res len-a)
231                (%add-with-carry (%bignum-sign a) sign-b carry)))
232        (%normalize-bignum-macro res))))
233
234
235;;; B was shorter than A; keep adding B's sign digit to each remaining
236;;; digit of A, propagating the carry.
237(defun finish-bignum-add (result carry a sign-b start end)
238  (declare (type bignum-index start end))
239  (do* ((i start (1+ i)))
240       ((= i end)
241        (setf (bignum-ref result end)
242              (%add-with-carry (%sign-digit a end) sign-b carry)))
243    (multiple-value-bind (result-digit carry-out)
244        (%add-with-carry (bignum-ref a i) sign-b carry)
245      (setf (bignum-ref result i) result-digit
246            carry carry-out))))
247
248
249;;;; Subtraction.
250(defun subtract-bignum (a b)
251  (let* ((len-a (%bignum-length a))
252         (len-b (%bignum-length b))
253         (len-res (1+ (max len-a len-b)))
254         (res (%allocate-bignum len-res)))
255    (declare (bignum-index len-a len-b len-res))
256    (bignum-subtract-loop a len-a b len-b res)
257    (%normalize-bignum-macro res)))
258
259(defun bignum-subtract-loop (a len-a b len-b res)
260  (declare (bignum-index len-a len-b ))
261  (let* ((len-res (%bignum-length res)))
262    (declare (bignum-index len-res))
263    (let* ((borrow 1)
264           (sign-a (%bignum-sign a))
265           (sign-b (%bignum-sign b)))
266      (dotimes (i (the bignum-index len-res))
267        (multiple-value-bind (result-digit borrow-out)
268            (%subtract-with-borrow
269             (if (< i len-a)
270               (bignum-ref a i)
271               sign-a)
272             (if (< i len-b)
273               (bignum-ref b i)
274               sign-b)
275             borrow)
276          (setf (bignum-ref res i) result-digit
277                borrow borrow-out))))))
278
279
280;;;; Multiplication.
281
282#||
283;;; These parameters match GMP's.
284(defvar *sqr-basecase-threshold* 5)
285(defvar *sqr-karatsuba-threshold* 22)
286(defvar *mul-karatsuba-threshold* 10)
287
288;;; Squaring is often simpler than multiplication.  This should never
289;;; be called with (>= N *sqr-karatsuba-threshold*).
290(defun mpn-sqr-basecase (prodp up n)
291  (declare (fixnum prodp up n))
292  (declare (optimize (speed 3) (safety 0) (space 0)))
293  (umulppm up up prodp)
294  (when (> n 1)
295    (%stack-block ((tarr (* 4 (* 2 *sqr-karatsuba-threshold*))))
296      (let* ((tp (macptr->fixnum tarr)))
297        (mpn-mul-1 tp
298                   (the fixnum (1+ up))
299                   (the fixnum (1- n))
300                   up
301                   (the fixnum (+ tp (the fixnum (1- n)))))
302        (do* ((i 2 (1+ i)))
303             ((= i n))
304          (declare (fixnum i))
305          (mpn-addmul-1 (the fixnum (- (the fixnum (+ tp (the fixnum (+ i i))))
306                                       2))
307                        (the fixnum (+ up i))
308                        (the fixnum (- n i))
309                        (the fixnum (+ up (the fixnum (1- i))))
310                        (the fixnum (+ tp (the fixnum (+ n (the fixnum (- i 2))))))))
311        (do* ((i 1 (1+ i))
312              (ul (1+ up) (1+ ul)))
313             ((= i n))
314          (declare (fixnum i ul))
315          (umulppm ul ul (the fixnum (+ prodp (the fixnum (+ i i))))))
316        (let* ((2n-2 (- (the fixnum (+ n n)) 2))
317               (carry (mpn-lshift-1 tp tp 2n-2)))
318          (declare (fixnum 2n-2 carry))
319          (incf carry (the fixnum (mpn-add-n (the fixnum (1+ prodp))
320                                             (the fixnum (1+ prodp))
321                                             tp
322                                             2n-2)))
323          (add-fixnum-to-limb carry (the fixnum (+ prodp
324                                                   (the fixnum (1-
325                                                                (the fixnum
326                                                                  (+ n n))))))))))))
327
328;;; For large enough values of N, squaring via Karatsuba-style
329;;; divide&conquer is faster than in the base case.
330(defun mpn-kara-sqr-n (p a n ws)
331  (declare (fixnum p a n ws))
332  (declare (optimize (speed 3) (safety 0) (space 0)))
333  (%stack-block ((limbs 16))
334    (let* ((w (macptr->fixnum limbs))
335           (w0 (1+ w))
336           (w1 (1+ w0))
337           (xx (1+ w1))
338           (n2 (ash n -1))
339           (x 0)
340           (y 0)
341           (i 0))
342      (declare (fixnum w w0 w1 xx n2 x y i))
343      (cond ((logbitp 0 n)
344             ;; Odd length
345             (let* ((n3 (- n n2))
346                    (n1 0)
347                    (nm1 0))
348               (declare (fixnum n3 n1 nm1))
349               (copy-limb (the fixnum (+ a n2)) w)
350               (if (not (limb-zerop w))
351                 (add-fixnum-to-limb
352                  (the fixnum
353                    (- (the fixnum (mpn-sub-n p a (the fixnum (+ a n3)) n2))))
354                  w)
355                 (progn
356                   (setq i n2)
357                   (loop
358                     (decf i)
359                     (copy-limb (the fixnum (+ a i)) w0)
360                     (copy-limb (the fixnum (+ a (the fixnum (+ n3 i)))) w1)
361                     (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
362                             (= i 0))
363                       (return)))
364                   (if (< (the fixnum (compare-limbs w0 w1)) 0)
365                     (setq x (+ a n3)
366                           y a)
367                     (setq y (+ a n3)
368                           x a))
369                   (mpn-sub-n p x y n2)))
370               (copy-limb w (the fixnum (+ p n2)))
371               (setq n1 (1+ n))
372               (cond ((< n3 *sqr-basecase-threshold*)
373                      (mpn-mul-basecase ws p n3 p n3)
374                      (mpn-mul-basecase p a n3 a n3))
375                     ((< n3 *sqr-karatsuba-threshold*)
376                      (mpn-sqr-basecase ws p n3)
377                      (mpn-sqr-basecase p a n3))
378                     (t
379                      (mpn-kara-sqr-n ws p n3 (the fixnum (+ ws n1)))
380                      (mpn-kara-sqr-n p  a n3 (the fixnum (+ ws n1)))))
381               (cond ((< n2 *sqr-basecase-threshold*)
382                      (mpn-mul-basecase (the fixnum (+ p n1))
383                                        (the fixnum (+ a n3))
384                                        n2
385                                        (the fixnum (+ a n3))
386                                        n2))
387                     ((< n2 *sqr-karatsuba-threshold*)
388                      (mpn-sqr-basecase (the fixnum (+ p n1))
389                                        (the fixnum (+ a n3))
390                                        n2))
391                     (t
392                      (mpn-kara-sqr-n (the fixnum (+ p n1))
393                                      (the fixnum (+ a n3))
394                                      n2
395                                      (the fixnum (+ ws n1)))))
396               (mpn-sub-n ws p ws n1)
397               (setq nm1 (1- n))
398               (unless (zerop (the fixnum
399                                (mpn-add-n ws
400                                           (the fixnum (+ p n1))
401                                           ws
402                                           nm1)))
403                 (copy-limb (the fixnum (+ ws nm1)) xx)
404                 (add-fixnum-to-limb 1 xx)
405                 (copy-limb xx (the fixnum (+ ws nm1)))
406                 (if (limb-zerop xx)
407                   (add-fixnum-to-limb 1 (the fixnum (+ ws n)))))
408               (unless (zerop
409                        (the fixnum
410                          (mpn-add-n (the fixnum (+ p n3))
411                                     (the fixnum (+ p n3))
412                                     ws
413                                     n1)))
414                 (mpn-incr-u (the fixnum (+ p (the fixnum (+ n1 n3))))
415                             1))))
416            (t ; N is even
417             (setq i n2)
418             (loop
419               (decf i)
420               (copy-limb (the fixnum (+ a i)) w0)
421               (copy-limb (the fixnum (+ a (the fixnum (+ n2 i)))) w1)
422               (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
423                       (= i 0))
424                 (return)))
425             (if (< (the fixnum (compare-limbs w0 w1)) 0)
426               (setq x (+ a n2)
427                     y a)
428               (setq y (+ a n2)
429                     x a))
430             (mpn-sub-n p x y n2)
431             (cond ((< n2 *sqr-basecase-threshold*)
432                    (mpn-mul-basecase ws p n2 p n2)
433                    (mpn-mul-basecase p a n2 a n2)
434                    (mpn-mul-basecase (the fixnum (+ p n))
435                                      (the fixnum (+ a n2))
436                                      n2
437                                      (the fixnum (+ a n2))
438                                      n2))
439                   ((< n2 *sqr-karatsuba-threshold*)
440                    (mpn-sqr-basecase ws p n2)
441                    (mpn-sqr-basecase p a n2)
442                    (mpn-sqr-basecase (the fixnum (+ p n))
443                                      (the fixnum (+ a n2))
444                                      n2))
445                   (t
446                    (mpn-kara-sqr-n ws p n2 (the fixnum (+ ws n)))
447                    (mpn-kara-sqr-n p  a n2 (the fixnum (+ ws n)))
448                    (mpn-kara-sqr-n (the fixnum (+ p n))
449                                    (the fixnum (+ a n2))
450                                    n2
451                                    (the fixnum (+ ws n)))))
452             (let* ((ww (- (the fixnum (mpn-sub-n ws p ws n)))))
453               (declare (fixnum ww))
454               (setq ww (+ ww (mpn-add-n ws (the fixnum (+ p n)) ws n)))
455               (setq ww (+ ww (mpn-add-n (the fixnum (+ p n2))
456                                         (the fixnum (+ p n2))
457                                         ws
458                                         n)))
459               (mpn-incr-u (the fixnum (+ p (the fixnum (+ n2 n)))) ww)))))))
460
461;;; Karatsuba subroutine: multiply A and B, store result at P, use WS
462;;; as scrach space.  Treats A and B as if they were both of size N;
463;;; if that's not true, caller must fuss around the edges.
464(defun mpn-kara-mul-n (p a b n ws)
465  (declare (fixnum p a b n ws))
466  (declare (optimize (speed 3) (safety 0) (space 0)))
467  (%stack-block ((limbs 16))
468    (let* ((w (macptr->fixnum limbs))
469           (w0 (1+ w))
470           (w1 (1+ w0))
471           (xx (1+ w1))
472           (x 0)
473           (y 0)
474           (i 0)
475           (n2 (ash n -1))
476           (sign 0))
477      (declare (fixnum w w0 w1 xx x y i n2 sign))
478      (cond ((logbitp 0 n)
479             (let* ((n1 0)
480                    (n3 (- n n2))
481                    (nm1 0))
482               (declare (fixnum n1 n3 nm1))
483               (copy-limb (the fixnum (+ a n2)) w)
484               (if (not (limb-zerop w))
485                 (add-fixnum-to-limb
486                  (the fixnum (- (mpn-sub-n p a (the fixnum (+ a n3)) n2))) w)
487                 (progn
488                   (setq i n2)
489                   (loop
490                     (decf i)
491                     (copy-limb (the fixnum (+ a i)) w0)
492                     (copy-limb (the fixnum (+ a (the fixnum (+ n3 i)))) w1)
493                     (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
494                             (zerop i))
495                       (return)))
496                   (if (< (the fixnum (compare-limbs w0 w1)) 0)
497                     (setq x (+ a n3)
498                           y a
499                           sign -1)
500                     (setq x a
501                           y (+ a n3)))
502                   (mpn-sub-n p x y n2)))
503               (copy-limb w (the fixnum (+ p n2)))
504               (copy-limb (the fixnum (+ b n2)) w)
505               (if (not (limb-zerop w))
506                 (add-fixnum-to-limb
507                  (the fixnum (- (the fixnum (mpn-sub-n (the fixnum (+ p n3))
508                                                        b
509                                                        (the fixnum (+ b n3))
510                                                        n2))))
511                  w)
512                 (progn
513                   (setq i n2)
514                   (loop
515                     (decf i)
516                     (copy-limb (the fixnum (+ b i)) w0)
517                     (copy-limb (the fixnum (+ b (the fixnum (+ n3 i)))) w1)
518                     (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
519                             (zerop i))
520                       (return)))
521                   (if (< (the fixnum (compare-limbs w0 w1)) 0)
522                     (setq x (+ b n3)
523                           y b
524                           sign (lognot sign))
525                     (setq x b
526                           y (+ b n3)))
527                   (mpn-sub-n (the fixnum (+ p n3)) x y n2)))
528               (copy-limb w (the fixnum (+ p n)))
529               (setq n1 (1+ n))
530               (cond
531                 ((< n2 *mul-karatsuba-threshold*)
532                  (cond
533                    ((< n3 *mul-karatsuba-threshold*)
534                     (mpn-mul-basecase ws p n3 (the fixnum (+ p n3)) n3)
535                     (mpn-mul-basecase p a n3 b n3))
536                    (t
537                     (mpn-kara-mul-n ws p (the fixnum (+ p n3)) n3 (the fixnum (+ ws n1)))
538                     (mpn-kara-mul-n p a b n3 (the fixnum (+ ws n1)))))
539                  (mpn-mul-basecase (the fixnum (+ p n1))
540                                    (the fixnum (+ a n3))
541                                    n2
542                                    (the fixnum (+ b n3))
543                                    n2))
544                 (t
545                  (mpn-kara-mul-n ws p (the fixnum (+ p n3)) n3 (the fixnum (+ ws n1)))
546                  (mpn-kara-mul-n p a b n3 (the fixnum (+ ws n1)))
547                  (mpn-kara-mul-n (the fixnum (+ p n1))
548                                  (the fixnum (+ a n3))
549                                  (the fixnum (+ b n3))
550                                  n2
551                                  (the fixnum (+ ws n1)))))
552               (if (not (zerop sign))
553                 (mpn-add-n ws p ws n1)
554                 (mpn-sub-n ws p ws n1))
555               (setq nm1 (1- n))
556               (unless (zerop (the fixnum (mpn-add-n ws
557                                                     (the fixnum (+ p n1))
558                                                     ws
559                                                     nm1)))
560                 (copy-limb (the fixnum (+ ws nm1)) xx)
561                 (add-fixnum-to-limb 1 xx)
562                 (copy-limb xx (the fixnum (+ ws nm1)))
563                 (if (limb-zerop xx)
564                   (add-fixnum-to-limb 1 (the fixnum (+ ws n)))))
565               (unless (zerop (the fixnum
566                                (mpn-add-n (the fixnum (+ p n3))
567                                           (the fixnum (+ p n3))
568                                           ws
569                                           n1)))
570                 (mpn-incr-u (the fixnum
571                               (+ p (the fixnum (+ n1 n3)))) 1))))
572            (t                          ; even length
573             (setq i n2)
574             (loop
575               (decf i)
576               (copy-limb (the fixnum (+ a i)) w0)
577               (copy-limb (the fixnum (+ a (the fixnum (+ n2 i)))) w1)
578               (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
579                       (zerop i))
580                 (return)))
581             (setq sign 0)
582             (if (< (the fixnum (compare-limbs w0 w1)) 0)
583               (setq x (+ a n2)
584                     y a
585                     sign -1)
586               (setq x a
587                     y (+ a n2)))
588             (mpn-sub-n p x y n2)
589             (setq i n2)
590             (loop
591               (decf i)
592               (copy-limb (the fixnum (+ b i)) w0)
593               (copy-limb (the fixnum (+ b (the fixnum (+ n2 i)))) w1)
594               (if (or (not (zerop (the fixnum (compare-limbs w0 w1))))
595                       (zerop i))
596                 (return)))           
597             (if (< (the fixnum (compare-limbs w0 w1)) 0)
598               (setq x (+ b n2)
599                     y b
600                     sign (lognot sign))
601               (setq x b
602                     y (+ b n2)))
603             (mpn-sub-n (the fixnum (+ p n2)) x y n2)
604             (cond
605               ((< n2 *mul-karatsuba-threshold*)
606                (mpn-mul-basecase ws p n2 (the fixnum (+ p n2)) n2)
607                (mpn-mul-basecase p a n2 b n2)
608                (mpn-mul-basecase (the fixnum (+ p n))
609                                  (the fixnum (+ a n2))
610                                  n2
611                                  (the fixnum (+ b n2))
612                                  n2))
613               (t
614                (mpn-kara-mul-n ws p (the fixnum (+ p n2)) n2
615                                (the fixnum (+ ws n)))
616                (mpn-kara-mul-n p a b n2 (the fixnum (+ ws n)))
617                (mpn-kara-mul-n (the fixnum (+ p n))
618                                (the fixnum (+ a n2))
619                                (the fixnum (+ b n2))
620                                n2
621                                (the fixnum (+ ws n)))))
622             (let* ((ww (if (not (zerop sign))
623                          (mpn-add-n ws p ws n)
624                          (- (the fixnum (mpn-sub-n ws p ws n))))))
625               (declare (fixnum ww))
626               (setq ww (+ ww (mpn-add-n ws (the fixnum (+ p n)) ws n)))
627               (setq ww (+ ww (mpn-add-n (the fixnum (+ p n2))
628                                         (the fixnum (+ p n2))
629                                         ws
630                                         n)))
631               (mpn-incr-u (the fixnum (+ p (the fixnum (+ n2 n)))) ww)))))))
632
633;;; Square UP, of length UN.  I wonder if a Karatsuba multiply might be
634;;; faster than a basecase square.
635(defun mpn-sqr-n (prodp up un)
636  (declare (fixnum prodp up un))
637  (declare (optimize (speed 3) (safety 0) (space 0)))
638  (if (< un *sqr-basecase-threshold*)
639    (mpn-mul-basecase prodp up un up un)
640    (if (< un *sqr-karatsuba-threshold*)
641      (mpn-sqr-basecase prodp up un)
642      (%stack-block ((wsptr (mpn-kara-sqr-n-tsize un)))
643        (mpn-kara-sqr-n prodp up un (macptr->fixnum wsptr))))))
644
645;;; Subroutine: store AxB at P.  Assumes A & B to be of length N
646(defun mpn-mul-n (p a b n)
647  (declare (fixnum p a b n))
648  (declare (optimize (speed 3) (safety 0) (space 0))) 
649  (if (< n *mul-karatsuba-threshold*)
650    (mpn-mul-basecase p a n b n)
651    (%stack-block ((wsptr (mpn-kara-mul-n-tsize n)))
652      (mpn-kara-mul-n p a b n (macptr->fixnum wsptr)))))
653
654
655;;; Multiply [UP,UN] by [VP,VN].  UN must not be less than VN.
656;;; This does Karatsuba if operands are big enough; if they are
657;;; and they differ in size, this computes the product of the
658;;; smaller-size slices, then fixes up the resut.
659(defun mpn-mul (prodp up un vp vn)
660  (declare (fixnum prodp up un vp vn))
661  (declare (optimize (speed 3) (safety 0) (space 0)))
662  ;(assert (>= un vn 1))
663  (if (and (= up vp) (= un vn))
664    (mpn-sqr-n prodp up un)
665    (if (< vn *mul-karatsuba-threshold*)
666      (mpn-mul-basecase prodp up un vp vn)
667      (let* ((l vn))
668        (declare (fixnum l))
669        (mpn-mul-n prodp up vp vn)
670        (unless (= un vn)
671          (incf prodp vn)
672          (incf up vn)
673          (decf un vn)
674          (if (< un vn)
675            (psetq un vn vn un up vp vp up))
676          (%stack-block ((wsptr
677                          (the fixnum
678                            (+ 8
679                               (the fixnum
680                                 (* 4
681                                    (the fixnum
682                                      (+ vn
683                                         (if (>= vn *mul-karatsuba-threshold*)
684                                           vn
685                                           un)))))))))
686            (setf (%get-unsigned-long wsptr 0) 0
687                  (%get-unsigned-long wsptr 4) 0)
688            (let* ((tt (macptr->fixnum wsptr))
689                   (c (1+ tt))
690                   (ws (1+ c)))
691              (declare (fixnum tt c ws ))
692              (do* ()
693                   ((< vn *mul-karatsuba-threshold*))
694                (mpn-mul-n ws up vp vn)
695                (cond ((<= l (the fixnum (+ vn vn)))
696                       (add-fixnum-to-limb (mpn-add-n prodp prodp ws l) tt)
697                       (unless (= l (the fixnum (+ vn vn)))
698                         (copy-fixnum-to-limb
699                          (mpn-add-1 (the fixnum (+ prodp l))
700                                     (the fixnum (+ ws l))
701                                     (the fixnum (- (the fixnum (+ vn vn)) l))
702                                     tt)
703                          tt)
704                         (setq l (the fixnum (+ vn vn)))))
705                      (t
706                       (copy-fixnum-to-limb
707                        (mpn-add-n prodp prodp ws (the fixnum (+ vn vn))) c)
708                       (add-fixnum-to-limb
709                        (mpn-add-1 (the fixnum (+ prodp (the fixnum (+ vn vn))))
710                                   (the fixnum (+ prodp (the fixnum (+ vn vn))))
711                                   (the fixnum (- l (the fixnum (+ vn vn))))
712                                   c)
713                        tt)))
714                (incf prodp vn)
715                (decf l vn)
716                (incf up vn)
717                (decf un vn)
718                (if (< un vn)
719                  (psetq up vp vp up un vn vn un)))
720              (unless (zerop vn)
721                (mpn-mul-basecase ws up un vp vn)
722                (cond ((<= l (the fixnum (+ un vn)))
723                       (add-fixnum-to-limb
724                        (mpn-add-n prodp prodp ws l)
725                        tt)
726                       (unless (= l (the fixnum (+ un vn)))
727                         (copy-fixnum-to-limb
728                          (mpn-add-1 (the fixnum (+ prodp l))
729                                     (the fixnum (+ ws l))
730                                     (the fixnum (- (the fixnum (+ un vn)) l))
731                                     tt)
732                          tt)))
733                      (t
734                       (copy-fixnum-to-limb
735                        (mpn-add-n prodp prodp ws (the fixnum (+ un vn)))
736                        c)
737                       (add-fixnum-to-limb
738                        (mpn-add-1
739                         (the fixnum (+ prodp (the fixnum (+ un vn))))
740                         (the fixnum (+ prodp (the fixnum (+ un vn))))
741                         (the fixnum (- (the fixnum (- l un)) vn))
742                         c)
743                        tt)))))))))))
744||#
745
746(defun multiply-bignums (a b)
747  (let* ((signs-differ (not (eq (bignum-minusp a) (bignum-minusp b)))))
748    (flet ((multiply-unsigned-bignums (a b)
749             (let* ((len-a (%bignum-length a))
750                    (len-b (%bignum-length b))
751                    (len-res (+ len-a len-b))
752                    (res (%allocate-bignum len-res)) )
753               (declare (bignum-index len-a len-b len-res))
754               (dotimes (i len-a)
755                 (declare (type bignum-index i))
756                 (let* ((carry-digit 0)
757                        (x (bignum-ref a i))
758                        (k i))
759                   (declare (fixnum k))
760                   (dotimes (j len-b)
761                     (multiple-value-bind (big-carry res-digit)
762                         (%multiply-and-add4 x
763                                             (bignum-ref b j)
764                                             (bignum-ref res k)
765                                             carry-digit)
766                       (setf (bignum-ref res k) res-digit
767                             carry-digit big-carry
768                             k (1+ k))))
769                   (setf (bignum-ref res k) carry-digit)))
770                 res)))
771      (let* ((res (with-negated-bignum-buffers a b multiply-unsigned-bignums)))
772        (if signs-differ (negate-bignum-in-place res))
773        (%normalize-bignum-macro res)))))
774
775
776(defun multiply-bignum-and-fixnum (bignum fixnum)
777  (declare (type bignum-type bignum) (fixnum fixnum))
778  (let* ((big-len (%bignum-length bignum))
779         (big-neg (bignum-minusp bignum))
780         (signs-differ (not (eq big-neg (minusp fixnum)))))
781    (flet ((multiply-unsigned-bignum-and-2-digit-fixnum (a len-a high low)
782             (declare (bignum-type a)
783                      (bignum-element-type high low)
784                      (bignum-index len-a)
785                      (optimize (speed 3) (safety 0)))
786             (let* ((len-res (+ len-a 2))
787                    (res (%allocate-bignum len-res)) )
788               (declare (bignum-index len-a  len-res))
789               (dotimes (i len-a)
790                 (declare (type bignum-index i))
791                 (let* ((carry-digit 0)
792                        (x (bignum-ref a i))
793                        (k i))
794                   (declare (fixnum k))
795                   (multiple-value-bind (big-carry res-digit)
796                       (%multiply-and-add4 x
797                                           low
798                                           (bignum-ref res k)
799                                           carry-digit)
800                     (setf (bignum-ref res k) res-digit
801                           carry-digit big-carry
802                           k (1+ k)))
803                   (multiple-value-bind (big-carry res-digit)
804                       (%multiply-and-add4 x
805                                           high
806                                           (bignum-ref res k)
807                                           carry-digit)
808                     (setf (bignum-ref res k) res-digit
809                           carry-digit big-carry
810                           k (1+ k)))
811                   (setf (bignum-ref res k) carry-digit)))
812               res))
813           (multiply-unsigned-bignum-and-1-digit-fixnum (a len-a fix)
814             (declare (bignum-type a)
815                      (bignum-element-type fix)
816                      (bignum-index len-a)
817                      (optimize (speed 3) (safety 0)))
818             (let* ((len-res (+ len-a 1))
819                    (res (%allocate-bignum len-res)) )
820               (declare (bignum-index len-a  len-res))
821               (dotimes (i len-a)
822                 (declare (type bignum-index i))
823                 (let* ((carry-digit 0)
824                        (x (bignum-ref a i))
825                        (k i))
826                   (declare (fixnum k))
827                   (multiple-value-bind (big-carry res-digit)
828                       (%multiply-and-add4 x
829                                           fix
830                                           (bignum-ref res k)
831                                           carry-digit)
832                     (setf (bignum-ref res k) res-digit
833                           carry-digit big-carry
834                           k (1+ k)))
835                   (setf (bignum-ref res k) carry-digit)))
836               res)))
837      (let* ((low (logand (1- (ash 1 32)) fixnum))
838             (high (unless (<= (%fixnum-intlen fixnum) 32)
839                     (ldb (byte 32 32) fixnum)))
840             (res (if big-neg
841                    (let* ((neg-len (1+ big-len)))
842                      (declare (type bignum-index neg-len))
843                      (with-bignum-buffers ((neg neg-len))
844                        (negate-bignum bignum nil neg)
845                        (if high
846                          (multiply-unsigned-bignum-and-2-digit-fixnum
847                           neg
848                           neg-len
849                           high
850                           low)
851                          (multiply-unsigned-bignum-and-1-digit-fixnum
852                           neg
853                           neg-len
854                           low))))
855                    (if high
856                      (multiply-unsigned-bignum-and-2-digit-fixnum
857                       bignum
858                       big-len
859                       high
860                       low)
861                      (multiply-unsigned-bignum-and-1-digit-fixnum
862                       bignum
863                       big-len
864                       low)))))
865        (if signs-differ (negate-bignum-in-place res))
866        (%normalize-bignum-macro res)))))
867
868
869;; assume we already know result won't fit in a fixnum
870;; only caller is fixnum-*-2
871;;
872
873(defun multiply-fixnums (a b)
874  (declare (fixnum a b))
875  (* a b))
876
877
878;;;; GCD.
879
880
881;;; Both args are > 0.
882(defun bignum-fixnum-gcd (bignum fixnum)
883  (let* ((rem (bignum-truncate-by-fixnum-no-quo bignum fixnum)))
884    (declare (fixnum rem))
885    (if (zerop rem)
886      fixnum
887      (%fixnum-gcd rem fixnum))))
888
889
890
891;;; NEGATE-BIGNUM -- Public.
892;;;
893;;; Fully-normalize is an internal optional.  It cause this to always return
894;;; a bignum, without any extraneous digits, and it never returns a fixnum.
895;;;
896(defun negate-bignum (x &optional (fully-normalize t) res)
897  (declare (type bignum-type x))
898  (let* ((len-x (%bignum-length x))
899         (len-res (1+ len-x))
900         (minusp (bignum-minusp x))
901         (res (or res (%allocate-bignum len-res))))
902    (declare (type bignum-index len-x len-res)) ;Test len-res for range?
903    (let ((carry (bignum-negate-loop-really x len-x res)))
904      (declare (fixnum carry))
905      (if (zerop carry)
906        (setf (bignum-ref res len-x) (if minusp 0 all-ones-digit))
907        (setf (bignum-ref res len-x) (if minusp 1 0))))
908    (if fully-normalize
909      (%normalize-bignum-macro res)
910      (%mostly-normalize-bignum-macro res))))
911
912;;; NEGATE-BIGNUM-IN-PLACE -- Internal.
913;;;
914;;; This assumes bignum is positive; that is, the result of negating it will
915;;; stay in the provided allocated bignum.
916;;;
917(defun negate-bignum-in-place (bignum)
918  (bignum-negate-loop-really bignum (%bignum-length bignum) bignum)
919  bignum)
920
921
922 
923
924(defun copy-bignum (bignum)
925  (let ((res (%allocate-bignum (%bignum-length bignum))))
926    (bignum-replace res bignum)
927    res))
928
929
930
931;;; BIGNUM-ASHIFT-RIGHT -- Public.
932;;;
933;;; First compute the number of whole digits to shift, shifting them by
934;;; skipping them when we start to pick up bits, and the number of bits to
935;;; shift the remaining digits into place.  If the number of digits is greater
936;;; than the length of the bignum, then the result is either 0 or -1.  If we
937;;; shift on a digit boundary (that is, n-bits is zero), then we just copy
938;;; digits.  The last branch handles the general case which uses a macro that a
939;;; couple other routines use.  The fifth argument to the macro references
940;;; locals established by the macro.
941;;;
942
943
944(defun bignum-ashift-right (bignum x)
945  (declare (type bignum-type bignum)
946           (fixnum x))
947  (let ((bignum-len (%bignum-length bignum)))
948    (declare (type bignum-index bignum-len))
949    (multiple-value-bind (digits n-bits) (truncate x digit-size)
950      (declare (type bignum-index digits)(fixnum n-bits))
951      (cond
952       ((>= digits bignum-len)
953        (if (bignum-plusp bignum) 0 -1))
954       ((eql 0 n-bits)
955        (bignum-ashift-right-digits bignum digits))
956       (t
957        (shift-right-unaligned bignum digits n-bits (- bignum-len digits)
958                                      ((= j res-len-1)
959                                       (setf (bignum-ref res j)
960                                             (%ashr (bignum-ref bignum i) n-bits))
961                                       (%normalize-bignum-macro res))
962                                      res))))))
963
964                               
965
966
967
968;;; BIGNUM-ASHIFT-RIGHT-DIGITS -- Internal.
969;;;
970(defun bignum-ashift-right-digits (bignum digits)
971  (declare (type bignum-type bignum)
972           (type bignum-index digits))
973  (let* ((res-len (- (%bignum-length bignum) digits))
974         (res (%allocate-bignum res-len)))
975    (declare (type bignum-index res-len)
976             (type bignum-type res))
977    (bignum-replace res bignum :start2 digits)
978    (%normalize-bignum-macro res)))
979
980
981;;; BIGNUM-BUFFER-ASHIFT-RIGHT -- Internal.
982;;;
983;;; GCD uses this for an in-place shifting operation.  This is different enough
984;;; from BIGNUM-ASHIFT-RIGHT that it isn't worth folding the bodies into a
985;;; macro, but they share the basic algorithm.  This routine foregoes a first
986;;; test for digits being greater than or equal to bignum-len since that will
987;;; never happen for its uses in GCD.  We did fold the last branch into a macro
988;;; since it was duplicated a few times, and the fifth argument to it
989;;; references locals established by the macro.
990;;;
991 
992
993;;; BIGNUM-ASHIFT-LEFT -- Public.
994;;;
995;;; This handles shifting a bignum buffer to provide fresh bignum data for some
996;;; internal routines.  We know bignum is safe when called with bignum-len.
997;;; First we compute the number of whole digits to shift, shifting them
998;;; starting to store farther along the result bignum.  If we shift on a digit
999;;; boundary (that is, n-bits is zero), then we just copy digits.  The last
1000;;; branch handles the general case.
1001;;;
1002(defun bignum-ashift-left (bignum x &optional bignum-len)
1003  (declare (type bignum-type bignum)
1004           (fixnum x)
1005           (type (or null bignum-index) bignum-len))
1006  (multiple-value-bind (digits n-bits)
1007                       (truncate x digit-size)
1008    (declare (fixnum digits n-bits))
1009    (let* ((bignum-len (or bignum-len (%bignum-length bignum)))
1010           (res-len (+ digits bignum-len 1)))
1011      (declare (fixnum bignum-len res-len))
1012      (when (> res-len maximum-bignum-length)
1013        (error "Can't represent result of left shift."))
1014      (if (zerop n-bits)
1015        (bignum-ashift-left-digits bignum bignum-len digits)
1016        (bignum-ashift-left-unaligned bignum digits n-bits res-len)))))
1017
1018;;; BIGNUM-ASHIFT-LEFT-DIGITS -- Internal.
1019;;;
1020(defun bignum-ashift-left-digits (bignum bignum-len digits)
1021  (declare (type bignum-index bignum-len digits))
1022  (let* ((res-len (+ bignum-len digits))
1023         (res (%allocate-bignum res-len)))
1024    (declare (type bignum-index res-len))
1025    (bignum-replace res bignum :start1 digits :end1 res-len :end2 bignum-len
1026                    :from-end t)
1027    res))
1028
1029
1030
1031;;; BIGNUM-ASHIFT-LEFT-UNALIGNED -- Internal.
1032;;;
1033;;; BIGNUM-TRUNCATE uses this to store into a bignum buffer by supplying res.
1034;;; When res comes in non-nil, then this foregoes allocating a result, and it
1035;;; normalizes the buffer instead of the would-be allocated result.
1036;;;
1037;;; We start storing into one digit higher than digits, storing a whole result
1038;;; digit from parts of two contiguous digits from bignum.  When the loop
1039;;; finishes, we store the remaining bits from bignum's first digit in the
1040;;; first non-zero result digit, digits.  We also grab some left over high
1041;;; bits from the last digit of bignum.
1042;;;
1043
1044(defun bignum-ashift-left-unaligned (bignum digits n-bits res-len
1045                                            &optional (res nil resp))
1046  (declare (type bignum-index digits res-len)
1047           (type (mod #.digit-size) n-bits))
1048  (let* ((remaining-bits (- digit-size n-bits))
1049         (res-len-1 (1- res-len))
1050         (res (or res (%allocate-bignum res-len))))
1051    (declare (type bignum-index res-len res-len-1))
1052    (do ((i 0 i+1)
1053         (i+1 1 (1+ i+1))
1054         (j (1+ digits) (1+ j)))
1055        ((= j res-len-1)
1056         (setf (bignum-ref res digits)
1057               (%ashl (bignum-ref bignum 0) n-bits))
1058         (setf (bignum-ref res j)
1059               (%ashr (bignum-ref bignum i) remaining-bits))
1060         (if resp
1061           (%zero-trailing-sign-digits res res-len)
1062           (%mostly-normalize-bignum-macro res)))
1063      (declare (type bignum-index i i+1 j))
1064      (setf (bignum-ref res j)
1065            (%logior (%digit-logical-shift-right (bignum-ref bignum i)
1066                                                 remaining-bits)
1067                     (%ashl (bignum-ref bignum i+1) n-bits))))))
1068
1069
1070
1071
1072
1073
1074
1075;;;; Relational operators.
1076
1077
1078
1079;;; BIGNUM-COMPARE -- Public.
1080;;;
1081;;; This compares two bignums returning -1, 0, or 1, depending on whether a
1082;;; is less than, equal to, or greater than b.
1083;;;
1084;(proclaim '(function bignum-compare (bignum bignum) (integer -1 1)))
1085(defun bignum-compare (a b)
1086  (declare (type bignum-type a b))
1087  (let* ((a-plusp (bignum-plusp a))
1088         (b-plusp (bignum-plusp b)))
1089    (if (eq a-plusp b-plusp)
1090      (let* ((len-a (%bignum-length a))
1091             (len-b (%bignum-length b)))
1092        (declare (type bignum-index len-a len-b))
1093        (cond ((= len-a len-b)
1094               (do* ((i (1- len-a) (1- i)))
1095                    ((zerop i) (%compare-digits a b 0))
1096                 (declare (fixnum i))
1097                 (let* ((signum (%compare-digits a b i)))
1098                   (declare (fixnum signum))
1099                   (unless (zerop signum)
1100                     (return signum)))))
1101              ((> len-a len-b)
1102               (if a-plusp 1 -1))
1103              (t (if a-plusp -1 1))))
1104      (if a-plusp 1 -1))))
1105
1106
1107
1108
1109
1110
1111;;;; Integer length and logcount
1112
1113
1114(defun bignum-integer-length (big)
1115  (the fixnum (- (the fixnum (ash (the fixnum (%bignum-length big)) 5))
1116                 (the fixnum (%bignum-sign-bits big)))))
1117
1118; (not (zerop (logand integer1 integer2)
1119
1120(defun bignum-logtest (num1 num2)
1121  (let* ((length1 (%bignum-length num1))
1122         (length2 (%bignum-length num2))
1123         (n1-minusp (bignum-minusp num1))
1124         (n2-minusp (bignum-minusp num2)))
1125    (declare (fixnum length1 length2))
1126    (if (and n1-minusp n2-minusp) ; both neg, get out quick
1127      T       
1128      (or (dotimes (i (min length1 length2))
1129            (unless (zerop (the fixnum
1130                             (logand (the fixnum (bignum-ref num1 i))
1131                                     (the fixnum (bignum-ref num2 i)))))
1132              (return t)))
1133          (if (< length1 length2)
1134            n1-minusp
1135            (if (< length1 length2)
1136              n2-minusp))))))
1137
1138(defun logtest-fix-big (fix big)
1139  (declare (fixnum fix))
1140  (unless (zerop fix)
1141    (if (plusp fix)
1142      (or
1143       (not (eql 0 (the fixnum (logand (the fixnum (bignum-ref big 0)) fix))))
1144       (and (> (%bignum-length big) 1)
1145            (not (eql 0 (the fixnum (logand (the fixnum (bignum-ref big 1))
1146                                            (the fixnum (ash fix -32))))))))
1147      t)))
1148
1149
1150(defun bignum-logcount (bignum)
1151  (declare (type bignum-type bignum))
1152  (let* ((length (%bignum-length bignum))
1153         (plusp (bignum-plusp bignum))
1154         (result 0))
1155    (declare (type bignum-index length)
1156             (fixnum result))
1157    (if plusp
1158      (dotimes (index length result)
1159        (incf result (the fixnum (%logcount bignum index))))
1160      (dotimes (index length result)
1161        (incf result (the fixnum (%logcount-complement bignum index)))))))
1162
1163
1164;;;; Logical operations.
1165
1166;;; NOT.
1167;;;
1168
1169;;; BIGNUM-LOGICAL-NOT -- Public.
1170;;;
1171(defun bignum-logical-not (a)
1172  (declare (type bignum-type a))
1173  (let* ((len (%bignum-length a))
1174         (res (%allocate-bignum len)))
1175    (declare (type bignum-index len))
1176    (dotimes (i len res)
1177      (bignum-set res i (%lognot (the fixnum (bignum-ref a i)))))))
1178
1179
1180
1181
1182;;; AND.
1183;;;
1184
1185;;; BIGNUM-LOGICAL-AND -- Public.
1186;;;
1187(defun bignum-logical-and (a b)
1188  (declare (type bignum-type a b))
1189  (let* ((len-a (%bignum-length a))
1190         (len-b (%bignum-length b))
1191         (a-plusp (bignum-plusp a))
1192         (b-plusp (bignum-plusp b)))
1193    (declare (type bignum-index len-a len-b))
1194    (cond
1195      ((< len-a len-b)
1196       (if a-plusp
1197         (logand-shorter-positive a len-a b (%allocate-bignum len-a))
1198         (logand-shorter-negative a len-a b len-b (%allocate-bignum len-b))))
1199      ((< len-b len-a)
1200       (if b-plusp
1201         (logand-shorter-positive b len-b a (%allocate-bignum len-b))
1202         (logand-shorter-negative b len-b a len-a (%allocate-bignum len-a))))
1203      (t (logand-shorter-positive a len-a b (%allocate-bignum len-a))))))
1204
1205;;; LOGAND-SHORTER-POSITIVE -- Internal.
1206;;;
1207;;; This takes a shorter bignum, a and len-a, that is positive.  Because this
1208;;; is AND, we don't care about any bits longer than a's since its infinite 0
1209;;; sign bits will mask the other bits out of b.  The result is len-a big.
1210;;;
1211(defun logand-shorter-positive (a len-a b res)
1212  (declare (type bignum-type a b res)
1213           (type bignum-index len-a))
1214  (dotimes (i len-a)
1215    (setf (bignum-ref res i)
1216          (logand (the fixnum (bignum-ref a i))
1217                  (the fixnum (bignum-ref b i)))))
1218  (%normalize-bignum-macro res))
1219
1220;;; LOGAND-SHORTER-NEGATIVE -- Internal.
1221;;;
1222;;; This takes a shorter bignum, a and len-a, that is negative.  Because this
1223;;; is AND, we just copy any bits longer than a's since its infinite 1 sign
1224;;; bits will include any bits from b.  The result is len-b big.
1225;;;
1226(defun logand-shorter-negative (a len-a b len-b res)
1227  (declare (type bignum-type a b res)
1228           (type bignum-index len-a len-b))
1229  (dotimes (i len-a)
1230    (setf (bignum-ref res i)
1231          (logand (the fixnum (bignum-ref a i))
1232                              (the fixnum (bignum-ref b i)))))
1233  (bignum-replace res b :start1 len-a :start2 len-a :end1 len-b :end2 len-b)
1234  (%normalize-bignum-macro res))
1235
1236
1237
1238;;;
1239;;;
1240;;; bignum-logandc2
1241
1242(defun bignum-logandc2 (a b)
1243  (declare (type bignum-type a b))
1244  (let* ((len-a (%bignum-length a))
1245         (len-b (%bignum-length b))
1246         (a-plusp (bignum-plusp a))
1247         (b-plusp (bignum-plusp b)))
1248    (declare (type bignum-index len-a len-b))
1249    (cond
1250     ((< len-a len-b)
1251      (logandc2-shorter-any a len-a b len-b (if a-plusp (%allocate-bignum len-a) (%allocate-bignum len-b))))
1252     ((< len-b len-a) ; b shorter
1253      (logandc1-shorter-any b len-b a len-a (if b-plusp (%allocate-bignum len-a)(%allocate-bignum len-b))))
1254     (t (logandc2-shorter-any a len-a b len-b (%allocate-bignum len-a))))))
1255
1256(defun logandc2-shorter-any (a len-a b len-b res)
1257  (declare (type bignum-type a b res)
1258           (type bignum-index len-a len-b))
1259  (dotimes (i len-a)
1260    (setf (bignum-ref res i)
1261          (logand (the fixnum (bignum-ref a i))
1262                  (the fixnum (%lognot (the fixnum (bignum-ref b i)))))))
1263  (if (bignum-minusp a)
1264    (do ((i len-a (1+ i)))
1265          ((= i len-b))
1266        (declare (type bignum-index i))
1267      (setf (bignum-ref res i)
1268            (%lognot (the fixnum (bignum-ref b i))))))
1269  (%normalize-bignum-macro res))
1270
1271
1272
1273(defun logandc1-shorter-any (a len-a b len-b res)
1274  (declare (type bignum-type a b res)
1275           (type bignum-index len-a len-b))
1276  (dotimes (i len-a)
1277    (setf (bignum-ref res i)
1278          (logand
1279           (the fixnum (%lognot (the fixnum (bignum-ref a i))))
1280           (the fixnum (bignum-ref b i)))))
1281  (when (bignum-plusp a)
1282    (unless (= len-a len-b)
1283      (bignum-replace res b :start1 len-a :start2 len-a :end1 len-b :end2 len-b)))
1284  (%normalize-bignum-macro res))
1285
1286
1287
1288(defun fix-big-logand (fix big)
1289  (let* ((len-b (%bignum-length big))
1290         (res (if (< fix 0)(%allocate-bignum len-b))))
1291    (declare (fixnum fix len-b))       
1292    (let ((val (fix-digit-logand fix big res)))
1293      (if res
1294        (progn
1295          (bignum-replace res big :start1 2 :start2 2 :end1 len-b :end2 len-b)
1296          (%normalize-bignum-macro res))
1297        val))))
1298
1299
1300(defun fix-big-logandc2 (fix big)
1301  (let* ((len-b (%bignum-length big))
1302         (res (if (< fix 0)(%allocate-bignum len-b))))
1303    (declare (fixnum fix len-b))       
1304    (let ((val (fix-digit-logandc2 fix big res)))
1305      (if res
1306        (progn
1307          (do ((i 2 (1+ i)))
1308              ((= i len-b))
1309            (declare (type bignum-index i))
1310            (setf (bignum-ref res i)
1311                  (%lognot (bignum-ref big i))))
1312          (%normalize-bignum-macro res))
1313        val))))
1314
1315(defun fix-big-logandc1 (fix big)
1316  (let* ((len-b (%bignum-length big))
1317         (res (if (>= fix 0)(%allocate-bignum len-b))))
1318    (declare (fixnum fix len-b))       
1319    (let ((val (fix-digit-logandc1 fix big res)))
1320      (if res
1321        (progn 
1322          (bignum-replace res big :start1 2 :start2 2 :end1 len-b :end2 len-b)
1323          (%normalize-bignum-macro res))
1324        val))))
1325
1326
1327;;; IOR.
1328;;;
1329
1330;;; BIGNUM-LOGICAL-IOR -- Public.
1331;;;
1332(defun bignum-logical-ior (a b)
1333  (declare (type bignum-type a b))
1334  (let* ((len-a (%bignum-length a))
1335         (len-b (%bignum-length b))
1336         (a-plusp (bignum-plusp a))
1337         (b-plusp (bignum-plusp b)))
1338    (declare (type bignum-index len-a len-b))
1339    (cond
1340     ((< len-a len-b)
1341      (if a-plusp
1342          (logior-shorter-positive a len-a b len-b (%allocate-bignum len-b))
1343          (logior-shorter-negative a len-a b len-b (%allocate-bignum len-b))))
1344     ((< len-b len-a)
1345      (if b-plusp
1346          (logior-shorter-positive b len-b a len-a (%allocate-bignum len-a))
1347          (logior-shorter-negative b len-b a len-a (%allocate-bignum len-a))))
1348     (t (logior-shorter-positive a len-a b len-b (%allocate-bignum len-a))))))
1349
1350;;; LOGIOR-SHORTER-POSITIVE -- Internal.
1351;;;
1352;;; This takes a shorter bignum, a and len-a, that is positive.  Because this
1353;;; is IOR, we don't care about any bits longer than a's since its infinite
1354;;; 0 sign bits will mask the other bits out of b out to len-b.  The result
1355;;; is len-b long.
1356;;;
1357(defun logior-shorter-positive (a len-a b len-b res)
1358  (declare (type bignum-type a b res)
1359           (type bignum-index len-a len-b))
1360  (dotimes (i len-a)
1361    (setf (bignum-ref res i)
1362          (logior (the fixnum (bignum-ref a i))
1363                  (the fixnum (bignum-ref b i)))))
1364  (if (not (eql len-a len-b))
1365    (bignum-replace res b :start1 len-a :start2 len-a :end1 len-b :end2 len-b))
1366  (%normalize-bignum-macro res))
1367
1368;;; LOGIOR-SHORTER-NEGATIVE -- Internal.
1369;;;
1370;;; This takes a shorter bignum, a and len-a, that is negative.  Because this
1371;;; is IOR, we just copy any bits longer than a's since its infinite 1 sign
1372;;; bits will include any bits from b.  The result is len-b long.
1373;;;
1374(defun logior-shorter-negative (a len-a b len-b res)
1375  (declare (type bignum-type a b res)
1376           (type bignum-index len-a len-b))
1377  (dotimes (i len-a)
1378    (setf (bignum-ref res i)
1379          (logior (the fixnum (bignum-ref a i))
1380                  (the fixnum (bignum-ref b i)))))
1381  (do ((i len-a (1+ i)))
1382      ((= i len-b))
1383    (declare (type bignum-index i))
1384    (setf (bignum-ref res i) #xffffffff))
1385  (%normalize-bignum-macro res))
1386
1387
1388
1389
1390;;; XOR.
1391;;;
1392
1393;;; BIGNUM-LOGICAL-XOR -- Public.
1394;;;
1395(defun bignum-logical-xor (a b)
1396  (declare (type bignum-type a b))
1397  (let ((len-a (%bignum-length a))
1398        (len-b (%bignum-length b)))
1399    (declare (type bignum-index len-a len-b))
1400    (if (< len-a len-b)
1401        (bignum-logical-xor-aux a len-a b len-b (%allocate-bignum len-b))
1402        (bignum-logical-xor-aux b len-b a len-a (%allocate-bignum len-a)))))
1403
1404;;; BIGNUM-LOGICAL-XOR-AUX -- Internal.
1405;;;
1406;;; This takes the the shorter of two bignums in a and len-a.  Res is len-b
1407;;; long.  Do the XOR.
1408;;;
1409(defun bignum-logical-xor-aux (a len-a b len-b res)
1410  (declare (type bignum-type a b res)
1411           (type bignum-index len-a len-b))
1412  (dotimes (i len-a)
1413    (setf (bignum-ref res i)
1414          (%logxor (the fixnum (bignum-ref a i))
1415                  (the fixnum (bignum-ref b i)))))
1416  (unless (= len-a len-b)
1417    (let ((sign (if (bignum-minusp a) all-ones-digit 0)))
1418      (declare (fixnum sign))
1419      (do ((i len-a (1+ i)))
1420          ((= i len-b))
1421        (declare (type bignum-index i))
1422        (setf (bignum-ref res i)
1423              (%logxor (bignum-ref b i) sign)))))
1424  (%normalize-bignum-macro res))
1425
1426
1427;;;; TRUNCATE
1428
1429;;; Divide X by Y when Y is a single bignum digit. BIGNUM-TRUNCATE
1430;;; fixes up the quotient and remainder with respect to sign and
1431;;; normalization.
1432;;;
1433;;; We don't have to worry about shifting Y to make its most
1434;;; significant digit sufficiently large for %FLOOR to return
1435;;; digit-size quantities for the q-digit and r-digit. If Y is
1436;;; a single digit bignum, it is already large enough for
1437;;; %FLOOR. That is, it has some bits on pretty high in the
1438;;; digit.
1439
1440(defun bignum-truncate-single-digit (x len-x y)
1441  (declare (type bignum-index len-x))
1442  (let ((q (%allocate-bignum len-x))
1443        (r 0)
1444        (y (bignum-ref y 0)))
1445    (declare (type bignum-element-type r y))
1446    (do ((i (1- len-x) (1- i)))
1447        ((minusp i))
1448      (multiple-value-bind (q-digit r-digit)
1449          (%floor r (bignum-ref x i) y)
1450        (declare (type bignum-element-type q-digit r-digit))
1451        (setf (bignum-ref q i) q-digit)
1452        (setf r r-digit)))
1453    (let ((rem (%allocate-bignum 1)))
1454      (setf (bignum-ref rem 0) r)
1455      (values q rem))))
1456
1457;;; This returns a guess for the next division step. Y1 is the
1458;;; highest y digit, and y2 is the second to highest y
1459;;; digit. The x... variables are the three highest x digits
1460;;; for the next division step.
1461;;;
1462;;; From Knuth, our guess is either all ones or x-i and x-i-1
1463;;; divided by y1, depending on whether x-i and y1 are the
1464;;; same. We test this guess by determining whether guess*y2
1465;;; is greater than the three high digits of x minus guess*y1
1466;;; shifted left one digit:
1467;;;    ------------------------------
1468;;;   |    x-i    |   x-i-1  | x-i-2 |
1469;;;    ------------------------------
1470;;;    ------------------------------
1471;;; - | g*y1 high | g*y1 low |   0   |
1472;;;    ------------------------------
1473;;;             ...               <   guess*y2     ???   
1474;;; If guess*y2 is greater, then we decrement our guess by one
1475;;; and try again.  This returns a guess that is either
1476;;; correct or one too large.
1477(defun bignum-truncate-guess (y1 y2 x-i x-i-1 x-i-2)
1478  (declare (type bignum-element-type y1 y2 x-i x-i-1 x-i-2))
1479  (let ((guess (if (= x-i y1)
1480                 all-ones-digit
1481                 (%floor x-i x-i-1 y1))))
1482    (declare (type bignum-element-type guess))
1483    (loop
1484      (multiple-value-bind (high-guess*y1 low-guess*y1)
1485          (%multiply guess y1)
1486        (declare (type bignum-element-type low-guess*y1
1487                       high-guess*y1))
1488        (multiple-value-bind (high-guess*y2 low-guess*y2)
1489            (%multiply guess y2)
1490          (declare (type bignum-element-type high-guess*y2
1491                         low-guess*y2))
1492          (multiple-value-bind (middle-digit borrow)
1493              (%subtract-with-borrow x-i-1 low-guess*y1 1)
1494            (declare (type bignum-element-type middle-digit)
1495                     (fixnum borrow))
1496            ;; Supplying borrow of 1 means there was no
1497            ;; borrow, and we know x-i-2 minus 0 requires
1498            ;; no borrow.
1499            (let ((high-digit (%subtract-with-borrow x-i
1500                                                     high-guess*y1
1501                                                     borrow)))
1502              (declare (type bignum-element-type high-digit))
1503              (if (and (= high-digit 0)
1504                       (or (> high-guess*y2
1505                              middle-digit)
1506                           (and (= middle-digit
1507                                   high-guess*y2)
1508                                (> low-guess*y2
1509                                   x-i-2))))
1510                (setf guess (%subtract-with-borrow guess 1 1))
1511                (return guess)))))))))
1512
1513
1514;;; This returns the amount to shift y to place a one in the
1515;;; second highest bit. Y must be positive. If the last digit
1516;;; of y is zero, then y has a one in the previous digit's
1517;;; sign bit, so we know it will take one less than digit-size
1518;;; to get a one where we want. Otherwise, we count how many
1519;;; right shifts it takes to get zero; subtracting this value
1520;;; from digit-size tells us how many high zeros there are
1521;;; which is one more than the shift amount sought.
1522;;;
1523;;; Note: This is exactly the same as one less than the
1524;;; integer-length of the last digit subtracted from the
1525;;; digit-size.
1526;;;
1527;;; We shift y to make it sufficiently large that doing the
1528;;; 2*digit-size by digit-size %FLOOR calls ensures the quotient and
1529;;; remainder fit in digit-size.
1530(defun shift-y-for-truncate (y)
1531  (the fixnum (1- (the fixnum (%bignum-sign-bits y)))))
1532
1533;;; Stores two bignums into the truncation bignum buffers,
1534;;; shifting them on the way in. This assumes x and y are
1535;;; positive and at least two in length, and it assumes
1536;;; truncate-x and truncate-y are one digit longer than x and
1537;;; y.
1538(defun shift-and-store-truncate-buffers (truncate-x truncate-y x len-x y len-y shift)
1539  (declare (type bignum-index len-x len-y)
1540           (type (integer 0 (#.digit-size)) shift))
1541  (cond ((zerop shift)
1542         (bignum-replace truncate-x x :end1 len-x)
1543         (bignum-replace truncate-y y :end1 len-y))
1544        (t
1545         (bignum-ashift-left-unaligned x 0 shift (1+ len-x)
1546                                       truncate-x)
1547         (bignum-ashift-left-unaligned y 0 shift (1+ len-y)
1548                                       truncate-y))))
1549
1550;;; Divide TRUNCATE-X by TRUNCATE-Y, returning the quotient
1551;;; and destructively modifying TRUNCATE-X so that it holds
1552;;; the remainder.
1553;;;
1554;;; LEN-X and LEN-Y tell us how much of the buffers we care about.
1555;;;
1556;;; TRUNCATE-X definitely has at least three digits, and it has one
1557;;; more than TRUNCATE-Y. This keeps i, i-1, i-2, and low-x-digit
1558;;; happy. Thanks to SHIFT-AND-STORE-TRUNCATE-BUFFERS.
1559
1560(defun do-truncate (truncate-x truncate-y len-x len-y)
1561  (declare (type bignum-index len-x len-y))
1562  (let* ((len-q (- len-x len-y))
1563         ;; Add one for extra sign digit in case high bit is on.
1564         (q (%allocate-bignum (1+ len-q)))
1565         (k (1- len-q))
1566         (y1 (bignum-ref truncate-y (1- len-y)))
1567         (y2 (bignum-ref truncate-y (- len-y 2)))
1568         (i (1- len-x))
1569         (i-1 (1- i))
1570         (i-2 (1- i-1))
1571         (low-x-digit (- i len-y)))
1572    (declare (type bignum-index len-q k i i-1 i-2 low-x-digit)
1573             (type bignum-element-type y1 y2))
1574    (loop
1575      (setf (bignum-ref q k)
1576            (try-bignum-truncate-guess
1577             truncate-x truncate-y
1578             ;; This modifies TRUNCATE-X. Must access
1579             ;; elements each pass.
1580             (bignum-truncate-guess y1 y2
1581                                    (bignum-ref truncate-x i)
1582                                    (bignum-ref truncate-x i-1)
1583                                    (bignum-ref truncate-x i-2))
1584             len-y low-x-digit))
1585      (cond ((zerop k) (return))
1586            (t (decf k)
1587               (decf low-x-digit)
1588               (shiftf i i-1 i-2 (1- i-2)))))
1589    q))
1590
1591#+notyet
1592(defun do-truncate-no-quo (truncate-x truncate-y len-x len-y)
1593  (declare (type bignum-index len-x len-y))
1594  (let* ((len-q (- len-x len-y))
1595         (k (1- len-q))
1596         (i (1- len-x))
1597         (low-x-digit (- i len-y)))
1598    (declare (type bignum-index len-q k i  low-x-digit))
1599    (loop
1600      (let* ((guess (bignum-truncate-guess truncate-x i truncate-y (the fixnum (1- len-y)))                                 
1601        (try-bignum-truncate-guess guess len-y low-x-digit)
1602        (cond ((zerop k) (return))
1603              (t (decf k)
1604                 (decf low-x-digit)
1605                 (setq i (1- i))))))
1606    nil))))
1607
1608;;; This takes a digit guess, multiplies it by TRUNCATE-Y for a
1609;;; result one greater in length than LEN-Y, and subtracts this result
1610;;; from TRUNCATE-X. LOW-X-DIGIT is the first digit of X to start
1611;;; the subtraction, and we know X is long enough to subtract a LEN-Y
1612;;; plus one length bignum from it. Next we check the result of the
1613;;; subtraction, and if the high digit in X became negative, then our
1614;;; guess was one too big. In this case, return one less than GUESS
1615;;; passed in, and add one value of Y back into X to account for
1616;;; subtracting one too many. Knuth shows that the guess is wrong on
1617;;; the order of 3/b, where b is the base (2 to the digit-size power)
1618;;; -- pretty rarely.
1619
1620(defun try-bignum-truncate-guess (truncate-x truncate-y guess len-y low-x-digit)
1621  (declare (type bignum-index low-x-digit len-y)
1622           (type bignum-element-type guess))
1623  (let ((carry-digit 0)
1624        (borrow 1)
1625        (i low-x-digit))
1626    (declare (type bignum-element-type carry-digit)
1627             (type bignum-index i)
1628             (fixnum borrow))
1629    ;; Multiply guess and divisor, subtracting from dividend
1630    ;; simultaneously.
1631    (dotimes (j len-y)
1632      (multiple-value-bind (high-digit low-digit)
1633          (%multiply-and-add3 guess
1634                              (bignum-ref truncate-y j)
1635                              carry-digit)
1636        (declare (type bignum-element-type high-digit low-digit))
1637        (setf carry-digit high-digit)
1638        (multiple-value-bind (x temp-borrow)
1639            (%subtract-with-borrow (bignum-ref truncate-x i)
1640                                   low-digit
1641                                   borrow)
1642          (declare (type bignum-element-type x)
1643                   (fixnum temp-borrow))
1644          (setf (bignum-ref truncate-x i) x)
1645          (setf borrow temp-borrow)))
1646      (incf i))
1647    (setf (bignum-ref truncate-x i)
1648          (%subtract-with-borrow (bignum-ref truncate-x i)
1649                                 carry-digit borrow))
1650    ;; See whether guess is off by one, adding one
1651    ;; Y back in if necessary.
1652    (cond ((%digit-0-or-plusp (bignum-ref truncate-x i))
1653           guess)
1654          (t
1655           ;; If subtraction has negative result, add one
1656           ;; divisor value back in. The guess was one too
1657           ;; large in magnitude.
1658           (let ((i low-x-digit)
1659                 (carry 0))
1660             (dotimes (j len-y)
1661               (multiple-value-bind (v k)
1662                   (%add-with-carry (bignum-ref truncate-y j)
1663                                    (bignum-ref truncate-x i)
1664                                    carry)
1665                 (declare (type bignum-element-type v))
1666                 (setf (bignum-ref truncate-x i) v)
1667                 (setf carry k))
1668               (incf i))
1669             (setf (bignum-ref truncate-x i)
1670                   (%add-with-carry (bignum-ref truncate-x i)
1671                                    0 carry)))
1672           (%subtract-with-borrow guess 1 1)))))
1673
1674;;; Someone (from the original CMUCL or SPICE Lisp project, perhaps)
1675;;; is the "I" who implemented the original version of this.
1676
1677;;; This is the original sketch of the algorithm from which I implemented this
1678;;; TRUNCATE, assuming both operands are bignums. I should modify this to work
1679;;; with the documentation on my functions, as a general introduction. I've
1680;;; left this here just in case someone needs it in the future. Don't look at
1681;;; this unless reading the functions' comments leaves you at a loss. Remember
1682;;; this comes from Knuth, so the book might give you the right general
1683;;; overview.
1684;;;
1685;;; (truncate x y):
1686;;;
1687;;; If X's magnitude is less than Y's, then result is 0 with remainder X.
1688;;;
1689;;; Make x and y positive, copying x if it is already positive.
1690;;;
1691;;; Shift y left until there's a 1 in the 30'th bit (most significant, non-sign
1692;;;       digit)
1693;;;    Just do most sig digit to determine how much to shift whole number.
1694;;; Shift x this much too.
1695;;; Remember this initial shift count.
1696;;;
1697;;; Allocate q to be len-x minus len-y quantity plus 1.
1698;;;
1699;;; i = last digit of x.
1700;;; k = last digit of q.
1701;;;
1702;;; LOOP
1703;;;
1704;;; j = last digit of y.
1705;;;
1706;;; compute guess.
1707;;; if x[i] = y[j] then g = (1- (ash 1 digit-size))
1708;;; else g = x[i]x[i-1]/y[j].
1709;;;
1710;;; check guess.
1711;;; %UNSIGNED-MULTIPLY returns b and c defined below.
1712;;;    a = x[i-1] - (logand (* g y[j]) #xFFFFFFFF).
1713;;;       Use %UNSIGNED-MULTIPLY taking low-order result.
1714;;;    b = (logand (ash (* g y[j-1]) (- digit-size)) (1- (ash 1 digit-size))).
1715;;;    c = (logand (* g y[j-1]) (1- (ash 1 digit-size))).
1716;;; if a < b, okay.
1717;;; if a > b, guess is too high
1718;;;    g = g - 1; go back to "check guess".
1719;;; if a = b and c > x[i-2], guess is too high
1720;;;    g = g - 1; go back to "check guess".
1721;;; GUESS IS 32-BIT NUMBER, SO USE THING TO KEEP IN SPECIAL REGISTER
1722;;; SAME FOR A, B, AND C.
1723;;;
1724;;; Subtract g * y from x[i - len-y+1]..x[i]. See paper for doing this in step.
1725;;; If x[i] < 0, guess is screwed up.
1726;;;    negative g, then add 1
1727;;;    zero or positive g, then subtract 1
1728;;; AND add y back into x[len-y+1..i].
1729;;;
1730;;; q[k] = g.
1731;;; i = i - 1.
1732;;; k = k - 1.
1733;;;
1734;;; If k>=0, goto LOOP.
1735;;;
1736;;; Now quotient is good, but remainder is not.
1737;;; Shift x right by saved initial left shifting count.
1738;;;
1739;;; Check quotient and remainder signs.
1740;;; x pos y pos --> q pos r pos
1741;;; x pos y neg --> q neg r pos
1742;;; x neg y pos --> q neg r neg
1743;;; x neg y neg --> q pos r neg
1744;;;
1745;;; Normalize quotient and remainder. Cons result if necessary.
1746
1747
1748(defun bignum-truncate (x y &optional no-rem)
1749  (declare (type bignum-type x y))
1750  (DECLARE (IGNORE NO-REM))
1751  ;; Divide X by Y returning the quotient and remainder. In the
1752  ;; general case, we shift Y to set up for the algorithm, and we
1753  ;; use two buffers to save consing intermediate values. X gets
1754  ;; destructively modified to become the remainder, and we have
1755  ;; to shift it to account for the initial Y shift. After we
1756  ;; multiple bind q and r, we first fix up the signs and then
1757  ;; return the normalized results.
1758  (let* ((x-plusp (%bignum-0-or-plusp x (%bignum-length x)))
1759         (y-plusp (%bignum-0-or-plusp y (%bignum-length y)))
1760         (x (if x-plusp x (negate-bignum x nil)))
1761         (y (if y-plusp y (negate-bignum y nil)))
1762         (len-x (%bignum-length x))
1763         (len-y (%bignum-length y)))
1764    (multiple-value-bind (q r)
1765        (cond ((< len-y 2)
1766               (bignum-truncate-single-digit x len-x y))
1767              ((plusp (bignum-compare y x))
1768               (let ((res (%allocate-bignum len-x)))
1769                 (dotimes (i len-x)
1770                   (setf (bignum-ref res i) (bignum-ref x i)))
1771                 (values 0 res)))
1772              (t
1773               (let ((len-x+1 (1+ len-x)))
1774                 (with-bignum-buffers ((truncate-x len-x+1)
1775                                       (truncate-y (1+ len-y)))
1776                   (let ((y-shift (shift-y-for-truncate y)))
1777                     (shift-and-store-truncate-buffers truncate-x
1778                                                       truncate-y
1779                                                       x len-x
1780                                                       y len-y
1781                                                       y-shift)
1782                     (values
1783                      (do-truncate truncate-x
1784                        truncate-y
1785                        len-x+1
1786                        len-y)
1787                      ;; Now DO-TRUNCATE has executed, we just
1788                      ;; tidy up the remainder (in TRUNCATE-X)
1789                      ;; and return it.
1790                      (cond
1791                        ((zerop y-shift)
1792                         (let ((res (%allocate-bignum len-y)))
1793                           (declare (type bignum-type res))
1794                           (bignum-replace res truncate-x :end2 len-y)
1795                           (%normalize-bignum-macro res)))
1796                        (t
1797                         (shift-right-unaligned
1798                          truncate-x 0 y-shift len-y
1799                          ((= j res-len-1)
1800                           (setf (bignum-ref res j)
1801                                 (%ashr (bignum-ref truncate-x i)
1802                                        y-shift))
1803                           (%normalize-bignum-macro res))
1804                          res)))))))))
1805      (let ((quotient (cond ((eq x-plusp y-plusp) q)
1806                            ((typep q 'fixnum) (the fixnum (- q)))
1807                            (t (negate-bignum-in-place q))))
1808            (rem (cond (x-plusp r)
1809                       ((typep r 'fixnum) (the fixnum (- r)))
1810                       (t (negate-bignum-in-place r)))))
1811        (values (if (typep quotient 'fixnum)
1812                  quotient
1813                  (%normalize-bignum-macro quotient))
1814                (if (typep rem 'fixnum)
1815                  rem
1816                  (%normalize-bignum-macro rem)))))))
1817
1818(defun bignum-truncate-by-fixnum (bignum fixnum)
1819  (with-small-bignum-buffers ((y fixnum))
1820    (bignum-truncate bignum y)))
1821
1822(defun bignum-truncate-by-fixnum-no-quo (bignum fixnum)
1823  (nth-value 1 (bignum-truncate-by-fixnum bignum fixnum)))
1824
1825;;; This may do unnecessary computation in some cases.
1826(defun bignum-rem (x y)
1827  (nth-value 1 (bignum-truncate x y)))
1828
1829
1830
1831;;;; General utilities.
1832
1833(defun %zero-trailing-sign-digits (bignum len)
1834  (declare (fixnum len))
1835  (unless (<= len 1)
1836    (do ((next (bignum-ref bignum (the fixnum (- len 2)))
1837               (bignum-ref bignum (the fixnum (- len 2))))
1838         (sign (bignum-ref bignum (the fixnum (- len 1)))
1839               next))
1840        ((not (zerop (the fixnum (%logxor sign (%ashr next 31))))))
1841      (decf len)
1842      (setf (bignum-ref bignum len) 0)
1843      ;; Return, unless we've already done so (having found significant
1844      ;; digits earlier.)
1845      (when (= len 1)
1846        (return))))
1847  len)
1848
1849
1850(defun %normalize-bignum-2 (return-fixnum-p bignum)
1851  (let* ((len (%bignum-length bignum))
1852         (newlen (%zero-trailing-sign-digits bignum len)))
1853    (declare (fixnum len newlen))
1854    (unless (= len newlen)
1855      (%set-bignum-length newlen bignum))
1856    (or (and return-fixnum-p
1857             (%maybe-fixnum-from-one-or-two-digit-bignum bignum))
1858        bignum)))
1859           
1860   
1861;;; %MOSTLY-NORMALIZE-BIGNUM -- Internal.
1862;;;
1863;;; This drops the last digit if it is unnecessary sign information.  It
1864;;; repeats this as needed, possibly ending with a fixnum magnitude but never
1865;;; returning a fixnum.
1866;;;
1867
1868(defun %mostly-normalize-bignum (res &optional len)
1869  (declare (ignore len))
1870  (%normalize-bignum-2 nil res))
1871
1872
1873
1874
1875
1876(defun load-byte (size position integer)
1877  (if (and (bignump integer)
1878           (<= size (- 63 target::fixnumshift))
1879           (fixnump position))
1880    (%ldb-fixnum-from-bignum integer size position)
1881    (let ((mask (byte-mask size)))
1882      (if (and (fixnump mask) (fixnump integer)(fixnump position))
1883        (%ilogand mask (%iasr position integer))
1884        (logand mask (ash integer (- position)))))))
1885
1886
1887#+safe-but-slow
1888;;; This is basically the same algorithm as the "destructive"
1889;;; version below; while it may be more readable, it's often
1890;;; slower and conses too much to be at all viable.
1891(defun %bignum-bignum-gcd (u v)
1892  (setq u (abs u) v (abs v))
1893  (do* ((g 1 (ash g 1)))
1894       ((or (oddp u) (oddp v))
1895        (do* ()
1896             ((zerop u) (* g v))
1897          (cond ((evenp u) (setq u (ash u -1)))
1898                ((evenp v) (setq v (ash v -1)))
1899                (t (let* ((temp (ash (abs (- u v)) -1)))
1900                     (if (< u v)
1901                       (setq v temp)
1902                       (setq u temp)))))))
1903    (setq u (ash u -1) v (ash v -1))))
1904
1905
1906
1907
1908#-safe-but-slow
1909(progn
1910(defun %positive-bignum-bignum-gcd (u0 v0)
1911  (let* ((u-len (%bignum-length u0))
1912         (v-len (%bignum-length v0)))
1913    (declare (fixnum u-len v-len))
1914    (if (or (< u-len v-len)
1915            (and (= u-len v-len)
1916                 (< (bignum-compare u0 v0) 0)))
1917      (psetq u0 v0 v0 u0 u-len v-len v-len u-len))
1918    (with-bignum-buffers ((u u-len)
1919                          (u2 u-len)
1920                          (v v-len)
1921                          (v2 v-len))
1922      (bignum-replace u u0)
1923      (bignum-replace v v0)
1924      (let* ((u-trailing-0-bits (%bignum-count-trailing-zero-bits u))
1925             (u-trailing-0-digits (ash u-trailing-0-bits -5))
1926             (v-trailing-0-bits (%bignum-count-trailing-zero-bits v))
1927             (v-trailing-0-digits (ash v-trailing-0-bits -5)))
1928        (declare (fixnum u-trailing-0-bits v-trailing-0-bits))
1929        (unless (zerop u-trailing-0-bits)
1930          (bignum-shift-right-loop-1
1931           (logand u-trailing-0-bits 31)
1932           u2
1933           u
1934           (the fixnum (1- (the fixnum (- u-len u-trailing-0-digits ))))
1935           u-trailing-0-digits)
1936          (rotatef u u2)
1937          (%mostly-normalize-bignum-macro u)
1938          (setq u-len (%bignum-length u)))
1939        (unless (zerop v-trailing-0-bits)
1940          (bignum-shift-right-loop-1
1941           (logand v-trailing-0-bits 31)
1942           v2
1943           v
1944           (the fixnum (1- (the fixnum (- v-len v-trailing-0-digits))))
1945           v-trailing-0-digits)
1946          (rotatef v v2)
1947          (%mostly-normalize-bignum-macro v)
1948          (setq v-len (%bignum-length v)))
1949        (let* ((shift (min u-trailing-0-bits
1950                           v-trailing-0-bits)))
1951          (loop
1952              (let* ((fix-u (and (<= u-len 2)
1953                                 (%maybe-fixnum-from-one-or-two-digit-bignum u)))
1954                     (fix-v (and (<= v-len 2)
1955                                 (%maybe-fixnum-from-one-or-two-digit-bignum v))))
1956                (if fix-v
1957                  (if fix-u
1958                    (return (ash (%fixnum-gcd fix-u fix-v) shift))
1959                    (return (ash (bignum-fixnum-gcd u fix-v) shift)))
1960                  (if fix-u
1961                    (return (ash (bignum-fixnum-gcd v fix-u) shift)))))
1962              (let* ((signum (if (> u-len v-len)
1963                               1
1964                               (if (< u-len v-len)
1965                                 -1
1966                                 (bignum-compare u v)))))
1967                (declare (fixnum signum))
1968                (case signum
1969                  (0                    ; (= u v)
1970                   (if (zerop shift)
1971                     (let* ((copy (%allocate-bignum u-len)))
1972                       (bignum-replace copy u)
1973                       (return copy))
1974                     (return (ash u shift))))
1975                  (1                    ; (> u v)
1976                   (bignum-subtract-loop u u-len v v-len u)
1977                   (%mostly-normalize-bignum-macro u)
1978                   (setq u-len (%bignum-length u))
1979                   (setq u-trailing-0-bits
1980                         (%bignum-count-trailing-zero-bits u)
1981                         u-trailing-0-digits
1982                         (ash u-trailing-0-bits -5))
1983                   (unless (zerop u-trailing-0-bits)
1984                     (%init-misc 0 u2)
1985                     (bignum-shift-right-loop-1
1986                      (logand u-trailing-0-bits 31)
1987                      u2
1988                      u
1989                      (the fixnum (1- (the fixnum (- u-len
1990                                                     u-trailing-0-digits))))
1991                      u-trailing-0-digits)
1992                     (rotatef u u2)
1993                     (%mostly-normalize-bignum-macro u)
1994                     (setq u-len (%bignum-length u))))
1995                  (t                    ; (> v u)
1996                   (bignum-subtract-loop v v-len u u-len v)
1997                   (%mostly-normalize-bignum-macro v)
1998                   (setq v-len (%bignum-length v))
1999                   (setq v-trailing-0-bits
2000                         (%bignum-count-trailing-zero-bits v)
2001                         v-trailing-0-digits
2002                         (ash v-trailing-0-bits -5))
2003                   (unless (zerop v-trailing-0-bits)
2004                     (%init-misc 0 v2)
2005                     (bignum-shift-right-loop-1
2006                      (logand v-trailing-0-bits 31)
2007                      v2
2008                      v
2009                      (the fixnum (1- (the fixnum (- v-len v-trailing-0-digits))))
2010                      v-trailing-0-digits)
2011                     (rotatef v v2)
2012                     (%mostly-normalize-bignum-macro v)
2013                     (setq v-len (%bignum-length v))))))))))))
2014
2015(defun %bignum-bignum-gcd (u v)
2016  (with-negated-bignum-buffers u v %positive-bignum-bignum-gcd))
2017)
2018
2019
2020(defun bignum-shift-right-loop-1 (nbits result source len idx)
2021  (declare (type bignum-type result source)
2022           (type (mod 32) nbits)
2023           (type bignum-index idx len))
2024  (let* ((rbits (- 32 nbits)))
2025    (declare (type (mod 33) rbits))
2026    (dotimes (j len)
2027      (let* ((x (bignum-ref source idx)))
2028        (declare (type bignum-element-type x))
2029        (setq x (%ilsr nbits x))
2030        (incf idx)
2031        (let* ((y (bignum-ref source idx)))
2032          (declare (type bignum-element-type y))
2033          (setq y (%ashl y rbits))
2034          (setf (bignum-ref result j)
2035                (%logior x y)))))
2036    (setf (bignum-ref result len)
2037          (%ilsr nbits (bignum-ref source idx)))
2038    idx))
2039   
2040
2041(defun %logcount (bignum idx)
2042  (%ilogcount (bignum-ref bignum idx)))
2043
2044(defun %logcount-complement (bignum idx)
2045  (- 32 (the fixnum (%ilogcount (bignum-ref bignum idx)))))
2046
2047(defun %bignum-evenp (bignum)
2048  (not (logbitp 0 (the fixnum (bignum-ref bignum 0)))))
2049
2050(defun %bignum-oddp (bignum)
2051  (logbitp 0 (the fixnum (bignum-ref bignum 0))))
2052
2053(defun %ldb-fixnum-from-bignum (bignum size position)
2054  (declare (fixnum size position))
2055  (let* ((low-idx (ash position -5))
2056         (low-bit (logand position 31))
2057         (hi-bit (+ low-bit size))
2058         (len (%bignum-length bignum))
2059         (minusp (bignum-minusp bignum)))
2060    (declare (fixnum size position low-bit hi-bit low-idx len))
2061    (if (>= low-idx len)
2062      (if minusp (1- (ash 1 size)) 0)
2063      (flet ((ldb32 (digit size pos)
2064               (declare (fixnum digit size pos))
2065               (logand (the fixnum (1- (ash 1 size)))
2066                       (the fixnum (ash digit (the fixnum (- pos)))))))
2067        (let* ((low-digit (bignum-ref bignum low-idx))
2068               (chunk-lo (ldb32 low-digit (min size (%i- 32 low-bit)) low-bit)))
2069          (if (< hi-bit 32) 
2070            chunk-lo
2071            (let* ((have (- 32 low-bit))
2072                   (remain (- size have)))
2073              (declare (fixnum have remain))
2074              (setq low-idx (1+ low-idx))
2075              (when (> remain 32)
2076                (setq chunk-lo
2077                      (logior (ash (if (< low-idx len)
2078                                     (bignum-ref bignum low-idx)
2079                                     (if minusp all-ones-digit 0))
2080                                   have)
2081                              chunk-lo))
2082                (incf have 32)
2083                (decf remain 32)
2084                (incf low-idx))
2085              (let* ((high-digit
2086                      (if (>= low-idx len)
2087                        (if minusp all-ones-digit 0)
2088                        (bignum-ref bignum low-idx)))
2089                     (chunk-hi (ldb32 high-digit remain 0)))
2090                (%ilogior (ash chunk-hi have) chunk-lo)))))))))
2091
2092
2093
2094(defun bignum-negate-loop-really (big len res)
2095  (declare (fixnum len))
2096  (let* ((carry 1))
2097    (dotimes (i len carry)
2098      (multiple-value-bind (result-digit carry-out)
2099          (%add-with-carry (%lognot (bignum-ref big i)) 0 carry)
2100        (setf (bignum-ref res i) result-digit
2101              carry carry-out)))))
2102
2103(defun bignum-negate-to-pointer (big len res)
2104  (declare (fixnum len))
2105  (let* ((carry 1))
2106    (do* ((i 0 (1+ i))
2107          (j 0 (+ j 4)))
2108         ((= i len) carry)
2109      (declare (fixnum i))
2110      (multiple-value-bind (result-digit carry-out)
2111          (%add-with-carry (%lognot (bignum-ref big i)) 0 carry)
2112        (setf (%get-unsigned-long res j) result-digit
2113              carry carry-out)))))
2114 
2115
2116(defun %bignum-count-trailing-zero-bits (bignum)
2117  (let* ((count 0))
2118    (dotimes (i (%bignum-length bignum))
2119      (let* ((digit (bignum-ref bignum i)))
2120        (declare (type bignum-element-type digit))
2121        (if (zerop digit)
2122          (incf count 32)
2123          (progn
2124            (dotimes (bit 32)
2125              (declare (type (mod 32) bit))
2126              (if (logbitp bit digit)
2127                (return)
2128                (incf count)))
2129            (return)))))
2130    count))
2131                 
2132
2133(defun one-bignum-factor-of-two (a) 
2134  (declare (type bignum-type a))
2135  (let ((len (%bignum-length a)))
2136    (declare (fixnum len))
2137    (dotimes (i len)
2138      (let* ((x (bignum-ref a i)))
2139        (declare (fixnum x))
2140        (unless (zerop x)
2141          (return (+ (ash i 5)
2142                     (dotimes (j 32)
2143                       (if (logbitp j x)
2144                         (return j))))))))))
2145
2146
2147(defun %bignum-random (number state)
2148  (let* ((ndigits (%bignum-length number))
2149         (sign-index (1- ndigits)))
2150    (declare (fixnum ndigits sign-index))
2151    (with-bignum-buffers ((bignum ndigits))
2152      (dotimes (i sign-index)
2153        (setf (bignum-ref bignum i) (%next-random-seed state)))
2154      (setf (bignum-ref bignum sign-index)
2155            (logand #x7fffffff (the (unsigned-byte 32)
2156                                 (%next-random-seed state))))
2157      (let* ((result (mod bignum number)))
2158        (if (eq result bignum)
2159          (copy-uvector bignum)
2160          result)))))
2161
2162
2163
2164(defun logbitp (index integer)
2165  "Predicate returns T if bit index of integer is a 1."
2166  (number-case index
2167    (fixnum
2168     (if (minusp (the fixnum index))(report-bad-arg index '(integer 0))))
2169    (bignum
2170     ;; assuming bignum cant have more than most-positive-fixnum bits
2171     ;; (2 expt 24 longs)
2172     (if (bignum-minusp index)(report-bad-arg index '(integer 0)))
2173     ;; should error if integer isn't
2174     (return-from logbitp (minusp (require-type integer 'integer)))))
2175  (number-case integer
2176    (fixnum
2177     (if (%i< index (- target::nbits-in-word target::fixnumshift))
2178       (%ilogbitp index integer)
2179       (minusp (the fixnum integer))))
2180    (bignum
2181     (let ((bidx (%iasr 5 index))
2182           (bbit (%ilogand index 31)))
2183       (declare (fixnum bidx bbit))
2184       (if (>= bidx (%bignum-length integer))
2185         (bignum-minusp integer)
2186         (logbitp bbit (bignum-ref integer bidx)))))))
2187
2188) ; #+64-bit-target
Note: See TracBrowser for help on using the repository browser.