3 * $Id: mp-sqrt.c,v 1.3 2001/02/03 12:00:29 mdw Exp $
5 * Compute integer square roots
7 * (c) 2000 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.3 2001/02/03 12:00:29 mdw
34 * Now @mp_drop@ checks its argument is non-NULL before attempting to free
35 * it. Note that the macro version @MP_DROP@ doesn't do this.
37 * Revision 1.2 2000/10/08 12:02:21 mdw
38 * Use @MP_EQ@ instead of @MP_CMP@.
40 * Revision 1.1 2000/06/22 19:01:44 mdw
41 * Compute (approximations to) integer square roots.
45 /*----- Header files ------------------------------------------------------*/
49 /*----- Main code ---------------------------------------------------------*/
51 /* --- @mp_sqrt@ --- *
53 * Arguments: @mp *d@ = pointer to destination integer
54 * @mp *a@ = (nonnegative) integer to take square root of
56 * Returns: The largest integer %$x$% such that %$x^2 \le a$%.
58 * Use: Computes integer square roots.
60 * The current implementation isn't very good: it uses the
61 * Newton-Raphson method to find an approximation to %$a$%. If
62 * there's any demand for a better version, I'll write one.
65 mp
*mp_sqrt(mp
*d
, mp
*a
)
68 mp
*q
= MP_NEW
, *r
= MP_NEW
;
70 /* --- Sanity preservation --- */
72 assert(((void)"imaginary root in mp_sqrt", !(a
->f
& MP_NEG
)));
74 /* --- Deal with trivial cases --- */
82 /* --- Find an initial guess of about the right size --- */
90 /* --- Main approximation --- *
92 * We use the Newton-Raphson recurrence relation
94 * %$x_{i+1} = x_i - \frac{x_i^2 - a}{2 x_i}$%
96 * We inspect the term %$q = x^2 - a$% to see when to stop. Increasing
97 * %$x$% is pointless when %$-q < 2 x + 1$%.
108 if (MP_CMP(q
, <=, r
))
111 mp_div(&r
, &q
, q
, d
);
114 d
= mp_sub(d
, d
, MP_ONE
);
119 /* --- Finished, at last --- */
126 /*----- Test rig ----------------------------------------------------------*/
130 #include <mLib/testrig.h>
132 static int verify(dstr
*v
)
134 mp
*a
= *(mp
**)v
[0].buf
;
135 mp
*qq
= *(mp
**)v
[1].buf
;
136 mp
*q
= mp_sqrt(MP_NEW
, a
);
141 fputs("\n*** sqrt failed", stderr
);
142 fputs("\n*** a = ", stderr
); mp_writefile(a
, stderr
, 10);
143 fputs("\n*** result = ", stderr
); mp_writefile(q
, stderr
, 10);
144 fputs("\n*** expect = ", stderr
); mp_writefile(qq
, stderr
, 10);
151 assert(mparena_count(MPARENA_GLOBAL
) == 0);
156 static test_chunk tests
[] = {
157 { "sqrt", verify
, { &type_mp
, &type_mp
, 0 } },
161 int main(int argc
, char *argv
[])
164 test_run(argc
, argv
, tests
, SRCDIR
"/tests/mp");
170 /*----- That's all, folks -------------------------------------------------*/