source: branches/working-0711/ccl/level-0/l0-bignum64.lisp @ 12048

Last change on this file since 12048 was 12048, checked in by gz, 11 years ago

r11876/r12026/r12045 from trunk

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