"Fossies" - the Fresh Open Source Software Archive

Member "gmp-6.2.1/mini-gmp/README" (14 Nov 2020, 3344 Bytes) of package /linux/misc/gmp-6.2.1.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README": 6.1.2_vs_6.2.0.

    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 REALLOC_FUNC and FREE_FUNC registered with
   49   mp_set_memory_functions does not get the correct size of the
   50   allocated block in the corresponding argument. mini-gmp always
   51   passes zero for these rarely used arguments.
   52 
   53   When mpz_get_str allocates the block, it can be longer than needed.
   54 
   55 The performance target for mini-gmp is to be at most 10 times slower
   56 than the real GMP library, for numbers of size up to a few hundred
   57 bits. No asymptotically fast algorithms are included in mini-gmp, so
   58 it will be many orders of magnitude slower than GMP for very large
   59 numbers.
   60 
   61 The supported GMP subset of the mpq layer is declared in mini-mpq.h,
   62 and implemented in mini-mpq.c.
   63 
   64 You should never "install" mini-gmp. Applications can either just
   65 #include mini-gmp.c (but then, beware that it defines several macros
   66 and functions outside of the advertised interface), and if needed
   67 #include mini-mpq.c in a later line (order is important). Or compile
   68 mini-gmp.c and mini-mpq.c as separate compilation units, and use the
   69 declarations in mini-gmp.h and mini-mpq.h.
   70 
   71 The tests subdirectory contains a testsuite. To use it, you need GMP
   72 and GNU make. Just run make check in the tests directory. If the
   73 hard-coded compiler settings are not right, you have to either edit the
   74 Makefile or pass overriding values on the make command line (e.g.,
   75 make CC=cc check).
   76 
   77 The initial version of mini-gmp was put together by Niels Möller
   78 <nisse@lysator.liu.se>, with a fair amount of copy-and-paste from the
   79 GMP sources.