home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gmp-2.0.2-bin.lha / info / gmp.info (.txt)
GNU Info File  |  1996-10-12  |  109KB  |  2,010 lines
  1. This is Info file gmp.info, produced by Makeinfo-1.64 from the input
  2. file /ade-src/fsf/gmp/gmp.texi.
  3. START-INFO-DIR-ENTRY
  4. * gmp: (gmp.info).               GNU Multiple Precision Arithmetic Library.
  5. END-INFO-DIR-ENTRY
  6.    This file documents GNU MP, a library for arbitrary-precision
  7. arithmetic.
  8.    Copyright (C) 1991, 1993, 1994, 1995, 1996 Free Software Foundation,
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Foundation.
  20. File: gmp.info,  Node: Top,  Next: Copying,  Prev: (dir),  Up: (dir)
  21. GNU MP
  22. ******
  23.    This manual documents how to install and use the GNU multiple
  24. precision arithmetic library, version 2.0.2.
  25. * Menu:
  26. * Copying::                   GMP Copying Conditions (LGPL).
  27. * Introduction to MP::        Brief introduction to GNU MP.
  28. * Installing MP::             How to configure and compile the MP library.
  29. * MP Basics::                 What every MP user should now.
  30. * Reporting Bugs::            How to usefully report bugs.
  31. * Integer Functions::         Functions for arithmetic on signed integers.
  32. * Rational Number Functions:: Functions for arithmetic on rational numbers.
  33. * Floating-point Functions::  Functions for arithmetic on floats.
  34. * Low-level Functions::       Fast functions for natural numbers.
  35. * BSD Compatible Functions::  All functions found in BSD MP.
  36. * Custom Allocation::         How to customize the internal allocation.
  37. * Contributors::
  38. * References::
  39. * Concept Index::
  40. * Function Index::
  41. File: gmp.info,  Node: Copying,  Next: Introduction to MP,  Prev: Top,  Up: Top
  42. GNU MP Copying Conditions
  43. *************************
  44.    This library is "free"; this means that everyone is free to use it
  45. and free to redistribute it on a free basis.  The library is not in the
  46. public domain; it is copyrighted and there are restrictions on its
  47. distribution, but these restrictions are designed to permit everything
  48. that a good cooperating citizen would want to do.  What is not allowed
  49. is to try to prevent others from further sharing any version of this
  50. library that they might get from you.
  51.    Specifically, we want to make sure that you have the right to give
  52. away copies of the library, that you receive source code or else can
  53. get it if you want it, that you can change this library or use pieces
  54. of it in new free programs, and that you know you can do these things.
  55.    To make sure that everyone has such rights, we have to forbid you to
  56. deprive anyone else of these rights.  For example, if you distribute
  57. copies of the GNU MP library, you must give the recipients all the
  58. rights that you have.  You must make sure that they, too, receive or
  59. can get the source code.  And you must tell them their rights.
  60.    Also, for our own protection, we must make certain that everyone
  61. finds out that there is no warranty for the GNU MP library.  If it is
  62. modified by someone else and passed on, we want their recipients to
  63. know that what they have is not what we distributed, so that any
  64. problems introduced by others will not reflect on our reputation.
  65.    The precise conditions of the license for the GNU MP library are
  66. found in the Library General Public License that accompany the source
  67. code.
  68. File: gmp.info,  Node: Introduction to MP,  Next: Installing MP,  Prev: Copying,  Up: Top
  69. Introduction to GNU MP
  70. **********************
  71.    GNU MP is a portable library written in C for arbitrary precision
  72. arithmetic on integers, rational numbers, and floating-point numbers.
  73. It aims to provide the fastest possible arithmetic for all applications
  74. that need higher precision than is directly supported by the basic C
  75. types.
  76.    Many applications use just a few hundred bits of precision; but some
  77. applications may need thousands or even millions of bits.  MP is
  78. designed to give good performance for both, by choosing algorithms
  79. based on the sizes of the operands, and by carefully keeping the
  80. overhead at a minimum.
  81.    The speed of MP is achieved by using fullwords as the basic
  82. arithmetic type, by using sophisticated algorithms, by including
  83. carefully optimized assembly code for the most common inner loops for
  84. many different CPUs, and by a general emphasis on speed (as opposed to
  85. simplicity or elegance).
  86.    There is carefully optimized assembly code for these CPUs: DEC
  87. Alpha, Amd 29000, HPPA 1.0 and 1.1, Intel Pentium and generic x86,
  88. Intel i960, Motorola MC68000, MC68020, MC88100, and MC88110,
  89. Motorola/IBM PowerPC, National NS32000, IBM POWER, MIPS R3000, R4000,
  90. SPARCv7, SuperSPARC, generic SPARCv8, and DEC VAX.  Some optimizations
  91. also for ARM, Clipper, IBM ROMP (RT), and Pyramid AP/XP.
  92.    This version of MP is released under a more liberal license than
  93. previous versions.  It is now permitted to link MP to non-free
  94. programs, as long as MP source code is provided when distributing the
  95. non-free program.
  96. How to use this Manual
  97. ======================
  98.    Everyone should read *Note MP Basics::.  If you need to install the
  99. library yourself, you need to read *Note Installing MP::, too.
  100.    The rest of the manual can be used for later reference, although it
  101. is probably a good idea to glance through it.
  102. File: gmp.info,  Node: Installing MP,  Next: MP Basics,  Prev: Introduction to MP,  Up: Top
  103. Installing MP
  104. *************
  105.    To build MP, you first have to configure it for your CPU and
  106. operating system.  You need a C compiler, preferably GCC, but any
  107. reasonable compiler should work.  And you need a standard Unix `make'
  108. program, plus some other standard Unix utility programs.
  109.    (If you're on an MS-DOS machine, your can build MP using `make.bat'.
  110. It requires that djgpp is installed.  It does not require
  111. configuration, nor is `make' needed; `make.bat' both configures and
  112. builds the library.)
  113.    Here are the steps needed to install the library on Unix systems:
  114.   1. In most cases, `./configure --target=cpu-vendor-os', should work
  115.      both for native and cross-compilation.  If you get error messages,
  116.      your machine might not be supported.
  117.      If you want to compile in a separate object directory, cd to that
  118.      directory, and prefix the configure command with the path to the
  119.      MP source directory.  Not all `make' programs have the necessary
  120.      features to support this.  In particular, SunOS and Slowaris
  121.      `make' have bugs that makes them unable to build from a separate
  122.      object directory.  Use GNU `make' instead.
  123.      In addition to the standard cpu-vendor-os tuples, MP recognizes
  124.      sparc8 and supersparc as valid CPU names.  Specifying these CPU
  125.      names for relevant systems will improve performance significantly.
  126.      In general, if you want a library that runs as fast as possible,
  127.      you should make sure you configure MP for the exact CPU type your
  128.      system uses.
  129.      If you have `gcc' in your `PATH', it will be used by default.  To
  130.      override this, pass `-with-gcc=no' to `configure'.
  131.   2. `make'
  132.      This will compile MP, and create a library archive file `libgmp.a'
  133.      in the working directory.
  134.   3. `make check'
  135.      This will make sure MP was built correctly.  If you get error
  136.      messages, please report this to `bug-gmp@prep.ai.mit.edu'.  (*Note
  137.      Reporting Bugs::, for information on what to include in useful bug
  138.      reports.)
  139.   4. `make install'
  140.      This will copy the file `gmp.h' and `libgmp.a', as well as the info
  141.      files, to `/usr/local' (or if you passed the `--prefix' option to
  142.      `configure', to the directory given as argument to `--prefix').
  143. If you wish to build and install the BSD MP compatible functions, use
  144. `make libmp.a' and `make install-bsdmp'.
  145.    There are some other useful make targets:
  146.    * `doc'
  147.      Create a DVI version of the manual, in `gmp.dvi' and a set of info
  148.      files, in `gmp.info', `gmp.info-1', `gmp.info-2', etc.
  149.    * `ps'
  150.      Create a Postscript version of the manual, in `gmp.ps'.
  151.    * `html'
  152.      Create a HTML version of the manual, in `gmp.html'.
  153.    * `clean'
  154.      Delete all object files and archive files, but not the
  155.      configuration files.
  156.    * `distclean'
  157.      Delete all files not included in the distribution.
  158.    * `uninstall'
  159.      Delete all files copied by `make install'.
  160. Known Build Problems
  161. ====================
  162.    GCC 2.7.2 (as well as 2.6.3) for the RS/6000 and PowerPC can not be
  163. used to compile MP, due to a bug in GCC.  If you want to use GCC for
  164. these machines, you need to apply the patch below to GCC, or use a
  165. later version of the compiler.
  166.    If you are on a Sequent Symmetry, use the GNU assembler instead of
  167. the system's assembler, since the latter has serious bugs.
  168.    The system compiler on NeXT is a massacred and old gcc, even if the
  169. compiler calls itself `cc'.  This compiler cannot be used to build MP.
  170. You need to get a real gcc, and install that before you compile MP.
  171. (NeXT might have fixed this in newer releases of their system.)
  172.    The system C compiler under SunOS 4 has a bug that makes it
  173. miscompile mpq/get_d.c.  This will make `make check' fail.
  174.    Please report other problems to `bug-gmp@prep.ai.mit.edu'.  *Note
  175. Reporting Bugs::.
  176.    Patch to apply to GCC 2.6.3 and 2.7.2:
  177.      *** config/rs6000/rs6000.md    Sun Feb 11 08:22:11 1996
  178.      --- config/rs6000/rs6000.md.new    Sun Feb 18 03:33:37 1996
  179.      ***************
  180.      *** 920,926 ****
  181.           (set (match_operand:SI 0 "gpc_reg_operand" "=r")
  182.            (not:SI (match_dup 1)))]
  183.          ""
  184.      !   "nor. %0,%2,%1"
  185.          [(set_attr "type" "compare")])
  186.      
  187.        (define_insn ""
  188.      --- 920,926 ----
  189.           (set (match_operand:SI 0 "gpc_reg_operand" "=r")
  190.            (not:SI (match_dup 1)))]
  191.          ""
  192.      !   "nor. %0,%1,%1"
  193.          [(set_attr "type" "compare")])
  194.      
  195.        (define_insn ""
  196. File: gmp.info,  Node: MP Basics,  Next: Reporting Bugs,  Prev: Installing MP,  Up: Top
  197. MP Basics
  198. *********
  199.    All declarations needed to use MP are collected in the include file
  200. `gmp.h'.  It is designed to work with both C and C++ compilers.
  201. Nomenclature and Types
  202. ======================
  203. In this manual, "integer" usually means a multiple precision integer, as
  204. defined by the MP library.  The C data type for such integers is
  205. `mpz_t'.  Here are some examples of how to declare such integers:
  206.      mpz_t sum;
  207.      
  208.      struct foo { mpz_t x, y; };
  209.      
  210.      mpz_t vec[20];
  211. "Rational number" means a multiple precision fraction.  The C data type
  212. for these fractions is `mpq_t'.  For example:
  213.      mpq_t quotient;
  214. "Floating point number" or "Float" for short, is an arbitrary precision
  215. mantissa with an limited precision exponent.  The C data type for such
  216. objects is `mpf_t'.
  217. A "limb" means the part of a multi-precision number that fits in a
  218. single word.  (We chose this word because a limb of the human body is
  219. analogous to a digit, only larger, and containing several digits.)
  220. Normally a limb contains 32 or 64 bits.  The C data type for a limb is
  221. `mp_limb_t'.
  222. Function Classes
  223. ================
  224.    There are six classes of functions in the MP library:
  225.   1. Functions for signed integer arithmetic, with names beginning with
  226.      `mpz_'.  The associated type is `mpz_t'.  There are about 100
  227.      functions in this class.
  228.   2. Functions for rational number arithmetic, with names beginning with
  229.      `mpq_'.  The associated type is `mpq_t'.  There are about 20
  230.      functions in this class, but the functions in the previous class
  231.      can be used for performing arithmetic on the numerator and
  232.      denominator separately.
  233.   3. Functions for floating-point arithmetic, with names beginning with
  234.      `mpf_'.  The associated type is `mpf_t'.  There are about 50
  235.      functions is this class.
  236.   4. Functions compatible with Berkeley MP, such as `itom', `madd', and
  237.      `mult'.  The associated type is `MINT'.
  238.   5. Fast low-level functions that operate on natural numbers.  These
  239.      are used by the functions in the preceding groups, and you can
  240.      also call them directly from very time-critical user programs.
  241.      These functions' names begin with `mpn_'.  There are about 30
  242.      (hard-to-use) functions in this class.
  243.      The associated type is array of `mp_limb_t'.
  244.   6. Miscellaneous functions.  Functions for setting up custom
  245.      allocation.
  246. MP Variable Conventions
  247. =======================
  248.    As a general rule, all MP functions expect output arguments before
  249. input arguments.  This notation is based on an analogy with the
  250. assignment operator.  (The BSD MP compatibility functions disobey this
  251. rule, having the output argument(s) last.)
  252.    MP allows you to use the same variable for both input and output in
  253. the same expression.  For example, the main function for integer
  254. multiplication, `mpz_mul', can be used like this: `mpz_mul (x, x, x)'.
  255. This computes the square of X and puts the result back in X.
  256.    Before you can assign to an MP variable, you need to initialize it
  257. by calling one of the special initialization functions.  When you're
  258. done with a variable, you need to clear it out, using one of the
  259. functions for that purpose.  Which function to use depends on the type
  260. of variable.  See the chapters on integer functions, rational number
  261. functions, and floating-point functions for details.
  262.    A variable should only be initialized once, or at least cleared out
  263. between each initialization.  After a variable has been initialized, it
  264. may be assigned to any number of times.
  265.    For efficiency reasons, avoid to initialize and clear out a variable
  266. in loops.  Instead, initialize it before entering the loop, and clear
  267. it out after the loop has exited.
  268.    You don't need to be concerned about allocating additional space for
  269. MP variables.  All functions in MP automatically allocate additional
  270. space when a variable does not already have enough space.  They do not,
  271. however, reduce the space when a smaller number is stored in the
  272. object.  Most of the time, this policy is best, since it avoids
  273. frequent re-allocation.
  274. Useful Macros and Constants
  275. ===========================
  276.  - Global Constant: const int mp_bits_per_limb
  277.      The number of bits per limb.
  278.  - Macro: __GNU_MP_VERSION
  279.  - Macro: __GNU_MP_VERSION_MINOR
  280.      The major and minor MP version, respectively, as integers.
  281. Compatibility with Version 1.x
  282. ==============================
  283.    This version of MP is upward compatible with previous versions of
  284. MP, with a few exceptions.
  285.   1. Integer division functions round the result differently.  The old
  286.      functions (`mpz_div', `mpz_divmod', `mpz_mdiv', `mpz_mdivmod',
  287.      etc) now all use floor rounding (i.e., they round the quotient to
  288.      -infinity).  There are a lot of new functions for integer
  289.      division, giving the user better control over the rounding.
  290.   2. The function `mpz_mod' now compute the true *mod* function.
  291.   3. The functions `mpz_powm' and `mpz_powm_ui' now use *mod* for
  292.      reduction.
  293.   4. The assignment functions for rational numbers do no longer
  294.      canonicalize their results.  In the case a non-canonical result
  295.      could arise from an assignment, the user need to insert an
  296.      explicit call to `mpq_canonicalize'.  This change was made for
  297.      efficiency.
  298.   5. Output generated by `mpz_out_raw' in this release cannot be read
  299.      by `mpz_inp_raw' in previous releases.  This change was made for
  300.      making the file format truly portable between machines with
  301.      different word sizes.
  302.   6. Several `mpn' functions have changed.  But they were intentionally
  303.      undocumented in previous releases.
  304.   7. The functions `mpz_cmp_ui', `mpz_cmp_si', and `mpq_cmp_ui' are now
  305.      implementated as macros, and thereby sometimes evaluate their
  306.      arguments multiple times.
  307.   8. The functions `mpz_pow_ui' and `mpz_ui_pow_ui' now yield 1 for
  308.      0^0.  (In version 1, they yielded 0.)
  309. Getting the Latest Version of MP
  310. ================================
  311.    The latest version of the MP library is available by anonymous ftp
  312. from from `prep.ai.mit.edu'.  The file name is
  313. `/pub/gnu/gmp-M.N.tar.gz'.  Many sites around the world mirror `prep';
  314. please use a mirror site near you.
  315. File: gmp.info,  Node: Reporting Bugs,  Next: Integer Functions,  Prev: MP Basics,  Up: Top
  316. Reporting Bugs
  317. **************
  318.    If you think you have found a bug in the MP library, please
  319. investigate it and report it.  We have made this library available to
  320. you, and it is not to ask too much from you, to ask you to report the
  321. bugs that you find.
  322.    There are a few things you should think about when you put your bug
  323. report together.
  324.    You have to send us a test case that makes it possible for us to
  325. reproduce the bug.  Include instructions on how to run the test case.
  326.    You also have to explain what is wrong; if you get a crash, or if
  327. the results printed are incorrect and in that case, in what way.
  328.    It is not uncommon that an observed problem is actually due to a bug
  329. in the compiler used when building MP; the MP code tends to explore
  330. interesting corners in compilers.  Therefore, please include compiler
  331. version information in your bug report.  This can be extracted using
  332. `what `which cc`', or, if you're using gcc, `gcc -v'.  Also, include
  333. the output from `uname -a'.
  334.    If your bug report is good, we will do our best to help you to get a
  335. corrected version of the library; if the bug report is poor, we won't
  336. do anything about it (aside of chiding you to send better bug reports).
  337.    Send your bug report to: `bug-gmp@prep.ai.mit.edu'.
  338.    If you think something in this manual is unclear, or downright
  339. incorrect, or if the language needs to be improved, please send a note
  340. to the same address.
  341. File: gmp.info,  Node: Integer Functions,  Next: Rational Number Functions,  Prev: Reporting Bugs,  Up: Top
  342. Integer Functions
  343. *****************
  344.    This chapter describes the MP functions for performing integer
  345. arithmetic.  These functions start with the prefix `mpz_'.
  346.    Arbitrary precision integers are stored in objects of type `mpz_t'.
  347. * Menu:
  348. * Initializing Integers::
  349. * Assigning Integers::
  350. * Simultaneous Integer Init & Assign::
  351. * Converting Integers::
  352. * Integer Arithmetic::
  353. * Comparison Functions::
  354. * Integer Logic and Bit Fiddling::
  355. * I/O of Integers::
  356. * Miscellaneous Integer Functions::
  357. File: gmp.info,  Node: Initializing Integers,  Next: Assigning Integers,  Up: Integer Functions
  358. Initialization and Assignment Functions
  359. =======================================
  360.    The functions for integer arithmetic assume that all integer objects
  361. are initialized.  You do that by calling the function `mpz_init'.
  362.  - Function: void mpz_init (mpz_t INTEGER)
  363.      Initialize INTEGER with limb space and set the initial numeric
  364.      value to 0.  Each variable should normally only be initialized
  365.      once, or at least cleared out (using `mpz_clear') between each
  366.      initialization.
  367.    Here is an example of using `mpz_init':
  368.      {
  369.        mpz_t integ;
  370.        mpz_init (integ);
  371.        ...
  372.        mpz_add (integ, ...);
  373.        ...
  374.        mpz_sub (integ, ...);
  375.      
  376.        /* Unless the program is about to exit, do ... */
  377.        mpz_clear (integ);
  378.      }
  379. As you can see, you can store new values any number of times, once an
  380. object is initialized.
  381.  - Function: void mpz_clear (mpz_t INTEGER)
  382.      Free the limb space occupied by INTEGER.  Make sure to call this
  383.      function for all `mpz_t' variables when you are done with them.
  384.  - Function: void * _mpz_realloc (mpz_t INTEGER, mp_size_t NEW_ALLOC)
  385.      Change the limb space allocation to NEW_ALLOC limbs.  This
  386.      function is not normally called from user code, but it can be used
  387.      to give memory back to the heap, or to increase the space of a
  388.      variable to avoid repeated automatic re-allocation.
  389.  - Function: void mpz_array_init (mpz_t INTEGER_ARRAY[], size_t
  390.           ARRAY_SIZE, mp_size_t FIXED_NUM_BITS)
  391.      Allocate *fixed* limb space for all ARRAY_SIZE integers in
  392.      INTEGER_ARRAY.  The fixed allocation for each integer in the array
  393.      is enough to store FIXED_NUM_BITS.  If the fixed space will be
  394.      insufficient for storing the result of a subsequent calculation,
  395.      the result is unpredictable.
  396.      This function is useful for decreasing the working set for some
  397.      algorithms that use large integer arrays.
  398.      There is no way to de-allocate the storage allocated by this
  399.      function.  Don't call `mpz_clear'!
  400. File: gmp.info,  Node: Assigning Integers,  Next: Simultaneous Integer Init & Assign,  Prev: Initializing Integers,  Up: Integer Functions
  401. Assignment Functions
  402. --------------------
  403.    These functions assign new values to already initialized integers
  404. (*note Initializing Integers::.).
  405.  - Function: void mpz_set (mpz_t ROP, mpz_t OP)
  406.  - Function: void mpz_set_ui (mpz_t ROP, unsigned long int OP)
  407.  - Function: void mpz_set_si (mpz_t ROP, signed long int OP)
  408.  - Function: void mpz_set_d (mpz_t ROP, double OP)
  409.  - Function: void mpz_set_q (mpz_t ROP, mpq_t OP)
  410.  - Function: void mpz_set_f (mpz_t ROP, mpf_t OP)
  411.      Set the value of ROP from OP.
  412.  - Function: int mpz_set_str (mpz_t ROP, char *STR, int BASE)
  413.      Set the value of ROP from STR, a '\0'-terminated C string in base
  414.      BASE.  White space is allowed in the string, and is simply
  415.      ignored.  The base may vary from 2 to 36.  If BASE is 0, the
  416.      actual base is determined from the leading characters: if the
  417.      first two characters are `0x' or `0X', hexadecimal is assumed,
  418.      otherwise if the first character is `0', octal is assumed,
  419.      otherwise decimal is assumed.
  420.      This function returns 0 if the entire string up to the '\0' is a
  421.      valid number in base BASE.  Otherwise it returns -1.
  422. File: gmp.info,  Node: Simultaneous Integer Init & Assign,  Next: Converting Integers,  Prev: Assigning Integers,  Up: Integer Functions
  423. Combined Initialization and Assignment Functions
  424. ------------------------------------------------
  425.    For convenience, MP provides a parallel series of initialize-and-set
  426. functions which initialize the output and then store the value there.
  427. These functions' names have the form `mpz_init_set...'
  428.    Here is an example of using one:
  429.      {
  430.        mpz_t pie;
  431.        mpz_init_set_str (pie, "3141592653589793238462643383279502884", 10);
  432.        ...
  433.        mpz_sub (pie, ...);
  434.        ...
  435.        mpz_clear (pie);
  436.      }
  437. Once the integer has been initialized by any of the `mpz_init_set...'
  438. functions, it can be used as the source or destination operand for the
  439. ordinary integer functions.  Don't use an initialize-and-set function
  440. on a variable already initialized!
  441.  - Function: void mpz_init_set (mpz_t ROP, mpz_t OP)
  442.  - Function: void mpz_init_set_ui (mpz_t ROP, unsigned long int OP)
  443.  - Function: void mpz_init_set_si (mpz_t ROP, signed long int OP)
  444.  - Function: void mpz_init_set_d (mpz_t ROP, double OP)
  445.      Initialize ROP with limb space and set the initial numeric value
  446.      from OP.
  447.  - Function: int mpz_init_set_str (mpz_t ROP, char *STR, int BASE)
  448.      Initialize ROP and set its value like `mpz_set_str' (see its
  449.      documentation above for details).
  450.      If the string is a correct base BASE number, the function returns
  451.      0; if an error occurs it returns -1.  ROP is initialized even if
  452.      an error occurs.  (I.e., you have to call `mpz_clear' for it.)
  453. File: gmp.info,  Node: Converting Integers,  Next: Integer Arithmetic,  Prev: Simultaneous Integer Init & Assign,  Up: Integer Functions
  454. Conversion Functions
  455. ====================
  456.    This section describes functions for converting arbitrary precision
  457. integers to standard C types.  Functions for converting *to* arbitrary
  458. precision integers are described in *Note Assigning Integers:: and
  459. *Note I/O of Integers::.
  460.  - Function: unsigned long int mpz_get_ui (mpz_t OP)
  461.      Return the least significant part from OP.  This function combined
  462.      with
  463.      `mpz_tdiv_q_2exp(..., OP, CHAR_BIT*sizeof(unsigned long int))' can
  464.      be used to extract the limbs of an integer.
  465.  - Function: signed long int mpz_get_si (mpz_t OP)
  466.      If OP fits into a `signed long int' return the value of OP.
  467.      Otherwise return the least significant part of OP, with the same
  468.      sign as OP.
  469.      If OP is too large to fit in a `signed long int', the returned
  470.      result is probably not very useful.
  471.  - Function: double mpz_get_d (mpz_t OP)
  472.      Convert OP to a double.
  473.  - Function: char * mpz_get_str (char *STR, int BASE, mpz_t OP)
  474.      Convert OP to a string of digits in base BASE.  The base may vary
  475.      from 2 to 36.
  476.      If STR is NULL, space for the result string is allocated using the
  477.      default allocation function, and a pointer to the string is
  478.      returned.
  479.      If STR is not NULL, it should point to a block of storage enough
  480.      large for the result.  To find out the right amount of space to
  481.      provide for STR, use `mpz_sizeinbase (OP, BASE) + 2'.  The two
  482.      extra bytes are for a possible minus sign, and for the terminating
  483.      null character.
  484. File: gmp.info,  Node: Integer Arithmetic,  Next: Comparison Functions,  Prev: Converting Integers,  Up: Integer Functions
  485. Arithmetic Functions
  486. ====================
  487.  - Function: void mpz_add (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  488.  - Function: void mpz_add_ui (mpz_t ROP, mpz_t OP1, unsigned long int
  489.           OP2)
  490.      Set ROP to OP1 + OP2.
  491.  - Function: void mpz_sub (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  492.  - Function: void mpz_sub_ui (mpz_t ROP, mpz_t OP1, unsigned long int
  493.           OP2)
  494.      Set ROP to OP1 - OP2.
  495.  - Function: void mpz_mul (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  496.  - Function: void mpz_mul_ui (mpz_t ROP, mpz_t OP1, unsigned long int
  497.           OP2)
  498.      Set ROP to OP1 times OP2.
  499.  - Function: void mpz_mul_2exp (mpz_t ROP, mpz_t OP1, unsigned long int
  500.           OP2)
  501.      Set ROP to OP1 times 2 raised to OP2.  This operation can also be
  502.      defined as a left shift, OP2 steps.
  503.  - Function: void mpz_neg (mpz_t ROP, mpz_t OP)
  504.      Set ROP to -OP.
  505.  - Function: void mpz_abs (mpz_t ROP, mpz_t OP)
  506.      Set ROP to the absolute value of OP.
  507.  - Function: void mpz_fac_ui (mpz_t ROP, unsigned long int OP)
  508.      Set ROP to OP!, the factorial of OP.
  509. Division functions
  510. ------------------
  511.    Division is undefined if the divisor is zero, and passing a zero
  512. divisor to the divide or modulo functions, as well passing a zero mod
  513. argument to the `mpz_powm' and `mpz_powm_ui' functions, will make these
  514. functions intentionally divide by zero.  This gives the user the
  515. possibility to handle arithmetic exceptions in these functions in the
  516. same manner as other arithmetic exceptions.
  517.    There are three main groups of division functions:
  518.    * Functions that truncate the quotient towards 0.  The names of these
  519.      functions start with `mpz_tdiv'.  The `t' in the name is short for
  520.      `truncate'.
  521.    * Functions that round the quotient towards -infinity.  The names of
  522.      these routines start with `mpz_fdiv'.  The `f' in the name is
  523.      short for `floor'.
  524.    * Functions that round the quotient towards +infinity.  The names of
  525.      these routines start with `mpz_cdiv'.  The `c' in the name is
  526.      short for `ceil'.
  527.    For each rounding mode, there are a couple of variants.  Here `q'
  528. means that the quotient is computed, while `r' means that the remainder
  529. is computed.  Functions that compute both the quotient and remainder
  530. have `qr' in the name.
  531.  - Function: void mpz_tdiv_q (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  532.  - Function: void mpz_tdiv_q_ui (mpz_t ROP, mpz_t OP1, unsigned long
  533.           int OP2)
  534.      Set ROP to [OP1/OP2].  The quotient is truncated towards 0.
  535.  - Function: void mpz_tdiv_r (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  536.  - Function: void mpz_tdiv_r_ui (mpz_t ROP, mpz_t OP1, unsigned long
  537.           int OP2)
  538.      Set ROP to (OP1 - [OP1/OP2] * OP2).  Unless the remainder is zero,
  539.      it has the same sign as the dividend.
  540.  - Function: void mpz_tdiv_qr (mpz_t ROP1, mpz_t ROP2, mpz_t OP1, mpz_t
  541.           OP2)
  542.  - Function: void mpz_tdiv_qr_ui (mpz_t ROP1, mpz_t ROP2, mpz_t OP1,
  543.           unsigned long int OP2)
  544.      Divide OP1 by OP2 and put the quotient in ROP1 and the remainder
  545.      in ROP2.  The quotient is rounded towards 0.  Unless the remainder
  546.      is zero, it has the same sign as the dividend.
  547.      If ROP1 and ROP2 are the same variable, the results are undefined.
  548.  - Function: void mpz_fdiv_q (mpz_t ROP1, mpz_t OP1, mpz_t OP2)
  549.  - Function: void mpz_fdiv_q_ui (mpz_t ROP, mpz_t OP1, unsigned long
  550.           int OP2)
  551.      Set ROP to OP1/OP2.  The quotient is rounded towards -infinity.
  552.  - Function: void mpz_fdiv_r (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  553.  - Function: unsigned long int mpz_fdiv_r_ui (mpz_t ROP, mpz_t OP1,
  554.           unsigned long int OP2)
  555.      Divide OP1 by OP2 and put the remainder in ROP.  Unless the
  556.      remainder is zero, it has the same sign as the divisor.
  557.      For `mpz_fdiv_r_ui' the remainder is small enough to fit in an
  558.      `unsigned long int', and is therefore returned.
  559.  - Function: void mpz_fdiv_qr (mpz_t ROP1, mpz_t ROP2, mpz_t OP1, mpz_t
  560.           OP2)
  561.  - Function: unsigned long int mpz_fdiv_qr_ui (mpz_t ROP1, mpz_t ROP2,
  562.           mpz_t OP1, unsigned long int OP2)
  563.      Divide OP1 by OP2 and put the quotient in ROP1 and the remainder
  564.      in ROP2.  The quotient is rounded towards -infinity.  Unless the
  565.      remainder is zero, it has the same sign as the divisor.
  566.      For `mpz_fdiv_qr_ui' the remainder is small enough to fit in an
  567.      `unsigned long int', and is therefore returned.
  568.      If ROP1 and ROP2 are the same variable, the results are undefined.
  569.  - Function: unsigned long int mpz_fdiv_ui (mpz_t OP1, unsigned long
  570.           int OP2)
  571.      This function is similar to `mpz_fdiv_r_ui', but the remainder is
  572.      only returned; it is not stored anywhere.
  573.  - Function: void mpz_cdiv_q (mpz_t ROP1, mpz_t OP1, mpz_t OP2)
  574.  - Function: void mpz_cdiv_q_ui (mpz_t ROP, mpz_t OP1, unsigned long
  575.           int OP2)
  576.      Set ROP to OP1/OP2.  The quotient is rounded towards +infinity.
  577.  - Function: void mpz_cdiv_r (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  578.  - Function: unsigned long int mpz_cdiv_r_ui (mpz_t ROP, mpz_t OP1,
  579.           unsigned long int OP2)
  580.      Divide OP1 by OP2 and put the remainder in ROP.  Unless the
  581.      remainder is zero, it has the opposite sign as the divisor.
  582.      For `mpz_cdiv_r_ui' the negated remainder is small enough to fit
  583.      in an `unsigned long int', and it is therefore returned.
  584.  - Function: void mpz_cdiv_qr (mpz_t ROP1, mpz_t ROP2, mpz_t OP1, mpz_t
  585.           OP2)
  586.  - Function: unsigned long int mpz_cdiv_qr_ui (mpz_t ROP1, mpz_t ROP2,
  587.           mpz_t OP1, unsigned long int OP2)
  588.      Divide OP1 by OP2 and put the quotient in ROP1 and the remainder
  589.      in ROP2.  The quotient is rounded towards +infinity.  Unless the
  590.      remainder is zero, it has the opposite sign as the divisor.
  591.      For `mpz_cdiv_qr_ui' the negated remainder is small enough to fit
  592.      in an `unsigned long int', and it is therefore returned.
  593.      If ROP1 and ROP2 are the same variable, the results are undefined.
  594.  - Function: unsigned long int mpz_cdiv_ui (mpz_t OP1, unsigned long
  595.           int OP2)
  596.      Return the negated remainder, similar to `mpz_cdiv_r_ui'.  (The
  597.      difference is that this function doesn't store the remainder
  598.      anywhere.)
  599.  - Function: void mpz_mod (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  600.  - Function: unsigned long int mpz_mod_ui (mpz_t ROP, mpz_t OP1,
  601.           unsigned long int OP2)
  602.      Set ROP to OP1 `mod' OP2.  The sign of the divisor is ignored, and
  603.      the result is always non-negative.
  604.      For `mpz_mod_ui' the remainder is small enough to fit in an
  605.      `unsigned long int', and is therefore returned.
  606.  - Function: void mpz_divexact (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  607.      Set ROP to OP1/OP2.  This function produces correct results only
  608.      when it is known in advance that OP2 divides OP1.
  609.      Since mpz_divexact is much faster than any of the other routines
  610.      that produce the quotient (*note References::. Jebelean), it is
  611.      the best choice for instances in which exact division is known to
  612.      occur, such as reducing a rational to lowest terms.
  613.  - Function: void mpz_tdiv_q_2exp (mpz_t ROP, mpz_t OP1, unsigned long
  614.           int OP2)
  615.      Set ROP to OP1 divided by 2 raised to OP2.  The quotient is
  616.      rounded towards 0.
  617.  - Function: void mpz_tdiv_r_2exp (mpz_t ROP, mpz_t OP1, unsigned long
  618.           int OP2)
  619.      Divide OP1 by (2 raised to OP2) and put the remainder in ROP.
  620.      Unless it is zero, ROP will have the same sign as OP1.
  621.  - Function: void mpz_fdiv_q_2exp (mpz_t ROP, mpz_t OP1, unsigned long
  622.           int OP2)
  623.      Set ROP to OP1 divided by 2 raised to OP2.  The quotient is
  624.      rounded towards -infinity.
  625.  - Function: void mpz_fdiv_r_2exp (mpz_t ROP, mpz_t OP1, unsigned long
  626.           int OP2)
  627.      Divide OP1 by (2 raised to OP2) and put the remainder in ROP.  The
  628.      sign of ROP will always be positive.
  629.      This operation can also be defined as masking of the OP2 least
  630.      significant bits.
  631. Exponentialization Functions
  632. ----------------------------
  633.  - Function: void mpz_powm (mpz_t ROP, mpz_t BASE, mpz_t EXP, mpz_t MOD)
  634.  - Function: void mpz_powm_ui (mpz_t ROP, mpz_t BASE, unsigned long int
  635.           EXP, mpz_t MOD)
  636.      Set ROP to (BASE raised to EXP) `mod' MOD.  If EXP is negative,
  637.      the result is undefined.
  638.  - Function: void mpz_pow_ui (mpz_t ROP, mpz_t BASE, unsigned long int
  639.           EXP)
  640.  - Function: void mpz_ui_pow_ui (mpz_t ROP, unsigned long int BASE,
  641.           unsigned long int EXP)
  642.      Set ROP to BASE raised to EXP.  The case of 0^0 yields 1.
  643. Square Root Functions
  644. ---------------------
  645.  - Function: void mpz_sqrt (mpz_t ROP, mpz_t OP)
  646.      Set ROP to the truncated integer part of the square root of OP.
  647.  - Function: void mpz_sqrtrem (mpz_t ROP1, mpz_t ROP2, mpz_t OP)
  648.      Set ROP1 to the truncated integer part of the square root of OP,
  649.      like `mpz_sqrt'.  Set ROP2 to OP-ROP1*ROP1, (i.e., zero if OP is a
  650.      perfect square).
  651.      If ROP1 and ROP2 are the same variable, the results are undefined.
  652.  - Function: int mpz_perfect_square_p (mpz_t OP)
  653.      Return non-zero if OP is a perfect square, i.e., if the square
  654.      root of OP is an integer.  Return zero otherwise.
  655. Number Theoretic Functions
  656. --------------------------
  657.  - Function: int mpz_probab_prime_p (mpz_t OP, int REPS)
  658.      If this function returns 0, OP is definitely not prime.  If it
  659.      returns 1, then OP is `probably' prime.  The probability of a
  660.      false positive is (1/4)**REPS.  A reasonable value of reps is 25.
  661.      An implementation of the probabilistic primality test found in
  662.      Seminumerical Algorithms (*note References::. Knuth).
  663.  - Function: void mpz_gcd (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  664.      Set ROP to the greatest common divisor of OP1 and OP2.
  665.  - Function: unsigned long int mpz_gcd_ui (mpz_t ROP, mpz_t OP1,
  666.           unsigned long int OP2)
  667.      Compute the greatest common divisor of OP1 and OP2.  If ROP is not
  668.      NULL, store the result there.
  669.      If the result is small enough to fit in an `unsigned long int', it
  670.      is returned.  If the result does not fit, 0 is returned, and the
  671.      result is equal to the argument OP1.  Note that the result will
  672.      always fit if OP2 is non-zero.
  673.  - Function: void mpz_gcdext (mpz_t G, mpz_t S, mpz_t T, mpz_t A, mpz_t
  674.           B)
  675.      Compute G, S, and T, such that AS + BT = G = `gcd' (A, B).  If T is
  676.      NULL, that argument is not computed.
  677.  - Function: int mpz_invert (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  678.      Compute the inverse of OP1 modulo OP2 and put the result in ROP.
  679.      Return non-zero if an inverse exist, zero otherwise.  When the
  680.      function returns zero, do not assume anything about the value in
  681.      ROP.
  682.  - Function: int mpz_jacobi (mpz_t OP1, mpz_t OP2)
  683.  - Function: int mpz_legendre (mpz_t OP1, mpz_t OP2)
  684.      Compute the Jacobi and Legendre symbols, respectively.
  685. File: gmp.info,  Node: Comparison Functions,  Next: Integer Logic and Bit Fiddling,  Prev: Integer Arithmetic,  Up: Integer Functions
  686. Comparison Functions
  687. ====================
  688.  - Function: int mpz_cmp (mpz_t OP1, mpz_t OP2)
  689.      Compare OP1 and OP2.  Return a positive value if OP1 > OP2, zero
  690.      if OP1 = OP2, and a negative value if OP1 < OP2.
  691.  - Macro: int mpz_cmp_ui (mpz_t OP1, unsigned long int OP2)
  692.  - Macro: int mpz_cmp_si (mpz_t OP1, signed long int OP2)
  693.      Compare OP1 and OP2.  Return a positive value if OP1 > OP2, zero
  694.      if OP1 = OP2, and a negative value if OP1 < OP2.
  695.      These functions are actually implemented as macros.  They evaluate
  696.      their arguments multiple times.
  697.  - Macro: int mpz_sgn (mpz_t OP)
  698.      Return +1 if OP > 0, 0 if OP = 0, and -1 if OP < 0.
  699.      This function is actually implemented as a macro.  It evaluates its
  700.      arguments multiple times.
  701. File: gmp.info,  Node: Integer Logic and Bit Fiddling,  Next: I/O of Integers,  Prev: Comparison Functions,  Up: Integer Functions
  702. Logical and Bit Manipulation Functions
  703. ======================================
  704.    These functions behave as if two's complement arithmetic were used
  705. (although sign-magnitude is used by the actual implementation).
  706.  - Function: void mpz_and (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  707.      Set ROP to OP1 logical-and OP2.
  708.  - Function: void mpz_ior (mpz_t ROP, mpz_t OP1, mpz_t OP2)
  709.      Set ROP to OP1 inclusive-or OP2.
  710.  - Function: void mpz_com (mpz_t ROP, mpz_t OP)
  711.      Set ROP to the one's complement of OP.
  712.  - Function: unsigned long int mpz_popcount (mpz_t OP)
  713.      For non-negative numbers, return the population count of OP.  For
  714.      negative numbers, return the largest possible value (MAX_ULONG).
  715.  - Function: unsigned long int mpz_hamdist (mpz_t OP1, mpz_t OP2)
  716.      If OP1 and OP2 are both non-negative, return the hamming distance
  717.      between the two operands.  Otherwise, return the largest possible
  718.      value (MAX_ULONG).
  719.      It is possible to extend this function to return a useful value
  720.      when the operands are both negative, but the current
  721.      implementation returns MAX_ULONG in this case.  *Do not depend on
  722.      this behavior, since it will change in future versions of the
  723.      library.*
  724.  - Function: unsigned long int mpz_scan0 (mpz_t OP, unsigned long int
  725.           STARTING_BIT)
  726.      Scan OP, starting with bit STARTING_BIT, towards more significant
  727.      bits, until the first clear bit is found.  Return the index of the
  728.      found bit.
  729.  - Function: unsigned long int mpz_scan1 (mpz_t OP, unsigned long int
  730.           STARTING_BIT)
  731.      Scan OP, starting with bit STARTING_BIT, towards more significant
  732.      bits, until the first set bit is found.  Return the index of the
  733.      found bit.
  734.  - Function: void mpz_setbit (mpz_t ROP, unsigned long int BIT_INDEX)
  735.      Set bit BIT_INDEX in OP1.
  736.  - Function: void mpz_clrbit (mpz_t ROP, unsigned long int BIT_INDEX)
  737.      Clear bit BIT_INDEX in OP1.
  738. File: gmp.info,  Node: I/O of Integers,  Next: Miscellaneous Integer Functions,  Prev: Integer Logic and Bit Fiddling,  Up: Integer Functions
  739. Input and Output Functions
  740. ==========================
  741.    Functions that perform input from a stdio stream, and functions that
  742. output to a stdio stream.  Passing a NULL pointer for a STREAM argument
  743. to any of these functions will make them read from `stdin' and write to
  744. `stdout', respectively.
  745.    When using any of these functions, it is a good idea to include
  746. `stdio.h' before `gmp.h', since that will allow `gmp.h' to define
  747. prototypes for these functions.
  748.  - Function: size_t mpz_out_str (FILE *STREAM, int BASE, mpz_t OP)
  749.      Output OP on stdio stream STREAM, as a string of digits in base
  750.      BASE.  The base may vary from 2 to 36.
  751.      Return the number of bytes written, or if an error occurred,
  752.      return 0.
  753.  - Function: size_t mpz_inp_str (mpz_t ROP, FILE *STREAM, int BASE)
  754.      Input a possibly white-space preceded string in base BASE from
  755.      stdio stream STREAM, and put the read integer in ROP.  The base
  756.      may vary from 2 to 36.  If BASE is 0, the actual base is
  757.      determined from the leading characters: if the first two
  758.      characters are `0x' or `0X', hexadecimal is assumed, otherwise if
  759.      the first character is `0', octal is assumed, otherwise decimal is
  760.      assumed.
  761.      Return the number of bytes read, or if an error occurred, return 0.
  762.  - Function: size_t mpz_out_raw (FILE *STREAM, mpz_t OP)
  763.      Output OP on stdio stream STREAM, in raw binary format.  The
  764.      integer is written in a portable format, with 4 bytes of size
  765.      information, and that many bytes of limbs.  Both the size and the
  766.      limbs are written in decreasing significance order (i.e., in
  767.      big-endian).
  768.      The output can be read with `mpz_inp_raw'.
  769.      Return the number of bytes written, or if an error occurred,
  770.      return 0.
  771.      The output of this can not be read by `mpz_inp_raw' from GMP 1,
  772.      because of changes necessary for compatibility between 32-bit and
  773.      64-bit machines.
  774.  - Function: size_t mpz_inp_raw (mpz_t ROP, FILE *STREAM)
  775.      Input from stdio stream STREAM in the format written by
  776.      `mpz_out_raw', and put the result in ROP.  Return the number of
  777.      bytes read, or if an error occurred, return 0.
  778.      This routine can read the output from `mpz_out_raw' also from GMP
  779.      1, in spite of changes necessary for compatibility between 32-bit
  780.      and 64-bit machines.
  781. File: gmp.info,  Node: Miscellaneous Integer Functions,  Prev: I/O of Integers,  Up: Integer Functions
  782. Miscellaneous Functions
  783. =======================
  784.  - Function: void mpz_random (mpz_t ROP, mp_size_t MAX_SIZE)
  785.      Generate a random integer of at most MAX_SIZE limbs.  The generated
  786.      random number doesn't satisfy any particular requirements of
  787.      randomness.  Negative random numbers are generated when MAX_SIZE
  788.      is negative.
  789.  - Function: void mpz_random2 (mpz_t ROP, mp_size_t MAX_SIZE)
  790.      Generate a random integer of at most MAX_SIZE limbs, with long
  791.      strings of zeros and ones in the binary representation.  Useful
  792.      for testing functions and algorithms, since this kind of random
  793.      numbers have proven to be more likely to trigger corner-case bugs.
  794.      Negative random numbers are generated when MAX_SIZE is negative.
  795.  - Function: size_t mpz_size (mpz_t OP)
  796.      Return the size of OP measured in number of limbs.  If OP is zero,
  797.      the returned value will be zero.
  798.      *This function is obsolete.  It will disappear from future MP
  799.      releases.*
  800.  - Function: size_t mpz_sizeinbase (mpz_t OP, int BASE)
  801.      Return the size of OP measured in number of digits in base BASE.
  802.      The base may vary from 2 to 36.  The returned value will be exact
  803.      or 1 too big.  If BASE is a power of 2, the returned value will
  804.      always be exact.
  805.      This function is useful in order to allocate the right amount of
  806.      space before converting OP to a string.  The right amount of
  807.      allocation is normally two more than the value returned by
  808.      `mpz_sizeinbase' (one extra for a minus sign and one for the
  809.      terminating '\0').
  810. File: gmp.info,  Node: Rational Number Functions,  Next: Floating-point Functions,  Prev: Integer Functions,  Up: Top
  811. Rational Number Functions
  812. *************************
  813.    This chapter describes the MP functions for performing arithmetic on
  814. rational numbers.  These functions start with the prefix `mpq_'.
  815.    Rational numbers are stored in objects of type `mpq_t'.
  816.    All rational arithmetic functions assume operands have a canonical
  817. form, and canonicalize their result.  The canonical from means that the
  818. denominator and the numerator have no common factors, and that the
  819. denominator is positive.  Zero has the unique representation 0/1.
  820.    Pure assignment functions do not canonicalize the assigned variable.
  821. It is the responsibility of the user to canonicalize the assigned
  822. variable before any arithmetic operations are performed on that
  823. variable.  *Note that this is an incompatible change from version 1 of
  824. the library.*
  825.  - Function: void mpq_canonicalize (mpq_t OP)
  826.      Remove any factors that are common to the numerator and
  827.      denominator of OP, and make the denominator positive.
  828. * Menu:
  829. * Initializing Rationals::
  830. * Assigning Rationals::
  831. * Simultaneous Integer Init & Assign::
  832. * Comparing Rationals::
  833. * Applying Integer Functions::
  834. * Miscellaneous Rational Functions::
  835. File: gmp.info,  Node: Initializing Rationals,  Next: Assigning Rationals,  Prev: Rational Number Functions,  Up: Rational Number Functions
  836. Initialization and Assignment Functions
  837. =======================================
  838.  - Function: void mpq_init (mpq_t DEST_RATIONAL)
  839.      Initialize DEST_RATIONAL and set it to 0/1.  Each variable should
  840.      normally only be initialized once, or at least cleared out (using
  841.      the function `mpq_clear') between each initialization.
  842.  - Function: void mpq_clear (mpq_t RATIONAL_NUMBER)
  843.      Free the space occupied by RATIONAL_NUMBER.  Make sure to call this
  844.      function for all `mpq_t' variables when you are done with them.
  845.  - Function: void mpq_set (mpq_t ROP, mpq_t OP)
  846.  - Function: void mpq_set_z (mpq_t ROP, mpz_t OP)
  847.      Assign ROP from OP.
  848.  - Function: void mpq_set_ui (mpq_t ROP, unsigned long int OP1,
  849.           unsigned long int OP2)
  850.  - Function: void mpq_set_si (mpq_t ROP, signed long int OP1, unsigned
  851.           long int OP2)
  852.      Set the value of ROP to OP1/OP2.  Note that if OP1 and OP2 have
  853.      common factors, ROP has to be passed to `mpq_canonicalize' before
  854.      any operations are performed on ROP.
  855. File: gmp.info,  Node: Assigning Rationals,  Next: Comparing Rationals,  Prev: Initializing Rationals,  Up: Rational Number Functions
  856. Arithmetic Functions
  857. ====================
  858.  - Function: void mpq_add (mpq_t SUM, mpq_t ADDEND1, mpq_t ADDEND2)
  859.      Set SUM to ADDEND1 + ADDEND2.
  860.  - Function: void mpq_sub (mpq_t DIFFERENCE, mpq_t MINUEND, mpq_t
  861.           SUBTRAHEND)
  862.      Set DIFFERENCE to MINUEND - SUBTRAHEND.
  863.  - Function: void mpq_mul (mpq_t PRODUCT, mpq_t MULTIPLIER, mpq_t
  864.           MULTIPLICAND)
  865.      Set PRODUCT to MULTIPLIER times MULTIPLICAND.
  866.  - Function: void mpq_div (mpq_t QUOTIENT, mpq_t DIVIDEND, mpq_t
  867.           DIVISOR)
  868.      Set QUOTIENT to DIVIDEND/DIVISOR.
  869.  - Function: void mpq_neg (mpq_t NEGATED_OPERAND, mpq_t OPERAND)
  870.      Set NEGATED_OPERAND to -OPERAND.
  871.  - Function: void mpq_inv (mpq_t INVERTED_NUMBER, mpq_t NUMBER)
  872.      Set INVERTED_NUMBER to 1/NUMBER.  If the new denominator is zero,
  873.      this routine will divide by zero.
  874. File: gmp.info,  Node: Comparing Rationals,  Next: Applying Integer Functions,  Prev: Assigning Rationals,  Up: Rational Number Functions
  875. Comparison Functions
  876. ====================
  877.  - Function: int mpq_cmp (mpq_t OP1, mpq_t OP2)
  878.      Compare OP1 and OP2.  Return a positive value if OP1 > OP2, zero
  879.      if OP1 = OP2, and a negative value if OP1 < OP2.
  880.      To determine if two rationals are equal, `mpq_equal' is faster than
  881.      `mpq_cmp'.
  882.  - Macro: int mpq_cmp_ui (mpq_t OP1, unsigned long int NUM2, unsigned
  883.           long int DEN2)
  884.      Compare OP1 and NUM2/DEN2.  Return a positive value if OP1 >
  885.      NUM2/DEN2, zero if OP1 = NUM2/DEN2, and a negative value if OP1 <
  886.      NUM2/DEN2.
  887.      This routine allows that NUM2 and DEN2 have common factors.
  888.      This function is actually implemented as a macro.  It evaluates its
  889.      arguments multiple times.
  890.  - Macro: int mpq_sgn (mpq_t OP)
  891.      Return +1 if OP > 0, 0 if OP = 0, and -1 if OP < 0.
  892.      This function is actually implemented as a macro.  It evaluates its
  893.      arguments multiple times.
  894.  - Function: int mpq_equal (mpq_t OP1, mpq_t OP2)
  895.      Return non-zero if OP1 and OP2 are equal, zero if they are
  896.      non-equal.  Although `mpq_cmp' can be used for the same purpose,
  897.      this function is much faster.
  898. File: gmp.info,  Node: Applying Integer Functions,  Next: Miscellaneous Rational Functions,  Prev: Comparing Rationals,  Up: Rational Number Functions
  899. Applying Integer Functions to Rationals
  900. =======================================
  901.    The set of `mpq' functions is quite small.  In particular, there are
  902. no functions for either input or output.  But there are two macros that
  903. allow us to apply any `mpz' function on the numerator or denominator of
  904. a rational number.  If these macros are used to assign to the rational
  905. number, `mpq_canonicalize' normally need to be called afterwards.
  906.  - Macro: mpz_t mpq_numref (mpq_t OP)
  907.  - Macro: mpz_t mpq_denref (mpq_t OP)
  908.      Return a reference to the numerator and denominator of OP,
  909.      respectively.  The `mpz' functions can be used on the result of
  910.      these macros.
  911. File: gmp.info,  Node: Miscellaneous Rational Functions,  Prev: Applying Integer Functions,  Up: Rational Number Functions
  912. Miscellaneous Functions
  913. =======================
  914.  - Function: double mpq_get_d (mpq_t OP)
  915.      Convert OP to a double.
  916.    These functions assign between either the numerator or denominator
  917. of a rational, and an integer.  Instead of using these functions, it is
  918. preferable to use the more general mechanisms `mpq_numref' and
  919. `mpq_denref', together with `mpz_set'.
  920.  - Function: void mpq_set_num (mpq_t RATIONAL, mpz_t NUMERATOR)
  921.      Copy NUMERATOR to the numerator of RATIONAL.  When this risks to
  922.      make the numerator and denominator of RATIONAL have common
  923.      factors, you have to pass RATIONAL to `mpq_canonicalize' before
  924.      any operations are performed on RATIONAL.
  925.      This function is equivalent to `mpz_set (mpq_numref (RATIONAL),
  926.      NUMERATOR)'.
  927.  - Function: void mpq_set_den (mpq_t RATIONAL, mpz_t DENOMINATOR)
  928.      Copy DENOMINATOR to the denominator of RATIONAL.  When this risks
  929.      to make the numerator and denominator of RATIONAL have common
  930.      factors, or if the denominator might be negative, you have to pass
  931.      RATIONAL to `mpq_canonicalize' before any operations are performed
  932.      on RATIONAL.
  933.      *In version 1 of the library, negative denominators were handled by
  934.      copying the sign to the numerator.  That is no longer done.*
  935.      This function is equivalent to `mpz_set (mpq_denref (RATIONAL),
  936.      DENOMINATORS)'.
  937.  - Function: void mpq_get_num (mpz_t NUMERATOR, mpq_t RATIONAL)
  938.      Copy the numerator of RATIONAL to the integer NUMERATOR, to
  939.      prepare for integer operations on the numerator.
  940.      This function is equivalent to `mpz_set (NUMERATOR, mpq_numref
  941.      (RATIONAL))'.
  942.  - Function: void mpq_get_den (mpz_t DENOMINATOR, mpq_t RATIONAL)
  943.      Copy the denominator of RATIONAL to the integer DENOMINATOR, to
  944.      prepare for integer operations on the denominator.
  945.      This function is equivalent to `mpz_set (DENOMINATOR, mpq_denref
  946.      (RATIONAL))'.
  947. File: gmp.info,  Node: Floating-point Functions,  Next: Low-level Functions,  Prev: Rational Number Functions,  Up: Top
  948. Floating-point Functions
  949. ************************
  950.    This is a description of the *preliminary* interface for
  951. floating-point arithmetic in GNU MP 2.
  952.    The floating-point functions expect arguments of type `mpf_t'.
  953.    The MP floating-point functions have an interface that is similar to
  954. the MP integer functions.  The function prefix for floating-point
  955. operations is `mpf_'.
  956.    There is one significant characteristic of floating-point numbers
  957. that has motivated a difference between this function class and other
  958. MP function classes: the inherent inexactness of floating point
  959. arithmetic.  The user has to specify the precision of each variable.  A
  960. computation that assigns a variable will take place with the precision
  961. of the assigned variable; the precision of variables used as input is
  962. ignored.
  963.    The precision of a calculation is defined as follows: Compute the
  964. requested operation exactly (with "infinite precision"), and truncate
  965. the result to the destination variable precision.  Even if the user has
  966. asked for a very high precision, MP will not calculate with superfluous
  967. digits.  For example, if two low-precision numbers of nearly equal
  968. magnitude are added, the precision of the result will be limited to
  969. what is required to represent the result accurately.
  970.    The MP floating-point functions are *not* intended as a smooth
  971. extension to the IEEE P754 arithmetic.  Specifically, the results
  972. obtained on one computer often differs from the results obtained on a
  973. computer with a different word size.
  974. * Menu:
  975. * Initializing Floats::
  976. * Assigning Floats::
  977. * Simultaneous Float Init & Assign::
  978. * Converting Floats::
  979. * Float Arithmetic::
  980. * Float Comparison::
  981. * I/O of Floats::
  982. * Miscellaneous Float Functions::
  983. File: gmp.info,  Node: Initializing Floats,  Next: Assigning Floats,  Up: Floating-point Functions
  984. Initialization and Assignment Functions
  985. =======================================
  986.  - Function: void mpf_set_default_prec (unsigned long int PREC)
  987.      Set the default precision to be *at least* PREC bits.  All
  988.      subsequent calls to `mpf_init' will use this precision, but
  989.      previously initialized variables are unaffected.
  990.    An `mpf_t' object must be initialized before storing the first value
  991. in it.  The functions `mpf_init' and `mpf_init2' are used for that
  992. purpose.
  993.  - Function: void mpf_init (mpf_t X)
  994.      Initialize X to 0.  Normally, a variable should be initialized
  995.      once only or at least be cleared, using `mpf_clear', between
  996.      initializations.  The precision of X is undefined unless a default
  997.      precision has already been established by a call to
  998.      `mpf_set_default_prec'.
  999.  - Function: void mpf_init2 (mpf_t X, unsigned long int PREC)
  1000.      Initialize X to 0 and set its precision to be *at least* PREC
  1001.      bits.  Normally, a variable should be initialized once only or at
  1002.      least be cleared, using `mpf_clear', between initializations.
  1003.  - Function: void mpf_clear (mpf_t X)
  1004.      Free the space occupied by X.  Make sure to call this function for
  1005.      all `mpf_t' variables when you are done with them.
  1006.    Here is an example on how to initialize floating-point variables:
  1007.      {
  1008.        mpf_t x, y;
  1009.        mpf_init (x);            /* use default precision */
  1010.        mpf_init2 (y, 256);        /* precision *at least* 256 bits */
  1011.        ...
  1012.        /* Unless the program is about to exit, do ... */
  1013.        mpf_clear (x);
  1014.        mpf_clear (y);
  1015.      }
  1016.    The following three functions are useful for changing the precision
  1017. during a calculation.  A typical use would be for adjusting the
  1018. precision gradually in iterative algorithms like Newton-Raphson, making
  1019. the computation precision closely match the actual accurate part of the
  1020. numbers.
  1021.  - Function: void mpf_set_prec (mpf_t ROP, unsigned long int PREC)
  1022.      Set the precision of ROP to be *at least* PREC bits.  Since
  1023.      changing the precision involves calls to `realloc', this routine
  1024.      should not be called in a tight loop.
  1025.  - Function: unsigned long int mpf_get_prec (mpf_t OP)
  1026.      Return the precision actually used for assignments of OP.
  1027.  - Function: void mpf_set_prec_raw (mpf_t ROP, unsigned long int PREC)
  1028.      Set the precision of ROP to be *at least* PREC bits.  This is a
  1029.      low-level function that does not change the allocation.  The PREC
  1030.      argument must not be larger that the precision previously returned
  1031.      by `mpf_get_prec'.  It is crucial that the precision of ROP is
  1032.      ultimately reset to exactly the value returned by `mpf_get_prec'.
  1033. File: gmp.info,  Node: Assigning Floats,  Next: Simultaneous Float Init & Assign,  Prev: Initializing Floats,  Up: Floating-point Functions
  1034. Assignment Functions
  1035. --------------------
  1036.    These functions assign new values to already initialized floats
  1037. (*note Initializing Floats::.).
  1038.  - Function: void mpf_set (mpf_t ROP, mpf_t OP)
  1039.  - Function: void mpf_set_ui (mpf_t ROP, unsigned long int OP)
  1040.  - Function: void mpf_set_si (mpf_t ROP, signed long int OP)
  1041.  - Function: void mpf_set_d (mpf_t ROP, double OP)
  1042.  - Function: void mpf_set_z (mpf_t ROP, mpz_t OP)
  1043.  - Function: void mpf_set_q (mpf_t ROP, mpq_t OP)
  1044.      Set the value of ROP from OP.
  1045.  - Function: int mpf_set_str (mpf_t ROP, char *STR, int BASE)
  1046.      Set the value of ROP from the string in STR.  The string is of the
  1047.      form `M@N' or, if the base is 10 or less, alternatively `MeN'.
  1048.      `M' is the mantissa and `N' is the exponent.  The mantissa is
  1049.      always in the specified base.  The exponent is either in the
  1050.      specified base or, if BASE is negative, in decimal.
  1051.      The argument BASE may be in the ranges 2 to 36, or -36 to -2.
  1052.      Negative values are used to specify that the exponent is in
  1053.      decimal.
  1054.      Unlike the corresponding `mpz' function, the base will not be
  1055.      determined from the leading characters of the string if BASE is 0.
  1056.      This is so that numbers like `0.23' are not interpreted as octal.
  1057.      White space is allowed in the string, and is simply ignored.
  1058.      This function returns 0 if the entire string up to the '\0' is a
  1059.      valid number in base BASE.  Otherwise it returns -1.
  1060. File: gmp.info,  Node: Simultaneous Float Init & Assign,  Next: Converting Floats,  Prev: Assigning Floats,  Up: Floating-point Functions
  1061. Combined Initialization and Assignment Functions
  1062. ------------------------------------------------
  1063.    For convenience, MP provides a parallel series of initialize-and-set
  1064. functions which initialize the output and then store the value there.
  1065. These functions' names have the form `mpf_init_set...'
  1066.    Once the float has been initialized by any of the `mpf_init_set...'
  1067. functions, it can be used as the source or destination operand for the
  1068. ordinary float functions.  Don't use an initialize-and-set function on
  1069. a variable already initialized!
  1070.  - Function: void mpf_init_set (mpf_t ROP, mpf_t OP)
  1071.  - Function: void mpf_init_set_ui (mpf_t ROP, unsigned long int OP)
  1072.  - Function: void mpf_init_set_si (mpf_t ROP, signed long int OP)
  1073.  - Function: void mpf_init_set_d (mpf_t ROP, double OP)
  1074.      Initialize ROP and set its value from OP.
  1075.      The precision of ROP will be taken from the active default
  1076.      precision, as set by `mpf_set_default_prec'.
  1077.  - Function: int mpf_init_set_str (mpf_t ROP, char *STR, int BASE)
  1078.      Initialize ROP and set its value from the string in STR.  See
  1079.      `mpf_set_str' above for details on the assignment operation.
  1080.      Note that ROP is initialized even if an error occurs.  (I.e., you
  1081.      have to call `mpf_clear' for it.)
  1082.      The precision of ROP will be taken from the active default
  1083.      precision, as set by `mpf_set_default_prec'.
  1084. File: gmp.info,  Node: Converting Floats,  Next: Float Arithmetic,  Prev: Simultaneous Float Init & Assign,  Up: Floating-point Functions
  1085. Conversion Functions
  1086. ====================
  1087.  - Function: double mpf_get_d (mpf_t OP)
  1088.      Convert OP to a double.
  1089.  - Function: char * mpf_get_str (char *STR, mp_exp_t *EXPPTR, int BASE,
  1090.           size_t N_DIGITS, mpf_t OP)
  1091.      Convert OP to a string of digits in base BASE.  The base may vary
  1092.      from 2 to 36.  Generate at most N_DIGITS significant digits, or if
  1093.      N_DIGITS is 0, the maximum number of digits accurately
  1094.      representable by OP.
  1095.      If STR is NULL, space for the mantissa is allocated using the
  1096.      default allocation function, and a pointer to the string is
  1097.      returned.
  1098.      If STR is not NULL, it should point to a block of storage enough
  1099.      large for the mantissa, i.e., N_DIGITS + 2.  The two extra bytes
  1100.      are for a possible minus sign, and for the terminating null
  1101.      character.
  1102.      The exponent is written through the pointer EXPPTR.
  1103.      If N_DIGITS is 0, the maximum number of digits meaningfully
  1104.      achievable from the precision of OP will be generated.  Note that
  1105.      the space requirements for STR in this case will be impossible for
  1106.      the user to predetermine.  Therefore, you need to pass NULL for
  1107.      the string argument whenever N_DIGITS is 0.
  1108.      The generated string is a fraction, with an implicit radix point
  1109.      immediately to the left of the first digit.  For example, the
  1110.      number 3.1416 would be returned as "31416" in the string and 1
  1111.      written at EXPPTR.
  1112. File: gmp.info,  Node: Float Arithmetic,  Next: Float Comparison,  Prev: Converting Floats,  Up: Floating-point Functions
  1113. Arithmetic Functions
  1114. ====================
  1115.  - Function: void mpf_add (mpf_t ROP, mpf_t OP1, mpf_t OP2)
  1116.  - Function: void mpf_add_ui (mpf_t ROP, mpf_t OP1, unsigned long int
  1117.           OP2)
  1118.      Set ROP to OP1 + OP2.
  1119.  - Function: void mpf_sub (mpf_t ROP, mpf_t OP1, mpf_t OP2)
  1120.  - Function: void mpf_ui_sub (mpf_t ROP, unsigned long int OP1, mpf_t
  1121.           OP2)
  1122.  - Function: void mpf_sub_ui (mpf_t ROP, mpf_t OP1, unsigned long int
  1123.           OP2)
  1124.      Set ROP to OP1 - OP2.
  1125.  - Function: void mpf_mul (mpf_t ROP, mpf_t OP1, mpf_t OP2)
  1126.  - Function: void mpf_mul_ui (mpf_t ROP, mpf_t OP1, unsigned long int
  1127.           OP2)
  1128.      Set ROP to OP1 times OP2.
  1129.    Division is undefined if the divisor is zero, and passing a zero
  1130. divisor to the divide functions will make these functions intentionally
  1131. divide by zero.  This gives the user the possibility to handle
  1132. arithmetic exceptions in these functions in the same manner as other
  1133. arithmetic exceptions.
  1134.  - Function: void mpf_div (mpf_t ROP, mpf_t OP1, mpf_t OP2)
  1135.  - Function: void mpf_ui_div (mpf_t ROP, unsigned long int OP1, mpf_t
  1136.           OP2)
  1137.  - Function: void mpf_div_ui (mpf_t ROP, mpf_t OP1, unsigned long int
  1138.           OP2)
  1139.      Set ROP to OP1/OP2.
  1140.  - Function: void mpf_sqrt (mpf_t ROP, mpf_t OP)
  1141.  - Function: void mpf_sqrt_ui (mpf_t ROP, unsigned long int OP)
  1142.      Set ROP to the square root of OP.
  1143.  - Function: void mpf_neg (mpf_t ROP, mpf_t OP)
  1144.      Set ROP to -OP.
  1145.  - Function: void mpf_abs (mpf_t ROP, mpf_t OP)
  1146.      Set ROP to the absolute value of OP.
  1147.  - Function: void mpf_mul_2exp (mpf_t ROP, mpf_t OP1, unsigned long int
  1148.           OP2)
  1149.      Set ROP to OP1 times 2 raised to OP2.
  1150.  - Function: void mpf_div_2exp (mpf_t ROP, mpf_t OP1, unsigned long int
  1151.           OP2)
  1152.      Set ROP to OP1 divided by 2 raised to OP2.
  1153. File: gmp.info,  Node: Float Comparison,  Next: I/O of Floats,  Prev: Float Arithmetic,  Up: Floating-point Functions
  1154. Comparison Functions
  1155. ====================
  1156.  - Function: int mpf_cmp (mpf_t OP1, mpf_t OP2)
  1157.  - Function: int mpf_cmp_ui (mpf_t OP1, unsigned long int OP2)
  1158.  - Function: int mpf_cmp_si (mpf_t OP1, signed long int OP2)
  1159.      Compare OP1 and OP2.  Return a positive value if OP1 > OP2, zero
  1160.      if OP1 = OP2, and a negative value if OP1 < OP2.
  1161.  - Function: int mpf_eq (mpf_t OP1, mpf_t OP2, unsigned long int op3)
  1162.      Return non-zero if the first OP3 bits of OP1 and OP2 are equal,
  1163.      zero otherwise.  I.e., test of OP1 and OP2 are approximately equal.
  1164.  - Function: void mpf_reldiff (mpf_t ROP, mpf_t OP1, mpf_t OP2)
  1165.      Compute the relative difference between OP1 and OP2 and store the
  1166.      result in ROP.
  1167.  - Macro: int mpf_sgn (mpf_t OP)
  1168.      Return +1 if OP > 0, 0 if OP = 0, and -1 if OP < 0.
  1169.      This function is actually implemented as a macro.  It evaluates its
  1170.      arguments multiple times.
  1171. File: gmp.info,  Node: I/O of Floats,  Next: Miscellaneous Float Functions,  Prev: Float Comparison,  Up: Floating-point Functions
  1172. Input and Output Functions
  1173. ==========================
  1174.    Functions that perform input from a stdio stream, and functions that
  1175. output to a stdio stream.  Passing a NULL pointer for a STREAM argument
  1176. to any of these functions will make them read from `stdin' and write to
  1177. `stdout', respectively.
  1178.    When using any of these functions, it is a good idea to include
  1179. `stdio.h' before `gmp.h', since that will allow `gmp.h' to define
  1180. prototypes for these functions.
  1181.  - Function: size_t mpf_out_str (FILE *STREAM, int BASE, size_t
  1182.           N_DIGITS, mpf_t OP)
  1183.      Output OP on stdio stream STREAM, as a string of digits in base
  1184.      BASE.  The base may vary from 2 to 36.  Print at most N_DIGITS
  1185.      significant digits, or if N_DIGITS is 0, the maximum number of
  1186.      digits accurately representable by OP.
  1187.      In addition to the significant digits, a leading `0.' and a
  1188.      trailing exponent, in the form `eNNN', are printed.  If BASE is
  1189.      greater than 10, `@' will be used instead of `e' as exponent
  1190.      delimiter.
  1191.      Return the number of bytes written, or if an error occurred,
  1192.      return 0.
  1193.  - Function: size_t mpf_inp_str (mpf_t ROP, FILE *STREAM, int BASE)
  1194.      Input a string in base BASE from stdio stream STREAM, and put the
  1195.      read float in ROP.  The string is of the form `M@N' or, if the
  1196.      base is 10 or less, alternatively `MeN'.  `M' is the mantissa and
  1197.      `N' is the exponent.  The mantissa is always in the specified
  1198.      base.  The exponent is either in the specified base or, if BASE is
  1199.      negative, in decimal.
  1200.      The argument BASE may be in the ranges 2 to 36, or -36 to -2.
  1201.      Negative values are used to specify that the exponent is in
  1202.      decimal.
  1203.      Unlike the corresponding `mpz' function, the base will not be
  1204.      determined from the leading characters of the string if BASE is 0.
  1205.      This is so that numbers like `0.23' are not interpreted as octal.
  1206.      Return the number of bytes read, or if an error occurred, return 0.
  1207. File: gmp.info,  Node: Miscellaneous Float Functions,  Prev: I/O of Floats,  Up: Floating-point Functions
  1208. Miscellaneous Functions
  1209. =======================
  1210.  - Function: void mpf_random2 (mpf_t ROP, mp_size_t MAX_SIZE, mp_exp_t
  1211.           MAX_EXP)
  1212.      Generate a random float of at most MAX_SIZE limbs, with long
  1213.      strings of zeros and ones in the binary representation.  The
  1214.      exponent of the number is in the interval -EXP to EXP.  This
  1215.      function is useful for testing functions and algorithms, since
  1216.      this kind of random numbers have proven to be more likely to
  1217.      trigger corner-case bugs.  Negative random numbers are generated
  1218.      when MAX_SIZE is negative.
  1219. File: gmp.info,  Node: Low-level Functions,  Next: BSD Compatible Functions,  Prev: Floating-point Functions,  Up: Top
  1220. Low-level Functions
  1221. *******************
  1222.    This chapter describes low-level MP functions, used to implement the
  1223. high-level MP functions, but also intended for time-critical user code.
  1224.    These functions start with the prefix `mpn_'.
  1225.    The `mpn' functions are designed to be as fast as possible, *not* to
  1226. provide a coherent calling interface.  The different functions have
  1227. somewhat similar interfaces, but there are variations that make them
  1228. hard to use.  These functions do as little as possible apart from the
  1229. real multiple precision computation, so that no time is spent on things
  1230. that not all callers need.
  1231.    A source operand is specified by a pointer to the least significant
  1232. limb and a limb count.  A destination operand is specified by just a
  1233. pointer.  It is the responsibility of the caller to ensure that the
  1234. destination has enough space for storing the result.
  1235.    With this way of specifying operands, it is possible to perform
  1236. computations on subranges of an argument, and store the result into a
  1237. subrange of a destination.
  1238.    A common requirement for all functions is that each source area
  1239. needs at least one limb.  No size argument may be zero.
  1240.    The `mpn' functions is the base for the implementation of the `mpz_',
  1241. `mpf_', and `mpq_' functions.
  1242.    This example adds the number beginning at SRC1_PTR and the number
  1243. beginning at SRC2_PTR and writes the sum at DEST_PTR.  All areas have
  1244. SIZE limbs.
  1245.      cy = mpn_add_n (dest_ptr, src1_ptr, src2_ptr, size)
  1246. In the notation used here, a source operand is identified by the
  1247. pointer to the least significant limb, and the limb count in braces.
  1248. For example, {s1_ptr, s1_size}.
  1249.  - Function: mp_limb_t mpn_add_n (mp_limb_t * DEST_PTR, const mp_limb_t
  1250.           * SRC1_PTR, const mp_limb_t * SRC2_PTR, mp_size_t SIZE)
  1251.      Add {SRC1_PTR, SIZE} and {SRC2_PTR, SIZE}, and write the SIZE
  1252.      least significant limbs of the result to DEST_PTR.  Return carry,
  1253.      either 0 or 1.
  1254.      This is the lowest-level function for addition.  It is the
  1255.      preferred function for addition, since it is written in assembly
  1256.      for most targets.  For addition of a variable to itself (i.e.,
  1257.      SRC1_PTR equals SRC2_PTR, use `mpn_lshift' with a count of 1 for
  1258.      optimal speed.
  1259.  - Function: mp_limb_t mpn_add_1 (mp_limb_t * DEST_PTR, const mp_limb_t
  1260.           * SRC1_PTR, mp_size_t SIZE, mp_limb_t SRC2_LIMB)
  1261.      Add {SRC1_PTR, SIZE} and SRC2_LIMB, and write the SIZE least
  1262.      significant limbs of the result to DEST_PTR.  Return carry, either
  1263.      0 or 1.
  1264.  - Function: mp_limb_t mpn_add (mp_limb_t * DEST_PTR, const mp_limb_t *
  1265.           SRC1_PTR, mp_size_t SRC1_SIZE, const mp_limb_t * SRC2_PTR,
  1266.           mp_size_t SRC2_SIZE)
  1267.      Add {SRC1_PTR, SRC1_SIZE} and {SRC2_PTR, SRC2_SIZE}, and write the
  1268.      SRC1_SIZE least significant limbs of the result to DEST_PTR.
  1269.      Return carry, either 0 or 1.
  1270.      This function requires that SRC1_SIZE is greater than or equal to
  1271.      SRC2_SIZE.
  1272.  - Function: mp_limb_t mpn_sub_n (mp_limb_t * DEST_PTR, const mp_limb_t
  1273.           * SRC1_PTR, const mp_limb_t * SRC2_PTR, mp_size_t SIZE)
  1274.      Subtract {SRC2_PTR, SRC2_SIZE} from {SRC1_PTR, SIZE}, and write
  1275.      the SIZE least significant limbs of the result to DEST_PTR.
  1276.      Return borrow, either 0 or 1.
  1277.      This is the lowest-level function for subtraction.  It is the
  1278.      preferred function for subtraction, since it is written in
  1279.      assembly for most targets.
  1280.  - Function: mp_limb_t mpn_sub_1 (mp_limb_t * DEST_PTR, const mp_limb_t
  1281.           * SRC1_PTR, mp_size_t SIZE, mp_limb_t SRC2_LIMB)
  1282.      Subtract SRC2_LIMB from {SRC1_PTR, SIZE}, and write the SIZE least
  1283.      significant limbs of the result to DEST_PTR.  Return borrow,
  1284.      either 0 or 1.
  1285.  - Function: mp_limb_t mpn_sub (mp_limb_t * DEST_PTR, const mp_limb_t *
  1286.           SRC1_PTR, mp_size_t SRC1_SIZE, const mp_limb_t * SRC2_PTR,
  1287.           mp_size_t SRC2_SIZE)
  1288.      Subtract {SRC2_PTR, SRC2_SIZE} from {SRC1_PTR, SRC1_SIZE}, and
  1289.      write the SRC1_SIZE least significant limbs of the result to
  1290.      DEST_PTR.  Return borrow, either 0 or 1.
  1291.      This function requires that SRC1_SIZE is greater than or equal to
  1292.      SRC2_SIZE.
  1293.  - Function: void mpn_mul_n (mp_limb_t * DEST_PTR, const mp_limb_t *
  1294.           SRC1_PTR, const mp_limb_t * SRC2_PTR, mp_size_t SIZE)
  1295.      Multiply {SRC1_PTR, SIZE} and {SRC2_PTR, SIZE}, and write the
  1296.      *entire* result to DEST_PTR.
  1297.      The destination has to have space for 2SIZE limbs, even if the
  1298.      significant result might be one limb smaller.
  1299.  - Function: mp_limb_t mpn_mul_1 (mp_limb_t * DEST_PTR, const mp_limb_t
  1300.           * SRC1_PTR, mp_size_t SIZE, mp_limb_t SRC2_LIMB)
  1301.      Multiply {SRC1_PTR, SIZE} and SRC2_LIMB, and write the SIZE least
  1302.      significant limbs of the product to DEST_PTR.  Return the most
  1303.      significant limb of the product.
  1304.      This is a low-level function that is a building block for general
  1305.      multiplication as well as other operations in MP.  It is written
  1306.      in assembly for most targets.
  1307.      Don't call this function if SRC2_LIMB is a power of 2; use
  1308.      `mpn_lshift' with a count equal to the logarithm of SRC2_LIMB
  1309.      instead, for optimal speed.
  1310.  - Function: mp_limb_t mpn_addmul_1 (mp_limb_t * DEST_PTR, const
  1311.           mp_limb_t * SRC1_PTR, mp_size_t SIZE, mp_limb_t SRC2_LIMB)
  1312.      Multiply {SRC1_PTR, SIZE} and SRC2_LIMB, and add the SIZE least
  1313.      significant limbs of the product to {DEST_PTR, SIZE} and write the
  1314.      result to DEST_PTR DEST_PTR.  Return the most significant limb of
  1315.      the product, plus carry-out from the addition.
  1316.      This is a low-level function that is a building block for general
  1317.      multiplication as well as other operations in MP.  It is written
  1318.      in assembly for most targets.
  1319.  - Function: mp_limb_t mpn_submul_1 (mp_limb_t * DEST_PTR, const
  1320.           mp_limb_t * SRC1_PTR, mp_size_t SIZE, mp_limb_t SRC2_LIMB)
  1321.      Multiply {SRC1_PTR, SIZE} and SRC2_LIMB, and subtract the SIZE
  1322.      least significant limbs of the product from {DEST_PTR, SIZE} and
  1323.      write the result to DEST_PTR.  Return the most significant limb of
  1324.      the product, minus borrow-out from the subtraction.
  1325.      This is a low-level function that is a building block for general
  1326.      multiplication and division as well as other operations in MP.  It
  1327.      is written in assembly for most targets.
  1328.  - Function: mp_limb_t mpn_mul (mp_limb_t * DEST_PTR, const mp_limb_t *
  1329.           SRC1_PTR, mp_size_t SRC1_SIZE, const mp_limb_t * SRC2_PTR,
  1330.           mp_size_t SRC2_SIZE)
  1331.      Multiply {SRC1_PTR, SRC1_SIZE} and {SRC2_PTR, SRC2_SIZE}, and
  1332.      write the result to DEST_PTR.  Return the most significant limb of
  1333.      the result.
  1334.      The destination has to have space for SRC1_SIZE + SRC1_SIZE limbs,
  1335.      even if the result might be one limb smaller.
  1336.      This function requires that SRC1_SIZE is greater than or equal to
  1337.      SRC2_SIZE.  The destination must be distinct from either input
  1338.      operands.
  1339.  - Function: mp_size_t mpn_divrem (mp_limb_t * R1P, mp_size_t XSIZE,
  1340.           mp_limb_t * RS2P, mp_size_t RS2SIZE, const mp_limb_t * S3P,
  1341.           mp_size_t S3SIZE)
  1342.      Divide {RS2P, RS2SIZE} by {S3P, S3SIZE}, and write the quotient at
  1343.      R1P, with the exception of the most significant limb, which is
  1344.      returned.  The remainder replaces the dividend at RS2P.
  1345.      In addition to an integer quotient, XSIZE fraction limbs are
  1346.      developed, and stored after the integral limbs.  For most usages,
  1347.      XSIZE will be zero.
  1348.      It is required that RS2SIZE is greater than or equal to S3SIZE.
  1349.      It is required that the most significant bit of the divisor is set.
  1350.      If the quotient is not needed, pass RS2P + S3SIZE as R1P.  Aside
  1351.      from that special case, no overlap between arguments is permitted.
  1352.      Return the most significant limb of the quotient, either 0 or 1.
  1353.      The area at R1P needs to be RS2SIZE - S3SIZE + XSIZE limbs large.
  1354.  - Function: mp_limb_t mpn_divrem_1 (mp_limb_t * R1P, mp_size_t XSIZE,
  1355.           mp_limb_t * S2P, mp_size_t S2SIZE, mp_limb_t S3LIMB)
  1356.      Divide {S2P, S2SIZE} by S3LIMB, and write the quotient at R1P.
  1357.      Return the remainder.
  1358.      In addition to an integer quotient, XSIZE fraction limbs are
  1359.      developed, and stored after the integral limbs.  For most usages,
  1360.      XSIZE will be zero.
  1361.      The areas at R1P and S2P have to be identical or completely
  1362.      separate, not partially overlapping.
  1363.  - Function: mp_size_t mpn_divmod (mp_limb_t * R1P, mp_limb_t * RS2P,
  1364.           mp_size_t RS2SIZE, const mp_limb_t * S3P, mp_size_t S3SIZE)
  1365.      *This interface is obsolete.  It will disappear from future
  1366.      releases.  Use `mpn_divrem' in its stead.*
  1367.  - Function: mp_limb_t mpn_divmod_1 (mp_limb_t * R1P, mp_limb_t * S2P,
  1368.           mp_size_t S2SIZE, mp_limb_t S3LIMB)
  1369.      *This interface is obsolete.  It will disappear from future
  1370.      releases.  Use `mpn_divrem_1' in its stead.*
  1371.  - Function: mp_limb_t mpn_mod_1 (mp_limb_t * S1P, mp_size_t S1SIZE,
  1372.           mp_limb_t S2LIMB)
  1373.      Divide {S1P, S1SIZE} by S2LIMB, and return the remainder.
  1374.  - Function: mp_limb_t mpn_preinv_mod_1 (mp_limb_t * S1P, mp_size_t
  1375.           S1SIZE, mp_limb_t S2LIMB, mp_limb_t S3LIMB)
  1376.      *This interface is obsolete.  It will disappear from future
  1377.      releases.  Use `mpn_mod_1' in its stead.*
  1378.  - Function: mp_limb_t mpn_bdivmod (mp_limb_t * DEST_PTR, mp_limb_t *
  1379.           S1P, mp_size_t S1SIZE, const mp_limb_t * S2P, mp_size_t
  1380.           S2SIZE, unsigned long int D)
  1381.      The function puts the low [D/BITS_PER_MP_LIMB] limbs of Q = {S1P,
  1382.      S1SIZE}/{S2P, S2SIZE} mod 2^D at DEST_PTR, and returns the high D
  1383.      mod BITS_PER_MP_LIMB bits of Q.
  1384.      {S1P, S1SIZE} - Q * {S2P, S2SIZE} mod 2^(S1SIZE*BITS_PER_MP_LIMB)
  1385.      is placed at S1P.  Since the low [D/BITS_PER_MP_LIMB] limbs of
  1386.      this difference are zero, it is possible to overwrite the low
  1387.      limbs at S1P with this difference, provided DEST_PTR <= S1P.
  1388.      This function requires that S1SIZE * BITS_PER_MP_LIMB >= D, and
  1389.      that {S2P, S2SIZE} is odd.
  1390.      *This interface is preliminary.  It might change incompatibly in
  1391.      future revisions.*
  1392.  - Function: mp_limb_t mpn_lshift (mp_limb_t * DEST_PTR, const
  1393.           mp_limb_t * SRC_PTR, mp_size_t SRC_SIZE, unsigned long int
  1394.           COUNT)
  1395.      Shift {SRC_PTR, SRC_SIZE} COUNT bits to the left, and write the
  1396.      SRC_SIZE least significant limbs of the result to DEST_PTR.  COUNT
  1397.      might be in the range 1 to n - 1, on an n-bit machine. The bits
  1398.      shifted out to the left are returned.
  1399.      Overlapping of the destination space and the source space is
  1400.      allowed in this function, provided DEST_PTR >= SRC_PTR.
  1401.      This function is written in assembly for most targets.
  1402.  - Function: mp_limp_t mpn_rshift (mp_limb_t * DEST_PTR, const
  1403.           mp_limb_t * SRC_PTR, mp_size_t SRC_SIZE, unsigned long int
  1404.           COUNT)
  1405.      Shift {SRC_PTR, SRC_SIZE} COUNT bits to the right, and write the
  1406.      SRC_SIZE most significant limbs of the result to DEST_PTR.  COUNT
  1407.      might be in the range 1 to n - 1, on an n-bit machine.  The bits
  1408.      shifted out to the right are returned.
  1409.      Overlapping of the destination space and the source space is
  1410.      allowed in this function, provided DEST_PTR <= SRC_PTR.
  1411.      This function is written in assembly for most targets.
  1412.  - Function: int mpn_cmp (const mp_limb_t * SRC1_PTR, const mp_limb_t *
  1413.           SRC2_PTR, mp_size_t SIZE)
  1414.      Compare {SRC1_PTR, SIZE} and {SRC2_PTR, SIZE} and return a
  1415.      positive value if src1 > src2, 0 of they are equal, and a negative
  1416.      value if src1 < src2.
  1417.  - Function: mp_size_t mpn_gcd (mp_limb_t * DEST_PTR, mp_limb_t *
  1418.           SRC1_PTR, mp_size_t SRC1_SIZE, mp_limb_t * SRC2_PTR,
  1419.           mp_size_t SRC2_SIZE)
  1420.      Puts at DEST_PTR the greatest common divisor of {SRC1_PTR,
  1421.      SRC1_SIZE} and {SRC2_PTR, SRC2_SIZE}; both source operands are
  1422.      destroyed by the operation.  The size in limbs of the greatest
  1423.      common divisor is returned.
  1424.      {SRC1_PTR, SRC1_SIZE} must be odd, and {SRC2_PTR, SRC2_SIZE} must
  1425.      have at least as many bits as {SRC1_PTR, SRC1_SIZE}.
  1426.      *This interface is preliminary.  It might change incompatibly in
  1427.      future revisions.*
  1428.  - Function: mp_limb_t mpn_gcd_1 (const mp_limb_t * SRC1_PTR, mp_size_t
  1429.           SRC1_SIZE, mp_limb_t SRC2_LIMB)
  1430.      Return the greatest common divisor of {SRC1_PTR, SRC1_SIZE} and
  1431.      SRC2_LIMB, where SRC2_LIMB (as well as SRC1_SIZE) must be
  1432.      different from 0.
  1433.  - Function: mp_size_t mpn_gcdext (mp_limb_t * R1P, mp_limb_t * R2P,
  1434.           mp_limb_t * S1P, mp_size_t S1SIZE, mp_limb_t * S2P, mp_size_t
  1435.           S2SIZE)
  1436.      Puts at R1P the greatest common divisor of {S1P, S1SIZE} and {S2P,
  1437.      S2SIZE}.  The first cofactor is written at R2P.  Both source
  1438.      operands are destroyed by the operation.  The size in limbs of the
  1439.      greatest common divisor is returned.
  1440.      *This interface is preliminary.  It might change incompatibly in
  1441.      future revisions.*
  1442.  - Function: mp_size_t mpn_sqrtrem (mp_limb_t * R1P, mp_limb_t * R2P,
  1443.           const mp_limb_t * SP, mp_size_t SIZE)
  1444.      Compute the square root of {SP, SIZE} and put the result at R1P.
  1445.      Write the remainder at R2P, unless R2P is NULL.
  1446.      Return the size of the remainder, whether R2P was NULL or non-NULL.
  1447.      Iff the operand was a perfect square, the return value will be 0.
  1448.      The areas at R1P and SP have to be distinct.  The areas at R2P and
  1449.      SP have to be identical or completely separate, not partially
  1450.      overlapping.
  1451.      The area at R1P needs to have space for ceil(SIZE/2) limbs.  The
  1452.      area at R2P needs to be SIZE limbs large.
  1453.      *This interface is preliminary.  It might change incompatibly in
  1454.      future revisions.*
  1455.  - Function: mp_size_t mpn_get_str (unsigned char *STR, int BASE,
  1456.           mp_limb_t * S1P, mp_size_t S1SIZE)
  1457.      Convert {S1P, S1SIZE} to a raw unsigned char array in base BASE.
  1458.      The string is not in ASCII; to convert it to printable format, add
  1459.      the ASCII codes for `0' or `A', depending on the base and range.
  1460.      There may be leading zeros in the string.
  1461.      The area at S1P is clobbered.
  1462.      Return the number of characters in STR.
  1463.      The area at STR has to have space for the largest possible number
  1464.      represented by a S1SIZE long limb array, plus one extra character.
  1465.  - Function: mp_size_t mpn_set_str (mp_limb_t * R1P, const char *STR,
  1466.           size_t strsize, int BASE)
  1467.      Convert the raw unsigned char array at STR of length STRSIZE to a
  1468.      limb array {S1P, S1SIZE}.  The base of STR is BASE.
  1469.      Return the number of limbs stored in R1P.
  1470.  - Function: unsigned long int mpn_scan0 (const mp_limb_t * S1P,
  1471.           unsigned long int BIT)
  1472.      Scan S1P from bit position BIT for the next clear bit.
  1473.      It is required that there be a clear bit within the area at S1P at
  1474.      or beyond bit position BIT, so that the function has something to
  1475.      return.
  1476.      *This interface is preliminary.  It might change incompatibly in
  1477.      future revisions.*
  1478.  - Function: unsigned long int mpn_scan1 (const mp_limb_t * S1P,
  1479.           unsigned long int BIT)
  1480.      Scan S1P from bit position BIT for the next set bit.
  1481.      It is required that there be a set bit within the area at S1P at or
  1482.      beyond bit position BIT, so that the function has something to
  1483.      return.
  1484.      *This interface is preliminary.  It might change incompatibly in
  1485.      future revisions.*
  1486.  - Function: void mpn_random2 (mp_limb_t * R1P, mp_size_t R1SIZE)
  1487.      Generate a random number of length R1SIZE with long strings of
  1488.      zeros and ones in the binary representation, and store it at R1P.
  1489.      The generated random numbers are intended for testing the
  1490.      correctness of the implementation of the `mpn' routines.
  1491.  - Function: unsigned long int mpn_popcount (const mp_limb_t * S1P,
  1492.           unsigned long int SIZE)
  1493.      Count the number of set bits in {S1P, SIZE}.
  1494.  - Function: unsigned long int mpn_hamdist (const mp_limb_t * S1P,
  1495.           const mp_limb_t * S2P, unsigned long int SIZE)
  1496.      Compute the hamming distance between {S1P, SIZE} and {S2P, SIZE}.
  1497.  - Function: int mpn_perfect_square_p (const mp_limb_t * S1P, mp_size_t
  1498.           SIZE)
  1499.      Return non-zero iff {S1P, SIZE} is a perfect square.
  1500. File: gmp.info,  Node: BSD Compatible Functions,  Next: Custom Allocation,  Prev: Low-level Functions,  Up: Top
  1501. Berkeley MP Compatible Functions
  1502. ********************************
  1503.    These functions are intended to be fully compatible with the
  1504. Berkeley MP library which is available on many BSD derived U*ix systems.
  1505.    The original Berkeley MP library has a usage restriction: you cannot
  1506. use the same variable as both source and destination in a single
  1507. function call.  The compatible functions in GNU MP do not share this
  1508. restriction--inputs and outputs may overlap.
  1509.    It is not recommended that new programs are written using these
  1510. functions.  Apart from the incomplete set of functions, the interface
  1511. for initializing `MINT' objects is more error prone, and the `pow'
  1512. function collides with `pow' in `libm.a'.
  1513.    Include the header `mp.h' to get the definition of the necessary
  1514. types and functions.  If you are on a BSD derived system, make sure to
  1515. include GNU `mp.h' if you are going to link the GNU `libmp.a' to you
  1516. program.  This means that you probably need to give the -I<dir> option
  1517. to the compiler, where <dir> is the directory where you have GNU `mp.h'.
  1518.  - Function: MINT * itom (signed short int INITIAL_VALUE)
  1519.      Allocate an integer consisting of a `MINT' object and dynamic limb
  1520.      space.  Initialize the integer to INITIAL_VALUE.  Return a pointer
  1521.      to the `MINT' object.
  1522.  - Function: MINT * xtom (char *INITIAL_VALUE)
  1523.      Allocate an integer consisting of a `MINT' object and dynamic limb
  1524.      space.  Initialize the integer from INITIAL_VALUE, a hexadecimal,
  1525.      '\0'-terminate C string.  Return a pointer to the `MINT' object.
  1526.  - Function: void move (MINT *SRC, MINT *DEST)
  1527.      Set DEST to SRC by copying.  Both variables must be previously
  1528.      initialized.
  1529.  - Function: void madd (MINT *SRC_1, MINT *SRC_2, MINT *DESTINATION)
  1530.      Add SRC_1 and SRC_2 and put the sum in DESTINATION.
  1531.  - Function: void msub (MINT *SRC_1, MINT *SRC_2, MINT *DESTINATION)
  1532.      Subtract SRC_2 from SRC_1 and put the difference in DESTINATION.
  1533.  - Function: void mult (MINT *SRC_1, MINT *SRC_2, MINT *DESTINATION)
  1534.      Multiply SRC_1 and SRC_2 and put the product in DESTINATION.
  1535.  - Function: void mdiv (MINT *DIVIDEND, MINT *DIVISOR, MINT *QUOTIENT,
  1536.           MINT *REMAINDER)
  1537.  - Function: void sdiv (MINT *DIVIDEND, signed short int DIVISOR, MINT
  1538.           *QUOTIENT, signed short int *REMAINDER)
  1539.      Set QUOTIENT to DIVIDEND/DIVISOR, and REMAINDER to DIVIDEND mod
  1540.      DIVISOR.  The quotient is rounded towards zero; the remainder has
  1541.      the same sign as the dividend unless it is zero.
  1542.      Some implementations of these functions work differently--or not
  1543.      at all--for negative arguments.
  1544.  - Function: void msqrt (MINT *OPERAND, MINT *ROOT, MINT *REMAINDER)
  1545.      Set ROOT to the truncated integer part of the square root of
  1546.      OPERAND.  Set REMAINDER to OPERAND-ROOT*ROOT, (i.e., zero if
  1547.      OPERAND is a perfect square).
  1548.      If ROOT and REMAINDER are the same variable, the results are
  1549.      undefined.
  1550.  - Function: void pow (MINT *BASE, MINT *EXP, MINT *MOD, MINT *DEST)
  1551.      Set DEST to (BASE raised to EXP) modulo MOD.
  1552.  - Function: void rpow (MINT *BASE, signed short int EXP, MINT *DEST)
  1553.      Set DEST to BASE raised to EXP.
  1554.  - Function: void gcd (MINT *OPERAND1, MINT *OPERAND2, MINT *RES)
  1555.      Set RES to the greatest common divisor of OPERAND1 and OPERAND2.
  1556.  - Function: int mcmp (MINT *OPERAND1, MINT *OPERAND2)
  1557.      Compare OPERAND1 and OPERAND2.  Return a positive value if
  1558.      OPERAND1 > OPERAND2, zero if OPERAND1 = OPERAND2, and a negative
  1559.      value if OPERAND1 < OPERAND2.
  1560.  - Function: void min (MINT *DEST)
  1561.      Input a decimal string from `stdin', and put the read integer in
  1562.      DEST.  SPC and TAB are allowed in the number string, and are
  1563.      ignored.
  1564.  - Function: void mout (MINT *SRC)
  1565.      Output SRC to `stdout', as a decimal string.  Also output a
  1566.      newline.
  1567.  - Function: char * mtox (MINT *OPERAND)
  1568.      Convert OPERAND to a hexadecimal string, and return a pointer to
  1569.      the string.  The returned string is allocated using the default
  1570.      memory allocation function, `malloc' by default.
  1571.  - Function: void mfree (MINT *OPERAND)
  1572.      De-allocate, the space used by OPERAND.  *This function should
  1573.      only be passed a value returned by `itom' or `xtom'.*
  1574. File: gmp.info,  Node: Custom Allocation,  Next: Contributors,  Prev: BSD Compatible Functions,  Up: Top
  1575. Custom Allocation
  1576. *****************
  1577.    By default, the MP functions use `malloc', `realloc', and `free' for
  1578. memory allocation.  If `malloc' or `realloc' fails, the MP library
  1579. terminates execution after printing a fatal error message to standard
  1580. error.
  1581.    For some applications, you may wish to allocate memory in other
  1582. ways, or you may not want to have a fatal error when there is no more
  1583. memory available.  To accomplish this, you can specify alternative
  1584. memory allocation functions.
  1585.  - Function: void mp_set_memory_functions (
  1586.           void *(*ALLOC_FUNC_PTR) (size_t),
  1587.           void *(*REALLOC_FUNC_PTR) (void *, size_t, size_t),
  1588.           void (*FREE_FUNC_PTR) (void *, size_t))
  1589.      Replace the current allocation functions from the arguments.  If
  1590.      an argument is NULL, the corresponding default function is
  1591.      retained.
  1592.      *Make sure to call this function in such a way that there are no
  1593.      active MP objects that were allocated using the previously active
  1594.      allocation function!  Usually, that means that you have to call
  1595.      this function before any other MP function.*
  1596.    The functions you supply should fit the following declarations:
  1597.  - Function: void * allocate_function (size_t ALLOC_SIZE)
  1598.      This function should return a pointer to newly allocated space
  1599.      with at least ALLOC_SIZE storage units.
  1600.  - Function: void * reallocate_function (void *PTR, size_t OLD_SIZE,
  1601.           size_t NEW_SIZE)
  1602.      This function should return a pointer to newly allocated space of
  1603.      at least NEW_SIZE storage units, after copying at least the first
  1604.      OLD_SIZE storage units from PTR.  It should also de-allocate the
  1605.      space at PTR.
  1606.      You can assume that the space at PTR was formerly returned from
  1607.      `allocate_function' or `reallocate_function', for a request for
  1608.      OLD_SIZE storage units.
  1609.  - Function: void deallocate_function (void *PTR, size_t SIZE)
  1610.      De-allocate the space pointed to by PTR.
  1611.      You can assume that the space at PTR was formerly returned from
  1612.      `allocate_function' or `reallocate_function', for a request for
  1613.      SIZE storage units.
  1614.    (A "storage unit" is the unit in which the `sizeof' operator returns
  1615. the size of an object, normally an 8 bit byte.)
  1616. File: gmp.info,  Node: Contributors,  Next: References,  Prev: Custom Allocation,  Up: Top
  1617. Contributors
  1618. ************
  1619.    I would like to thank Gunnar Sjoedin and Hans Riesel for their help
  1620. with mathematical problems, Richard Stallman for his help with design
  1621. issues and for revising the first version of this manual, Brian Beuning
  1622. and Doug Lea for their testing of early versions of the library.
  1623.    John Amanatides of York University in Canada contributed the function
  1624. `mpz_probab_prime_p'.
  1625.    Paul Zimmermann of Inria sparked the development of GMP 2, with his
  1626. comparisons between bignum packages.
  1627.    Ken Weber (Kent State University, Universidade Federal do Rio Grande
  1628. do Sul) contributed `mpz_gcd', `mpz_divexact', `mpn_gcd', and
  1629. `mpn_bdivmod', partially supported by CNPq (Brazil) grant 301314194-2.
  1630.    Per Bothner of Cygnus Support helped to set up MP to use Cygnus'
  1631. configure.  He has also made valuable suggestions and tested numerous
  1632. intermediary releases.
  1633.    Joachim Hollman was involved in the design of the `mpf' interface,
  1634. and in the `mpz' design revisions for version 2.
  1635.    Bennet Yee contributed the functions `mpz_jacobi' and `mpz_legendre'.
  1636.    Andreas Schwab contributed the files `mpn/m68k/lshift.S' and
  1637. `mpn/m68k/rshift.S'.
  1638.    The development of floating point functions of GNU MP 2, were
  1639. supported in part by the ESPRIT-BRA (Basic Research Activities) 6846
  1640. project POSSO (POlynomial System SOlving).
  1641.    GNU MP 2 was finished and released by TMG Datakonsult,
  1642. Sodermannagatan 5, 116 23 STOCKHOLM, SWEDEN, in cooperation with the
  1643. IDA Center for Computing Sciences, USA.
  1644. File: gmp.info,  Node: References,  Prev: Contributors,  Up: Top
  1645. References
  1646. **********
  1647.    * Donald E. Knuth, "The Art of Computer Programming", vol 2,
  1648.      "Seminumerical Algorithms", 2nd edition, Addison-Wesley, 1981.
  1649.    * John D. Lipson, "Elements of Algebra and Algebraic Computing", The
  1650.      Benjamin Cummings Publishing Company Inc, 1981.
  1651.    * Richard M. Stallman, "Using and Porting GCC", Free Software
  1652.      Foundation, 1995.
  1653.    * Peter L. Montgomery, "Modular Multiplication Without Trial
  1654.      Division", in Mathematics of Computation, volume 44, number 170,
  1655.      April 1985.
  1656.    * Torbjorn Granlund and Peter L. Montgomery, "Division by Invariant
  1657.      Integers using Multiplication", in Proceedings of the SIGPLAN
  1658.      PLDI'94 Conference, June 1994.
  1659.    * Tudor Jebelean, "An algorithm for exact division", Journal of
  1660.      Symbolic Computation, v. 15, 1993, pp. 169-180.
  1661.    * Kenneth Weber, "The accelerated integer GCD algorithm", ACM
  1662.      Transactions on Mathematical Software, v. 21 (March), 1995, pp.
  1663.      111-122.
  1664. File: gmp.info,  Node: Concept Index,  Up: Top
  1665. Concept Index
  1666. *************
  1667. * Menu:
  1668. * gmp.h:                                MP Basics.
  1669. * mp.h:                                 BSD Compatible Functions.
  1670. * Arithmetic functions <1>:             Integer Arithmetic.
  1671. * Arithmetic functions:                 Float Arithmetic.
  1672. * Bit manipulation functions:           Integer Logic and Bit Fiddling.
  1673. * BSD MP compatible functions:          BSD Compatible Functions.
  1674. * Comparison functions:                 Float Comparison.
  1675. * Conditions for copying GNU MP:        Copying.
  1676. * Conversion functions <1>:             Converting Integers.
  1677. * Conversion functions:                 Converting Floats.
  1678. * Copying conditions:                   Copying.
  1679. * Float arithmetic functions:           Float Arithmetic.
  1680. * Float assignment functions:           Assigning Floats.
  1681. * Float comparisons functions:          Float Comparison.
  1682. * Float functions:                      Floating-point Functions.
  1683. * Float input and output functions:     I/O of Floats.
  1684. * Floating-point functions:             Floating-point Functions.
  1685. * Floating-point number:                MP Basics.
  1686. * I/O functions <1>:                    I/O of Floats.
  1687. * I/O functions:                        I/O of Integers.
  1688. * Initialization and assignment functions <1>: Simultaneous Float Init & Assign.
  1689. * Initialization and assignment functions: Simultaneous Integer Init & Assign.
  1690. * Input functions <1>:                  I/O of Integers.
  1691. * Input functions:                      I/O of Floats.
  1692. * Installation:                         Installing MP.
  1693. * Integer:                              MP Basics.
  1694. * Integer arithmetic functions:         Integer Arithmetic.
  1695. * Integer assignment functions:         Assigning Integers.
  1696. * Integer conversion functions:         Converting Integers.
  1697. * Integer functions:                    Integer Functions.
  1698. * Integer input and output functions:   I/O of Integers.
  1699. * Limb:                                 MP Basics.
  1700. * Logical functions:                    Integer Logic and Bit Fiddling.
  1701. * Low-level functions:                  Low-level Functions.
  1702. * Miscellaneous float functions:        Miscellaneous Float Functions.
  1703. * Miscellaneous integer functions:      Miscellaneous Integer Functions.
  1704. * Output functions <1>:                 I/O of Floats.
  1705. * Output functions:                     I/O of Integers.
  1706. * Rational number:                      MP Basics.
  1707. * Rational number functions:            Rational Number Functions.
  1708. * Reporting bugs:                       Reporting Bugs.
  1709. * User-defined precision:               Floating-point Functions.
  1710. File: gmp.info,  Node: Function Index,  Up: Top
  1711. Function and Type Index
  1712. ***********************
  1713. * Menu:
  1714. * mp_limb_t:                            MP Basics.
  1715. * mpf_t:                                MP Basics.
  1716. * mpq_t:                                MP Basics.
  1717. * mpz_t:                                MP Basics.
  1718. * __GNU_MP_VERSION:                     MP Basics.
  1719. * __GNU_MP_VERSION_MINOR:               MP Basics.
  1720. * _mpz_realloc:                         Initializing Integers.
  1721. * allocate_function:                    Custom Allocation.
  1722. * deallocate_function:                  Custom Allocation.
  1723. * gcd:                                  BSD Compatible Functions.
  1724. * itom:                                 BSD Compatible Functions.
  1725. * madd:                                 BSD Compatible Functions.
  1726. * mcmp:                                 BSD Compatible Functions.
  1727. * mdiv:                                 BSD Compatible Functions.
  1728. * mfree:                                BSD Compatible Functions.
  1729. * min:                                  BSD Compatible Functions.
  1730. * mout:                                 BSD Compatible Functions.
  1731. * move:                                 BSD Compatible Functions.
  1732. * mp_set_memory_functions:              Custom Allocation.
  1733. * mpf_abs:                              Float Arithmetic.
  1734. * mpf_add:                              Float Arithmetic.
  1735. * mpf_add_ui:                           Float Arithmetic.
  1736. * mpf_clear:                            Initializing Floats.
  1737. * mpf_cmp:                              Float Comparison.
  1738. * mpf_cmp_si:                           Float Comparison.
  1739. * mpf_cmp_ui:                           Float Comparison.
  1740. * mpf_div:                              Float Arithmetic.
  1741. * mpf_div_2exp:                         Float Arithmetic.
  1742. * mpf_div_ui:                           Float Arithmetic.
  1743. * mpf_eq:                               Float Comparison.
  1744. * mpf_get_d:                            Converting Floats.
  1745. * mpf_get_prec:                         Initializing Floats.
  1746. * mpf_get_str:                          Converting Floats.
  1747. * mpf_init:                             Initializing Floats.
  1748. * mpf_init2:                            Initializing Floats.
  1749. * mpf_init_set:                         Simultaneous Float Init & Assign.
  1750. * mpf_init_set_d:                       Simultaneous Float Init & Assign.
  1751. * mpf_init_set_si:                      Simultaneous Float Init & Assign.
  1752. * mpf_init_set_str:                     Simultaneous Float Init & Assign.
  1753. * mpf_init_set_ui:                      Simultaneous Float Init & Assign.
  1754. * mpf_inp_str:                          I/O of Floats.
  1755. * mpf_mul:                              Float Arithmetic.
  1756. * mpf_mul_2exp:                         Float Arithmetic.
  1757. * mpf_mul_ui:                           Float Arithmetic.
  1758. * mpf_neg:                              Float Arithmetic.
  1759. * mpf_out_str:                          I/O of Floats.
  1760. * mpf_random2:                          Miscellaneous Float Functions.
  1761. * mpf_reldiff:                          Float Comparison.
  1762. * mpf_set:                              Assigning Floats.
  1763. * mpf_set_d:                            Assigning Floats.
  1764. * mpf_set_default_prec:                 Initializing Floats.
  1765. * mpf_set_prec:                         Initializing Floats.
  1766. * mpf_set_prec_raw:                     Initializing Floats.
  1767. * mpf_set_q:                            Assigning Floats.
  1768. * mpf_set_si:                           Assigning Floats.
  1769. * mpf_set_str:                          Assigning Floats.
  1770. * mpf_set_ui:                           Assigning Floats.
  1771. * mpf_set_z:                            Assigning Floats.
  1772. * mpf_sgn:                              Float Comparison.
  1773. * mpf_sqrt:                             Float Arithmetic.
  1774. * mpf_sqrt_ui:                          Float Arithmetic.
  1775. * mpf_sub:                              Float Arithmetic.
  1776. * mpf_sub_ui:                           Float Arithmetic.
  1777. * mpf_ui_div:                           Float Arithmetic.
  1778. * mpf_ui_sub:                           Float Arithmetic.
  1779. * mpn_add:                              Low-level Functions.
  1780. * mpn_add_1:                            Low-level Functions.
  1781. * mpn_add_n:                            Low-level Functions.
  1782. * mpn_addmul_1:                         Low-level Functions.
  1783. * mpn_bdivmod:                          Low-level Functions.
  1784. * mpn_cmp:                              Low-level Functions.
  1785. * mpn_divmod:                           Low-level Functions.
  1786. * mpn_divmod_1:                         Low-level Functions.
  1787. * mpn_divrem:                           Low-level Functions.
  1788. * mpn_divrem_1:                         Low-level Functions.
  1789. * mpn_gcd:                              Low-level Functions.
  1790. * mpn_gcd_1:                            Low-level Functions.
  1791. * mpn_gcdext:                           Low-level Functions.
  1792. * mpn_get_str:                          Low-level Functions.
  1793. * mpn_hamdist:                          Low-level Functions.
  1794. * mpn_lshift:                           Low-level Functions.
  1795. * mpn_mod_1:                            Low-level Functions.
  1796. * mpn_mul:                              Low-level Functions.
  1797. * mpn_mul_1:                            Low-level Functions.
  1798. * mpn_mul_n:                            Low-level Functions.
  1799. * mpn_perfect_square_p:                 Low-level Functions.
  1800. * mpn_popcount:                         Low-level Functions.
  1801. * mpn_preinv_mod_1:                     Low-level Functions.
  1802. * mpn_random2:                          Low-level Functions.
  1803. * mpn_rshift:                           Low-level Functions.
  1804. * mpn_scan0:                            Low-level Functions.
  1805. * mpn_scan1:                            Low-level Functions.
  1806. * mpn_set_str:                          Low-level Functions.
  1807. * mpn_sqrtrem:                          Low-level Functions.
  1808. * mpn_sub:                              Low-level Functions.
  1809. * mpn_sub_1:                            Low-level Functions.
  1810. * mpn_sub_n:                            Low-level Functions.
  1811. * mpn_submul_1:                         Low-level Functions.
  1812. * mpq_add:                              Assigning Rationals.
  1813. * mpq_canonicalize:                     Rational Number Functions.
  1814. * mpq_clear:                            Initializing Rationals.
  1815. * mpq_cmp:                              Comparing Rationals.
  1816. * mpq_cmp_ui:                           Comparing Rationals.
  1817. * mpq_denref:                           Applying Integer Functions.
  1818. * mpq_div:                              Assigning Rationals.
  1819. * mpq_equal:                            Comparing Rationals.
  1820. * mpq_get_d:                            Miscellaneous Rational Functions.
  1821. * mpq_get_den:                          Miscellaneous Rational Functions.
  1822. * mpq_get_num:                          Miscellaneous Rational Functions.
  1823. * mpq_init:                             Initializing Rationals.
  1824. * mpq_inv:                              Assigning Rationals.
  1825. * mpq_mul:                              Assigning Rationals.
  1826. * mpq_neg:                              Assigning Rationals.
  1827. * mpq_numref:                           Applying Integer Functions.
  1828. * mpq_set:                              Initializing Rationals.
  1829. * mpq_set_den:                          Miscellaneous Rational Functions.
  1830. * mpq_set_num:                          Miscellaneous Rational Functions.
  1831. * mpq_set_si:                           Initializing Rationals.
  1832. * mpq_set_ui:                           Initializing Rationals.
  1833. * mpq_set_z:                            Initializing Rationals.
  1834. * mpq_sgn:                              Comparing Rationals.
  1835. * mpq_sub:                              Assigning Rationals.
  1836. * mpz_abs:                              Integer Arithmetic.
  1837. * mpz_add:                              Integer Arithmetic.
  1838. * mpz_add_ui:                           Integer Arithmetic.
  1839. * mpz_and:                              Integer Logic and Bit Fiddling.
  1840. * mpz_array_init:                       Initializing Integers.
  1841. * mpz_cdiv_q:                           Integer Arithmetic.
  1842. * mpz_cdiv_q_ui:                        Integer Arithmetic.
  1843. * mpz_cdiv_qr:                          Integer Arithmetic.
  1844. * mpz_cdiv_qr_ui:                       Integer Arithmetic.
  1845. * mpz_cdiv_r:                           Integer Arithmetic.
  1846. * mpz_cdiv_r_ui:                        Integer Arithmetic.
  1847. * mpz_cdiv_ui:                          Integer Arithmetic.
  1848. * mpz_clear:                            Initializing Integers.
  1849. * mpz_clrbit:                           Integer Logic and Bit Fiddling.
  1850. * mpz_cmp:                              Comparison Functions.
  1851. * mpz_cmp_si:                           Comparison Functions.
  1852. * mpz_cmp_ui:                           Comparison Functions.
  1853. * mpz_com:                              Integer Logic and Bit Fiddling.
  1854. * mpz_divexact:                         Integer Arithmetic.
  1855. * mpz_fac_ui:                           Integer Arithmetic.
  1856. * mpz_fdiv_q:                           Integer Arithmetic.
  1857. * mpz_fdiv_q_2exp:                      Integer Arithmetic.
  1858. * mpz_fdiv_q_ui:                        Integer Arithmetic.
  1859. * mpz_fdiv_qr:                          Integer Arithmetic.
  1860. * mpz_fdiv_qr_ui:                       Integer Arithmetic.
  1861. * mpz_fdiv_r:                           Integer Arithmetic.
  1862. * mpz_fdiv_r_2exp:                      Integer Arithmetic.
  1863. * mpz_fdiv_r_ui:                        Integer Arithmetic.
  1864. * mpz_fdiv_ui:                          Integer Arithmetic.
  1865. * mpz_gcd:                              Integer Arithmetic.
  1866. * mpz_gcd_ui:                           Integer Arithmetic.
  1867. * mpz_gcdext:                           Integer Arithmetic.
  1868. * mpz_get_d:                            Converting Integers.
  1869. * mpz_get_si:                           Converting Integers.
  1870. * mpz_get_str:                          Converting Integers.
  1871. * mpz_get_ui:                           Converting Integers.
  1872. * mpz_hamdist:                          Integer Logic and Bit Fiddling.
  1873. * mpz_init:                             Initializing Integers.
  1874. * mpz_init_set:                         Simultaneous Integer Init & Assign.
  1875. * mpz_init_set_d:                       Simultaneous Integer Init & Assign.
  1876. * mpz_init_set_si:                      Simultaneous Integer Init & Assign.
  1877. * mpz_init_set_str:                     Simultaneous Integer Init & Assign.
  1878. * mpz_init_set_ui:                      Simultaneous Integer Init & Assign.
  1879. * mpz_inp_raw:                          I/O of Integers.
  1880. * mpz_inp_str:                          I/O of Integers.
  1881. * mpz_invert:                           Integer Arithmetic.
  1882. * mpz_ior:                              Integer Logic and Bit Fiddling.
  1883. * mpz_jacobi:                           Integer Arithmetic.
  1884. * mpz_legendre:                         Integer Arithmetic.
  1885. * mpz_mod:                              Integer Arithmetic.
  1886. * mpz_mod_ui:                           Integer Arithmetic.
  1887. * mpz_mul:                              Integer Arithmetic.
  1888. * mpz_mul_2exp:                         Integer Arithmetic.
  1889. * mpz_mul_ui:                           Integer Arithmetic.
  1890. * mpz_neg:                              Integer Arithmetic.
  1891. * mpz_out_raw:                          I/O of Integers.
  1892. * mpz_out_str:                          I/O of Integers.
  1893. * mpz_perfect_square_p:                 Integer Arithmetic.
  1894. * mpz_popcount:                         Integer Logic and Bit Fiddling.
  1895. * mpz_pow_ui:                           Integer Arithmetic.
  1896. * mpz_powm:                             Integer Arithmetic.
  1897. * mpz_powm_ui:                          Integer Arithmetic.
  1898. * mpz_probab_prime_p:                   Integer Arithmetic.
  1899. * mpz_random:                           Miscellaneous Integer Functions.
  1900. * mpz_random2:                          Miscellaneous Integer Functions.
  1901. * mpz_scan0:                            Integer Logic and Bit Fiddling.
  1902. * mpz_scan1:                            Integer Logic and Bit Fiddling.
  1903. * mpz_set:                              Assigning Integers.
  1904. * mpz_set_d:                            Assigning Integers.
  1905. * mpz_set_f:                            Assigning Integers.
  1906. * mpz_set_q:                            Assigning Integers.
  1907. * mpz_set_si:                           Assigning Integers.
  1908. * mpz_set_str:                          Assigning Integers.
  1909. * mpz_set_ui:                           Assigning Integers.
  1910. * mpz_setbit:                           Integer Logic and Bit Fiddling.
  1911. * mpz_sgn:                              Comparison Functions.
  1912. * mpz_size:                             Miscellaneous Integer Functions.
  1913. * mpz_sizeinbase:                       Miscellaneous Integer Functions.
  1914. * mpz_sqrt:                             Integer Arithmetic.
  1915. * mpz_sqrtrem:                          Integer Arithmetic.
  1916. * mpz_sub:                              Integer Arithmetic.
  1917. * mpz_sub_ui:                           Integer Arithmetic.
  1918. * mpz_tdiv_q:                           Integer Arithmetic.
  1919. * mpz_tdiv_q_2exp:                      Integer Arithmetic.
  1920. * mpz_tdiv_q_ui:                        Integer Arithmetic.
  1921. * mpz_tdiv_qr:                          Integer Arithmetic.
  1922. * mpz_tdiv_qr_ui:                       Integer Arithmetic.
  1923. * mpz_tdiv_r:                           Integer Arithmetic.
  1924. * mpz_tdiv_r_2exp:                      Integer Arithmetic.
  1925. * mpz_tdiv_r_ui:                        Integer Arithmetic.
  1926. * mpz_ui_pow_ui:                        Integer Arithmetic.
  1927. * msqrt:                                BSD Compatible Functions.
  1928. * msub:                                 BSD Compatible Functions.
  1929. * mtox:                                 BSD Compatible Functions.
  1930. * mult:                                 BSD Compatible Functions.
  1931. * pow:                                  BSD Compatible Functions.
  1932. * reallocate_function:                  Custom Allocation.
  1933. * rpow:                                 BSD Compatible Functions.
  1934. * sdiv:                                 BSD Compatible Functions.
  1935. * xtom:                                 BSD Compatible Functions.
  1936. Tag Table:
  1937. Node: Top
  1938. Node: Copying
  1939. Node: Introduction to MP
  1940. Node: Installing MP
  1941. Node: MP Basics
  1942. 10237
  1943. Node: Reporting Bugs
  1944. 16525
  1945. Node: Integer Functions
  1946. 18045
  1947. Node: Initializing Integers
  1948. 18652
  1949. Node: Assigning Integers
  1950. 20768
  1951. Node: Simultaneous Integer Init & Assign
  1952. 22043
  1953. Node: Converting Integers
  1954. 23657
  1955. Node: Integer Arithmetic
  1956. 25326
  1957. Node: Comparison Functions
  1958. 36202
  1959. Node: Integer Logic and Bit Fiddling
  1960. 37104
  1961. Node: I/O of Integers
  1962. 39165
  1963. Node: Miscellaneous Integer Functions
  1964. 41646
  1965. Node: Rational Number Functions
  1966. 43316
  1967. Node: Initializing Rationals
  1968. 44611
  1969. Node: Assigning Rationals
  1970. 45781
  1971. Node: Comparing Rationals
  1972. 46744
  1973. Node: Applying Integer Functions
  1974. 48027
  1975. Node: Miscellaneous Rational Functions
  1976. 48845
  1977. Node: Floating-point Functions
  1978. 50891
  1979. Node: Initializing Floats
  1980. 52739
  1981. Node: Assigning Floats
  1982. 55491
  1983. Node: Simultaneous Float Init & Assign
  1984. 57083
  1985. Node: Converting Floats
  1986. 58600
  1987. Node: Float Arithmetic
  1988. 60179
  1989. Node: Float Comparison
  1990. 62088
  1991. Node: I/O of Floats
  1992. 63114
  1993. Node: Miscellaneous Float Functions
  1994. 65230
  1995. Node: Low-level Functions
  1996. 65913
  1997. Node: BSD Compatible Functions
  1998. 82281
  1999. Node: Custom Allocation
  2000. 86617
  2001. Node: Contributors
  2002. 88955
  2003. Node: References
  2004. 90554
  2005. Node: Concept Index
  2006. 91590
  2007. Node: Function Index
  2008. 94207
  2009. End Tag Table
  2010.