Debian Codegraph @

mini-gmp/README

raw
1 Copyright 2011-2013, 2018 Free Software Foundation, Inc.
2
3 This file is part of the GNU MP Library.
4
5 The GNU MP Library is free software; you can redistribute it and/or modify
6 it under the terms of either:
7
8 * the GNU Lesser General Public License as published by the Free
9 Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11
12 or
13
14 * the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any
16 later version.
17
18 or both in parallel, as here.
19
20 The GNU MP Library is distributed in the hope that it will be useful, but
21 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
22 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23 for more details.
24
25 You should have received copies of the GNU General Public License and the
26 GNU Lesser General Public License along with the GNU MP Library. If not,
27 see https://www.gnu.org/licenses/.
28
29
30 This is "mini-gmp", a small implementation of a subset of GMP's mpn,
31 mpz and mpq interfaces.
32
33 It is intended for applications which need arithmetic on numbers
34 larger than a machine word, but which don't need to handle very large
35 numbers very efficiently. Those applications can include a copy of
36 mini-gmp to get a GMP-compatible interface with small footprint. One
37 can also arrange for optional linking with the real GMP library, using
38 mini-gmp as a fallback when for some reason GMP is not available, or
39 not desired as a dependency.
40
41 The supported GMP subset of the mpn and mpz interfaces is declared in
42 mini-gmp.h, and implemented in mini-gmp.c. The implemented
43 functions are fully compatible with the corresponding GMP functions,
44 as specified in the GMP manual, with a few exceptions:
45
46 mpz_export and mpz_import support only NAILS = 0.
47
48 The performance target for mini-gmp is to be at most 10 times slower
49 than the real GMP library, for numbers of size up to a few hundred
50 bits. No asymptotically fast algorithms are included in mini-gmp, so
51 it will be many orders of magnitude slower than GMP for very large
52 numbers.
53
54 The supported GMP subset of the mpq layer is declared in mini-mpq.h,
55 and implemented in mini-mpq.c.
56
57 You should never "install" mini-gmp. Applications can either just
58 #include mini-gmp.c (but then, beware that it defines several macros
59 and functions outside of the advertised interface), and if needed
60 #include mini-mpq.c in a later line (order is important). Or compile
61 mini-gmp.c and mini-mpq.c as separate compilation units, and use the
62 declarations in mini-gmp.h and mini-mpq.h.
63
64 The tests subdirectory contains a testsuite. To use it, you need GMP
65 and GNU make. Just run make check in the tests directory. If the
66 hard-coded compiler settings are not right, you have to either edit the
67 Makefile or pass overriding values on the make command line (e.g.,
68 make CC=cc check).
69
70 The initial version of mini-gmp was put together by Niels Möller
71 <[email protected]>, with a fair amount of copy-and-paste from the
72 GMP sources.