initially checkin
[gnupg.git] / mpi / mpi-div.c
1 /* mpi-div.c  -  MPI functions
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * G10 is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include "mpi-internal.h"
25 #include "longlong.h"
26
27
28
29 void
30 mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor )
31 {
32     int divisor_sign = divisor->sign;
33     MPI temp_divisor = NULL;
34
35     /* We need the original value of the divisor after the remainder has been
36      * preliminary calculated.  We have to copy it to temporary space if it's
37      * the same variable as REM.  */
38     if( rem == divisor ) {
39         temp_divisor = mpi_copy( divisor );
40         divisor = temp_divisor;
41     }
42
43     mpi_tdiv_r( rem, dividend, divisor );
44
45     if( ((divisor_sign?1:0) ^ (dividend->sign?1:0)) && rem->nlimbs )
46         mpi_add( rem, rem, divisor);
47
48     if( temp_divisor )
49         mpi_free(temp_divisor);
50 }
51
52
53
54 /****************
55  * Division rounding the quotient towards -infinity.
56  * The remainder gets the same sign as the denominator.
57  * rem is optional
58  */
59
60 ulong
61 mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor )
62 {
63     mpi_limb_t rlimb;
64
65     rlimb = mpihelp_mod_1( dividend->d, dividend->nlimbs, divisor );
66     if( rlimb && dividend->sign )
67         rlimb = divisor - rlimb;
68
69     if( rem ) {
70         rem->d[0] = rlimb;
71         rem->nlimbs = rlimb? 1:0;
72     }
73     return rlimb;
74 }
75
76
77 void
78 mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor )
79 {
80     MPI tmp = mpi_alloc( mpi_get_nlimbs(quot) );
81     mpi_fdiv_qr( quot, tmp, dividend, divisor);
82     mpi_free(tmp);
83 }
84
85 void
86 mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor )
87 {
88     int divisor_sign = divisor->sign;
89     MPI temp_divisor = NULL;
90
91     if( quot == divisor || rem == divisor ) {
92         temp_divisor = mpi_copy( divisor );
93         divisor = temp_divisor;
94     }
95
96     mpi_tdiv_qr( quot, rem, dividend, divisor );
97
98     if( (divisor_sign ^ dividend->sign) && rem->nlimbs ) {
99         mpi_sub_ui( quot, quot, 1 );
100         mpi_add( rem, rem, divisor);
101     }
102
103     if( temp_divisor )
104         mpi_free(temp_divisor);
105 }
106
107
108 /* If den == quot, den needs temporary storage.
109  * If den == rem, den needs temporary storage.
110  * If num == quot, num needs temporary storage.
111  * If den has temporary storage, it can be normalized while being copied,
112  *   i.e no extra storage should be allocated.
113  */
114
115 void
116 mpi_tdiv_r( MPI rem, MPI num, MPI den)
117 {
118     mpi_tdiv_qr(NULL, rem, num, den );
119 }
120
121 void
122 mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den)
123 {
124     mpi_ptr_t np, dp;
125     mpi_ptr_t qp, rp;
126     mpi_size_t nsize = num->nlimbs;
127     mpi_size_t dsize = den->nlimbs;
128     mpi_size_t qsize, rsize;
129     mpi_size_t sign_remainder = num->sign;
130     mpi_size_t sign_quotient = num->sign ^ den->sign;
131     unsigned normalization_steps;
132     mpi_limb_t q_limb;
133     mpi_ptr_t marker[5];
134     int markidx=0;
135
136     /* Ensure space is enough for quotient and remainder.
137      * We need space for an extra limb in the remainder, because it's
138      * up-shifted (normalized) below.  */
139     rsize = nsize + 1;
140     if( rem->alloced < rsize )
141         mpi_resize( rem, rsize);
142
143     qsize = rsize - dsize;        /* qsize cannot be bigger than this.  */
144     if( qsize <= 0 ) {
145         if( num != rem ) {
146             rem->nlimbs = num->nlimbs;
147             rem->sign = num->sign;
148             MPN_COPY(rem->d, num->d, nsize);
149         }
150         if( quot ) {
151             /* This needs to follow the assignment to rem, in case the
152              * numerator and quotient are the same.  */
153             quot->nlimbs = 0;
154             quot->sign = 0;
155         }
156         return;
157     }
158
159     if( quot && quot->alloced < qsize )
160         mpi_resize( quot, qsize);
161
162     /* Read pointers here, when reallocation is finished.  */
163     np = num->d;
164     dp = den->d;
165     rp = rem->d;
166
167     /* Optimize division by a single-limb divisor.  */
168     if( dsize == 1 ) {
169         mpi_limb_t rlimb;
170         if( quot ) {
171             qp = quot->d;
172             rlimb = mpihelp_divmod_1( qp, np, nsize, dp[0] );
173             qsize -= qp[qsize - 1] == 0;
174             quot->nlimbs = qsize;
175             quot->sign = sign_quotient;
176         }
177         else
178             rlimb = mpihelp_mod_1( np, nsize, dp[0] );
179         rp[0] = rlimb;
180         rsize = rlimb != 0?1:0;
181         rem->nlimbs = rsize;
182         rem->sign = sign_remainder;
183         return;
184     }
185
186
187     if( quot ) {
188         qp = quot->d;
189         /* Make sure QP and NP point to different objects.  Otherwise the
190          * numerator would be gradually overwritten by the quotient limbs.  */
191         if(qp == np) { /* Copy NP object to temporary space.  */
192             np = marker[markidx++] = mpi_alloc_limb_space(nsize);
193             MPN_COPY(np, qp, nsize);
194         }
195     }
196     else /* Put quotient at top of remainder. */
197         qp = rp + dsize;
198
199     count_leading_zeros( normalization_steps, dp[dsize - 1] );
200
201     /* Normalize the denominator, i.e. make its most significant bit set by
202      * shifting it NORMALIZATION_STEPS bits to the left.  Also shift the
203      * numerator the same number of steps (to keep the quotient the same!).
204      */
205     if( normalization_steps ) {
206         mpi_ptr_t tp;
207         mpi_limb_t nlimb;
208
209         /* Shift up the denominator setting the most significant bit of
210          * the most significant word.  Use temporary storage not to clobber
211          * the original contents of the denominator.  */
212         tp = marker[markidx++] = mpi_alloc_limb_space(dsize);
213         mpihelp_lshift( tp, dp, dsize, normalization_steps );
214         dp = tp;
215
216         /* Shift up the numerator, possibly introducing a new most
217          * significant word.  Move the shifted numerator in the remainder
218          * meanwhile.  */
219         nlimb = mpihelp_lshift(rp, np, nsize, normalization_steps);
220         if( nlimb ) {
221             rp[nsize] = nlimb;
222             rsize = nsize + 1;
223         }
224         else
225             rsize = nsize;
226     }
227     else {
228         /* The denominator is already normalized, as required.  Copy it to
229          * temporary space if it overlaps with the quotient or remainder.  */
230         if( dp == rp || (quot && (dp == qp))) {
231             mpi_ptr_t tp;
232
233             tp = marker[markidx++] = mpi_alloc_limb_space(dsize);
234             MPN_COPY( tp, dp, dsize );
235             dp = tp;
236         }
237
238         /* Move the numerator to the remainder.  */
239         if( rp != np )
240             MPN_COPY(rp, np, nsize);
241
242         rsize = nsize;
243     }
244
245     q_limb = mpihelp_divrem( qp, 0, rp, rsize, dp, dsize );
246
247     if( quot ) {
248         qsize = rsize - dsize;
249         if(q_limb) {
250             qp[qsize] = q_limb;
251             qsize += 1;
252         }
253
254         quot->nlimbs = qsize;
255         quot->sign = sign_quotient;
256     }
257
258     rsize = dsize;
259     MPN_NORMALIZE (rp, rsize);
260
261     if( normalization_steps && rsize ) {
262         mpihelp_rshift(rp, rp, rsize, normalization_steps);
263         rsize -= rp[rsize - 1] == 0?1:0;
264     }
265
266     rem->nlimbs = rsize;
267     rem->sign   = sign_remainder;
268     while( markidx )
269         mpi_free_limb_space(marker[--markidx]);
270 }
271
272
273 /****************
274  * Check wether dividend is divisible by divisor
275  * (note: divisor must fit into a limb)
276  */
277 int
278 mpi_divisible_ui(MPI dividend, ulong divisor )
279 {
280     return !mpihelp_mod_1( dividend->d, dividend->nlimbs, divisor );
281 }
282