This manual documents how to install and use the Multiple Precision Floating-Point Reliable Library, version 2.4.1.
Copyright 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in GNU Free Documentation License.
This library is free; this means that everyone is free to use it and free to redistribute it on a free basis. The library is not in the public domain; it is copyrighted and there are restrictions on its distribution, but these restrictions are designed to permit everything that a good cooperating citizen would want to do. What is not allowed is to try to prevent others from further sharing any version of this library that they might get from you.
Specifically, we want to make sure that you have the right to give away copies of the library, that you receive source code or else can get it if you want it, that you can change this library or use pieces of it in new free programs, and that you know you can do these things.
To make sure that everyone has such rights, we have to forbid you to deprive anyone else of these rights. For example, if you distribute copies of the GNU MPFR library, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights.
Also, for our own protection, we must make certain that everyone finds out that there is no warranty for the GNU MPFR library. If it is modified by someone else and passed on, we want their recipients to know that what they have is not what we distributed, so that any problems introduced by others will not reflect on our reputation.
The precise conditions of the license for the GNU MPFR library are found in the Lesser General Public License that accompanies the source code. See the file COPYING.LIB.
MPFR is a portable library written in C for arbitrary precision arithmetic
on floating-point numbers. It is based on the GNU MP library.
It aims to extend the class of floating-point numbers provided by the
GNU MP library by a precise semantics. The main differences
with the mpf class from GNU MP are:
mp_bits_per_limb (32 or 64 on most machines);
In particular, with a precision of 53 bits, MPFR should be able to
exactly reproduce all computations with double-precision machine
floating-point numbers (e.g., double type in C, with a C
implementation that rigorously follows Annex F of the ISO C99 standard
and FP_CONTRACT pragma set to OFF) on the four arithmetic
operations and the square root, except the default exponent range is much
wider and subnormal numbers are not implemented (but can be emulated).
This version of MPFR is released under the GNU Lesser General Public License, Version 2.1 or any later version. It is permitted to link MPFR to most non-free programs, as long as when distributing them the MPFR source code and a means to re-link with a modified MPFR library is provided.
Everyone should read MPFR Basics. If you need to install the library yourself, you need to read Installing MPFR, too.
The rest of the manual can be used for later reference, although it is probably a good idea to glance through it.
Here are the steps needed to install the library on Unix systems (more details are provided in the INSTALL file):
This will prepare the build and setup the options according to your system. If you get error messages, you might check that you use the same compiler and compile options as for GNU MP (see the INSTALL file).
This will compile MPFR, and create a library archive file libmpfr.a. A dynamic library may be produced too (see configure).
This will make sure MPFR was built correctly. If you get error messages, please report this to ‘mpfr@loria.fr’. (See Reporting Bugs, for information on what to include in useful bug reports.)
This will copy the files mpfr.h and mpf2mpfr.h to the directory /usr/local/include, the file libmpfr.a to the directory /usr/local/lib, and the file mpfr.info to the directory /usr/local/share/info (or if you passed the ‘--prefix’ option to configure, using the prefix directory given as argument to ‘--prefix’ instead of /usr/local).
There are some other useful make targets:
Create an info version of the manual, in mpfr.info.
Create a PDF version of the manual, in mpfr.pdf.
Create a DVI version of the manual, in mpfr.dvi.
Create a Postscript version of the manual, in mpfr.ps.
Create a HTML version of the manual, in several pages in the directory mpfr.html; if you want only one output HTML file, then type ‘makeinfo --html --no-split mpfr.texi’ instead.
Delete all object files and archive files, but not the configuration files.
Delete all files not included in the distribution.
Delete all files copied by ‘make install’.
In case of problem, please read the INSTALL file carefully before reporting a bug, in particular section “In case of problem”. Some problems are due to bad configuration on the user side (not specific to MPFR). Problems are also mentioned in the FAQ http://www.mpfr.org/faq.html.
Please report problems to ‘mpfr@loria.fr’. See Reporting Bugs. Some bug fixes are available on the MPFR 2.4.1 web page http://www.mpfr.org/mpfr-2.4.1/.
The latest version of MPFR is available from ftp://ftp.gnu.org/gnu/mpfr/ or http://www.mpfr.org/.
If you think you have found a bug in the MPFR library, first have a look on the MPFR 2.4.1 web page http://www.mpfr.org/mpfr-2.4.1/ and the FAQ http://www.mpfr.org/faq.html: perhaps this bug is already known, in which case you may find there a workaround for it. Otherwise, please investigate and report it. We have made this library available to you, and it is not to ask too much from you, to ask you to report the bugs that you find.
There are a few things you should think about when you put your bug report together.
You have to send us a test case that makes it possible for us to reproduce the bug. Include instructions on how to run the test case.
You also have to explain what is wrong; if you get a crash, or if the results printed are incorrect and in that case, in what way.
Please include compiler version information in your bug report. This can be extracted using ‘cc -V’ on some machines, or, if you're using gcc, ‘gcc -v’. Also, include the output from ‘uname -a’ and the MPFR version (the GMP version may be useful too).
If your bug report is good, we will do our best to help you to get a corrected version of the library; if the bug report is poor, we will not do anything about it (aside of chiding you to send better bug reports).
Send your bug report to: ‘mpfr@loria.fr’.
If you think something in this manual is unclear, or downright incorrect, or if the language needs to be improved, please send a note to the same address.
All declarations needed to use MPFR are collected in the include file mpfr.h. It is designed to work with both C and C++ compilers. You should include that file in any program using the MPFR library:
#include <mpfr.h>
Note however that prototypes for MPFR functions with FILE * parameters
are provided only if <stdio.h> is included too (before mpfr.h).
#include <stdio.h>
#include <mpfr.h>
Likewise <stdarg.h> (or <varargs.h>) is required for prototypes
with va_list parameters, such as mpfr_vprintf.
You can avoid the use of MPFR macros encapsulating functions by defining the ‘MPFR_USE_NO_MACRO’ macro before mpfr.h is included. In general this should not be necessary, but this can be useful when debugging user code: with some macros, the compiler may emit spurious warnings with some warning options, and macros can prevent some prototype checking.
All programs using MPFR must link against both libmpfr and libgmp libraries. On a typical Unix-like system this can be done with ‘-lmpfr -lgmp’ (in that order), for example
gcc myprogram.c -lmpfr -lgmp
MPFR is built using Libtool and an application can use that to link if desired, see GNU Libtool.
If MPFR has been installed to a non-standard location, then it may be necessary to set up environment variables such as ‘C_INCLUDE_PATH’ and ‘LIBRARY_PATH’, or use ‘-I’ and ‘-L’ compiler options, in order to point to the right directories. For a shared library, it may also be necessary to set up some sort of run-time library path (e.g., ‘LD_LIBRARY_PATH’) on some systems. Please read the INSTALL file for additional information.
A floating-point number or float for short, is an arbitrary
precision significand (also called mantissa) with a limited precision
exponent. The C data type
for such objects is mpfr_t (internally defined as a one-element
array of a structure, and mpfr_ptr is the C data type representing
a pointer to this structure). A floating-point number can have
three special values: Not-a-Number (NaN) or plus or minus Infinity. NaN
represents an uninitialized object, the result of an invalid operation
(like 0 divided by 0), or a value that cannot be determined (like
+Infinity minus +Infinity). Moreover, like in the IEEE 754-1985 standard,
zero is signed, i.e. there are both +0 and −0; the behavior
is the same as in the IEEE 754-1985 standard and it is generalized to
the other functions supported by MPFR.
The precision is the number of bits used to represent the significand
of a floating-point number;
the corresponding C data type is mp_prec_t.
The precision can be any integer between MPFR_PREC_MIN and
MPFR_PREC_MAX. In the current implementation, MPFR_PREC_MIN
is equal to 2.
Warning! MPFR needs to increase the precision internally, in order to
provide accurate results (and in particular, correct rounding). Do not
attempt to set the precision to any value near MPFR_PREC_MAX,
otherwise MPFR will abort due to an assertion failure. Moreover, you
may reach some memory limit on your platform, in which case the program
may abort, crash or have undefined behavior (depending on your C
implementation).
The rounding mode specifies the way to round the result of a
floating-point operation, in case the exact result can not be represented
exactly in the destination significand;
the corresponding C data type is mp_rnd_t.
A limb means the part of a multi-precision number that fits in a single
word. (We chose this word because a limb of the human body is analogous to a
digit, only larger, and containing several digits.) Normally a limb contains
32 or 64 bits. The C data type for a limb is mp_limb_t.
There is only one class of functions in the MPFR library:
mpfr_. The associated type is mpfr_t.
As a general rule, all MPFR functions expect output arguments before input arguments. This notation is based on an analogy with the assignment operator.
MPFR allows you to use the same variable for both input and output in the same
expression. For example, the main function for floating-point multiplication,
mpfr_mul, can be used like this: mpfr_mul (x, x, x, rnd_mode).
This
computes the square of x with rounding mode rnd_mode
and puts the result back in x.
Before you can assign to an MPFR variable, you need to initialize it by calling one of the special initialization functions. When you're done with a variable, you need to clear it out, using one of the functions for that purpose.
A variable should only be initialized once, or at least cleared out between each initialization. After a variable has been initialized, it may be assigned to any number of times.
For efficiency reasons, avoid to initialize and clear out a variable in loops. Instead, initialize it before entering the loop, and clear it out after the loop has exited.
You do not need to be concerned about allocating additional space for MPFR variables, since any variable has a significand of fixed size. Hence unless you change its precision, or clear and reinitialize it, a floating-point variable will have the same allocated space during all its life.
The following four rounding modes are supported:
GMP_RNDN: round to nearest
GMP_RNDZ: round toward zero
GMP_RNDU: round toward plus infinity
GMP_RNDD: round toward minus infinity
The ‘round to nearest’ mode works as in the IEEE 754-1985 standard: in case the number to be rounded lies exactly in the middle of two representable numbers, it is rounded to the one with the least significant bit set to zero. For example, the number 5/2, which is represented by (10.1) in binary, is rounded to (10.0)=2 with a precision of two bits, and not to (11.0)=3. This rule avoids the drift phenomenon mentioned by Knuth in volume 2 of The Art of Computer Programming (Section 4.2.2).
Most MPFR functions take as first argument the destination variable, as
second and following arguments the input variables, as last argument a
rounding mode, and have a return value of type int, called the
ternary value. The value stored in the destination variable is
correctly rounded, i.e. MPFR behaves as if it computed the result with
an infinite precision, then rounded it to the precision of this variable.
The input variables are regarded as exact (in particular, their precision
does not affect the result).
As a consequence, in case of a non-zero real rounded result, the error on the result is less or equal to 1/2 ulp (unit in the last place) of the target in the rounding to nearest mode, and less than 1 ulp of the target in the directed rounding modes (a ulp is the weight of the least significant represented bit of the target after rounding).
Unless documented otherwise, functions returning an int return
a ternary value.
If the ternary value is zero, it means that the value stored in the
destination variable is the exact result of the corresponding mathematical
function. If the ternary value is positive (resp. negative), it means
the value stored in the destination variable is greater (resp. lower)
than the exact result. For example with the GMP_RNDU rounding mode,
the ternary value is usually positive, except when the result is exact, in
which case it is zero. In the case of an infinite result, it is considered
as inexact when it was obtained by overflow, and exact otherwise. A NaN
result (Not-a-Number) always corresponds to an exact return value.
The opposite of a returned ternary value is guaranteed to be representable
in an int.
Unless documented otherwise, functions returning a 1
(or any other value specified in this manual)
for special cases (like acos(0)) should return an overflow or
an underflow if 1 is not representable in the current exponent range.
This section specifies the floating-point values (of type mpfr_t)
returned by MPFR functions. For functions returning several values (like
mpfr_sin_cos), the rules apply to each result separately.
Functions can have one or several input arguments. An input point is a mapping from these input arguments to the set of the MPFR numbers. When none of its components are NaN, an input point can also be seen as a tuple in the extended real numbers (the set of the real numbers with both infinities).
When the input point is in the domain of the mathematical function, the result is rounded as described in Section “Rounding Modes” (but see below for the specification of the sign of an exact zero). Otherwise the general rules from this section apply unless stated otherwise in the description of the MPFR function (MPFR Interface).
When the input point is not in the domain of the mathematical function
but is in its closure in the extended real numbers and the function can
be extended by continuity, the result is the obtained limit.
Examples: mpfr_hypot on (+Inf,0) gives +Inf. But mpfr_pow
cannot be defined on (1,+Inf) using this rule, as one can find
sequences (x_n,y_n) such that
x_n goes to 1, y_n goes to +Inf
and x_n to the y_n goes to any
positive value when n goes to the infinity.
When the input point is in the closure of the domain of the mathematical
function and an input argument is +0 (resp. −0), one considers
the limit when the corresponding argument approaches 0 from above
(resp. below). If the limit is not defined (e.g., mpfr_log on
−0), the behavior must be specified in the description of the
MPFR function.
When the result is equal to 0, its sign is determined by considering the
limit as if the input point were not in the domain: If one approaches 0
from above (resp. below), the result is +0 (resp. −0). In the
other cases, the sign must be specified in the description of the MPFR
function. Example: mpfr_sin on +0 gives +0.
When the input point is not in the closure of the domain of the function,
the result is NaN. Example: mpfr_sqrt on −17 gives NaN.
When an input argument is NaN, the result is NaN, possibly except when
a partial function is constant on the finite floating-point numbers;
such a case is always explicitly specified in MPFR Interface.
Example: mpfr_hypot on (NaN,0) gives NaN, but mpfr_hypot
on (NaN,+Inf) gives +Inf (as specified in Special Functions),
since for any finite input x, mpfr_hypot on (x,+Inf)
gives +Inf.
MPFR supports 5 exception types:
Note: This is not the single definition of the underflow. MPFR chooses to consider the underflow after rounding. The underflow before rounding can also be defined. For instance, consider a function that has the exact result 7 multiplied by two to the power e−4, where e is the smallest exponent (for a significand between 1/2 and 1) in the current range, with a 2-bit target precision and rounding toward plus infinity. The exact result has the exponent e−1. With the underflow before rounding, such a function call would yield an underflow, as e−1 is outside the current exponent range. However, MPFR first considers the rounded result assuming an unbounded exponent range. The exact result cannot be represented exactly in precision 2, and here, it is rounded to 0.5 times 2 to e, which is representable in the current exponent range. As a consequence, this will not yield an underflow in MPFR.
mpfr_cmp or in a
conversion to an integer).
MPFR has a global flag for each exception, which can be cleared, set or tested by functions described in Exception Related Functions.
Differences with the ISO C99 standard:
MPFR functions may create caches, e.g. when computing constants such
as Pi, either because the user has called a function like
mpfr_const_pi directly or because such a function was called
internally by the MPFR library itself to compute some other function.
At any time, the user can free the various caches with
mpfr_free_cache. It is strongly advised to do that before
terminating a thread, or before exiting when using tools like
‘valgrind’ (to avoid memory leaks being reported).
MPFR internal data such as flags, the exponent range, the default precision and rounding mode, and caches (i.e., data that are not accessed via parameters) are either global (if MPFR has not been compiled as thread safe) or per-thread (thread local storage).
The floating-point functions expect arguments of type mpfr_t.
The MPFR floating-point functions have an interface that is similar to the
GNU MP
integer functions. The function prefix for floating-point operations is
mpfr_.
There is one significant characteristic of floating-point numbers that has motivated a difference between this function class and other GNU MP function classes: the inherent inexactness of floating-point arithmetic. The user has to specify the precision for each variable. A computation that assigns a variable will take place with the precision of the assigned variable; the cost of that computation should not depend from the precision of variables used as input (on average).
The semantics of a calculation in MPFR is specified as follows: Compute the requested operation exactly (with “infinite accuracy”), and round the result to the precision of the destination variable, with the given rounding mode. The MPFR floating-point functions are intended to be a smooth extension of the IEEE 754-1985 arithmetic. The results obtained on one computer should not differ from the results obtained on a computer with a different word size.
MPFR does not keep track of the accuracy of a computation. This is left to the user or to a higher layer. As a consequence, if two variables are used to store only a few significant bits, and their product is stored in a variable with large precision, then MPFR will still compute the result with full precision.
The value of the standard C macro errno may be set to non-zero by
any MPFR function or macro, whether or not there is an error.
An mpfr_t object must be initialized before storing the first value in
it. The functions mpfr_init and mpfr_init2 are used for that
purpose.
Initialize x, set its precision to be exactly prec bits and its value to NaN. (Warning: the corresponding
mpffunctions initialize to zero instead.)Normally, a variable should be initialized once only or at least be cleared, using
mpfr_clear, between initializations. To change the precision of a variable which has already been initialized, usempfr_set_prec. The precision prec must be an integer betweenMPFR_PREC_MINandMPFR_PREC_MAX(otherwise the behavior is undefined).
Initialize all the
mpfr_tvariables of the givenva_list, set their precision to be exactly prec bits and their value to NaN. Seempfr_init2for more details. Theva_listis assumed to be composed only of typempfr_t(or equivalentlympfr_ptr). It begins from x. It ends when it encounters a null pointer (whose type must also bempfr_ptr).
Free the space occupied by x. Make sure to call this function for all
mpfr_tvariables when you are done with them.
Free the space occupied by all the
mpfr_tvariables of the givenva_list. Seempfr_clearfor more details. Theva_listis assumed to be composed only of typempfr_t(or equivalentlympfr_ptr). It begins from x. It ends when it encounters a null pointer (whose type must also bempfr_ptr).
Here is an example of how to use multiple initialization functions:
{
mpfr_t x, y, z, t;
mpfr_inits2 (256, x, y, z, t, (mpfr_ptr) 0);
...
mpfr_clears (x, y, z, t, (mpfr_ptr) 0);
}
Initialize x and set its value to NaN.
Normally, a variable should be initialized once only or at least be cleared, using
mpfr_clear, between initializations. The precision of x is the default precision, which can be changed by a call tompfr_set_default_prec.Warning! In a given program, some other libraries might change the default precision and not restore it. Thus it is safer to use
mpfr_init2.
Initialize all the
mpfr_tvariables of the givenva_list, set their precision to be the default precision and their value to NaN. Seempfr_initfor more details. Theva_listis assumed to be composed only of typempfr_t(or equivalentlympfr_ptr). It begins from x. It ends when it encounters a null pointer (whose type must also bempfr_ptr).Warning! In a given program, some other libraries might change the default precision and not restore it. Thus it is safer to use
mpfr_inits2.
This macro declares name as an automatic variable of type
mpfr_t, initializes it and sets its precision to be exactly prec bits and its value to NaN. name must be a valid identifier. You must use this macro in the declaration section. This macro is much faster than usingmpfr_init2but has some drawbacks:
- You must not call
mpfr_clearwith variables created with this macro (the storage is allocated at the point of declaration and deallocated when the brace-level is exited).- You cannot change their precision.
- You should not create variables with huge precision with this macro.
- Your compiler must support ‘Non-Constant Initializers’ (standard in C++ and ISO C99) and ‘Token Pasting’ (standard in ISO C89). If prec is not a constant expression, your compiler must support ‘variable-length automatic arrays’ (standard in ISO C99). ‘GCC 2.95.3’ and above supports all these features. If you compile your program with gcc in c89 mode and with ‘-pedantic’, you may want to define the
MPFR_USE_EXTENSIONmacro to avoid warnings due to theMPFR_DECL_INITimplementation.
Set the default precision to be exactly prec bits. The precision of a variable means the number of bits used to store its significand. All subsequent calls to
mpfr_initwill use this precision, but previously initialized variables are unaffected. This default precision is set to 53 bits initially. The precision can be any integer betweenMPFR_PREC_MINandMPFR_PREC_MAX.
Here is an example on how to initialize floating-point variables:
{
mpfr_t x, y;
mpfr_init (x); /* use default precision */
mpfr_init2 (y, 256); /* precision exactly 256 bits */
...
/* When the program is about to exit, do ... */
mpfr_clear (x);
mpfr_clear (y);
mpfr_free_cache ();
}
The following functions are useful for changing the precision during a calculation. A typical use would be for adjusting the precision gradually in iterative algorithms like Newton-Raphson, making the computation precision closely match the actual accurate part of the numbers.
Reset the precision of x to be exactly prec bits, and set its value to NaN. The previous value stored in x is lost. It is equivalent to a call to
mpfr_clear(x)followed by a call tompfr_init2(x, prec), but more efficient as no allocation is done in case the current allocated space for the significand of x is enough. The precision prec can be any integer betweenMPFR_PREC_MINandMPFR_PREC_MAX.In case you want to keep the previous value stored in x, use
mpfr_prec_roundinstead.
Return the precision actually used for assignments of x, i.e. the number of bits used to store its significand.
These functions assign new values to already initialized floats
(see Initialization Functions). When using any functions using
intmax_t, you must include <stdint.h> or <inttypes.h>
before mpfr.h, to allow mpfr.h to define prototypes for
these functions.
Set the value of rop from op, rounded toward the given direction rnd. Note that the input 0 is converted to +0 by
mpfr_set_ui,mpfr_set_si,mpfr_set_sj,mpfr_set_uj,mpfr_set_z,mpfr_set_qandmpfr_set_f, regardless of the rounding mode. If the system does not support the IEEE-754 standard,mpfr_set_d,mpfr_set_ldandmpfr_set_decimal64might not preserve the signed zeros. Thempfr_set_decimal64function is built only with the configure option ‘--enable-decimal-float’, which also requires ‘--with-gmp-build’, and when the compiler or system provides the ‘_Decimal64’ data type (GCC version 4.2.0 is known to support this data type, but only when configured with ‘--enable-decimal-float’ too).mpfr_set_qmight not be able to work if the numerator (or the denominator) can not be representable as ampfr_t.Note: If you want to store a floating-point constant to a
mpfr_t, you should usempfr_set_str(or one of the MPFR constant functions, such asmpfr_const_pifor Pi) instead ofmpfr_set_d,mpfr_set_ldormpfr_set_decimal64. Otherwise the floating-point constant will be first converted into a reduced-precision (e.g., 53-bit) binary number before MPFR can work with it.
Set the value of rop from op multiplied by two to the power e, rounded toward the given direction rnd. Note that the input 0 is converted to +0.
Set rop to the value of the string s in base base, rounded in the direction rnd. See the documentation of
mpfr_strtofrfor a detailed description of the valid string formats. Contrary tompfr_strtofr,mpfr_set_strrequires the whole string to represent a valid floating-point number. This function returns 0 if the entire string up to the final null character is a valid number in base base; otherwise it returns −1, and rop may have changed.
Read a floating-point number from a string nptr in base base, rounded in the direction rnd; base must be either 0 (to detect the base, as described below) or a number from 2 to 36 (otherwise the behavior is undefined). If nptr starts with valid data, the result is stored in rop and
*endptr points to the character just after the valid data (if endptr is not a null pointer); otherwise rop is set to zero and the value of nptr is stored in the location referenced by endptr (if endptr is not a null pointer). The usual ternary value is returned.Parsing follows the standard C
strtodfunction with some extensions. Case is ignored. After optional leading whitespace, one has a subject sequence consisting of an optional sign (+or-), and either numeric data or special data. The subject sequence is defined as the longest initial subsequence of the input string, starting with the first non-whitespace character, that is of the expected form.The form of numeric data is a non-empty sequence of significand digits with an optional decimal point, and an optional exponent consisting of an exponent prefix followed by an optional sign and a non-empty sequence of decimal digits. A significand digit is either a decimal digit or a Latin letter (62 possible characters), with
a= 10,b= 11, ...,z= 35; its value must be strictly less than the base. The decimal point can be either the one defined by the current locale or the period (the first one is accepted for consistency with the C standard and the practice, the second one is accepted to allow the programmer to provide MPFR numbers from strings in a way that does not depend on the current locale). The exponent prefix can beeorEfor bases up to 10, or@in any base; it indicates a multiplication by a power of the base. In bases 2 and 16, the exponent prefix can also beporP, in which case it introduces a binary exponent: it indicates a multiplication by a power of 2 (there is a difference only for base 16). The value of an exponent is always written in base 10. In base 2, the significand can start with0bor0B, and in base 16, it can start with0xor0X.If the argument base is 0, then the base is automatically detected as follows. If the significand starts with
0bor0B, base 2 is assumed. If the significand starts with0xor0X, base 16 is assumed. Otherwise base 10 is assumed.Note: The exponent must contain at least a digit. Otherwise the possible exponent prefix and sign are not part of the number (which ends with the significand). Similarly, if
0b,0B,0xor0Xis not followed by a binary/hexadecimal digit, then the subject sequence stops at the character0.Special data (for infinities and NaN) can be
@inf@or@nan@(n-char-sequence), and if base <= 16, it can also beinfinity,inf,nanornan(n-char-sequence), all case insensitive. An-char-sequenceis a non-empty string containing only digits, Latin letters and the underscore (0, 1, 2, ..., 9, a, b, ..., z, A, B, ..., Z, _). Note: one has an optional sign for all data, even NaN.
Set the variable x to infinity or NaN (Not-a-Number) respectively. In
mpfr_set_inf, x is set to plus infinity iff sign is nonnegative.
Swap the values x and y efficiently. Warning: the precisions are exchanged too; in case the precisions are different,
mpfr_swapis thus not equivalent to threempfr_setcalls using a third auxiliary variable.
Initialize rop and set its value from op, rounded in the direction rnd. The precision of rop will be taken from the active default precision, as set by
mpfr_set_default_prec.
Initialize x and set its value from the string s in base base, rounded in the direction rnd. See
mpfr_set_str.
Convert op to a
double(respectively_Decimal64orlong double), using the rounding mode rnd. If op is NaN, some fixed NaN (either quiet or signaling) or the result of 0.0/0.0 is returned. If op is ±Inf, an infinity of the same sign or the result of ±1.0/0.0 is returned. If op is zero, these functions return a zero, trying to preserve its sign, if possible. Thempfr_get_decimal64function is built only under some conditions: see the documentation ofmpfr_set_decimal64.
Return d and set exp such that 0.5<=abs(d)<1 and d times 2 raised to exp equals op rounded to double (resp. long double) precision, using the given rounding mode. If op is zero, then a zero of the same sign (or an unsigned zero, if the implementation does not have signed zeros) is returned, and exp is set to 0. If op is NaN or an infinity, then the corresponding double precision (resp. long-double precision) value is returned, and exp is undefined.
Convert op to a
long, anunsigned long, anintmax_tor anuintmax_t(respectively) after rounding it with respect to rnd. If op is NaN, the result is undefined. If op is too big for the return type, it returns the maximum or the minimum of the corresponding C type, depending on the direction of the overflow. The erange flag is set too. See alsompfr_fits_slong_p,mpfr_fits_ulong_p,mpfr_fits_intmax_pandmpfr_fits_uintmax_p.
Put the scaled significand of op (regarded as an integer, with the precision of op) into rop, and return the exponent exp (which may be outside the current exponent range) such that op exactly equals rop multiplied by two exponent exp. If the exponent is not representable in the
mp_exp_ttype, the behavior is undefined.
Convert op to a
mpz_t, after rounding it with respect to rnd. If op is NaN or Inf, the result is undefined.
Convert op to a
mpf_t, after rounding it with respect to rnd. Return zero iff no error occurred, in particular a non-zero value is returned if op is NaN or Inf, which do not exist inmpf.
Convert op to a string of digits in base b, with rounding in the direction rnd, where n is either zero (see below) or the number of significant digits; in the latter case, n must be greater or equal to 2. The base may vary from 2 to 36.
The generated string is a fraction, with an implicit radix point immediately to the left of the first digit. For example, the number −3.1416 would be returned as "−31416" in the string and 1 written at expptr. If rnd is to nearest, and op is exactly in the middle of two possible outputs, the one with an even last digit is chosen (for an odd base, this may not correspond to an even significand).
If n is zero, the number of digits of the significand is chosen large enough so that re-reading the printed value with the same precision, assuming both output and input use rounding to nearest, will recover the original value of op. More precisely, in most cases, the chosen precision of str is the minimal precision depending on n and b only that satisfies the above property, i.e., m = 1 + ceil(n*log(2)/log(b)), but in some very rare cases, it might be m+1.
If str is a null pointer, space for the significand is allocated using the current allocation function, and a pointer to the string is returned. To free the returned string, you must use
mpfr_free_str.If str is not a null pointer, it should point to a block of storage large enough for the significand, i.e., at least
max(n+ 2, 7). The extra two bytes are for a possible minus sign, and for the terminating null character.If the input number is an ordinary number, the exponent is written through the pointer expptr (the current minimal exponent for 0).
A pointer to the string is returned, unless there is an error, in which case a null pointer is returned.
Free a string allocated by
mpfr_get_strusing the current unallocation function (preliminary interface). The block is assumed to bestrlen(str)+1bytes. For more information about how it is done: see Section “Custom Allocation” in GNU MP.
Return non-zero if op would fit in the respective C data type, when rounded to an integer in the direction rnd.
Set rop to op1 + op2 rounded in the direction rnd. For types having no signed zero, it is considered unsigned (i.e. (+0) + 0 = (+0) and (−0) + 0 = (−0)). The
mpfr_add_dfunction assumes that the radix of thedoubletype is a power of 2, with a precision at most that declared by the C implementation (macroIEEE_DBL_MANT_DIG, and if not defined 53 bits).
Set rop to op1 - op2 rounded in the direction rnd. For types having no signed zero, it is considered unsigned (i.e. (+0) − 0 = (+0), (−0) − 0 = (−0), 0 − (+0) = (−0) and 0 − (−0) = (+0)). The same restrictions than for
mpfr_add_dapply tompfr_d_subandmpfr_sub_d.
Set rop to op1 times op2 rounded in the direction rnd. When a result is zero, its sign is the product of the signs of the operands (for types having no signed zero, it is considered positive). The same restrictions than for
mpfr_add_dapply tompfr_mul_d.
Set rop to the square of op rounded in the direction rnd.
Set rop to op1/op2 rounded in the direction rnd. When a result is zero, its sign is the product of the signs of the operands (for types having no signed zero, it is considered positive). The same restrictions than for
mpfr_add_dapply tompfr_d_divandmpfr_div_d.
Set rop to the square root of op rounded in the direction rnd. Return −0 if op is −0 (to be consistent with the IEEE 754-1985 standard). Set rop to NaN if op is negative.
Set rop to the reciprocal square root of op rounded in the direction rnd. Return +Inf if op is ±0, and +0 if op is +Inf. Set rop to NaN if op is negative.
Set rop to the cubic root (resp. the kth root) of op rounded in the direction rnd. An odd (resp. even) root of a negative number (including −Inf) returns a negative number (resp. NaN). The kth root of −0 is defined to be −0, whatever the parity of k.
Set rop to op1 raised to op2, rounded in the direction rnd. Special values are currently handled as described in the ISO C99 standard for the
powfunction (note this may change in future versions):
pow(±0,y)returns plus or minus infinity for y a negative odd integer.pow(±0,y)returns plus infinity for y negative and not an odd integer.pow(±0,y)returns plus or minus zero for y a positive odd integer.pow(±0,y)returns plus zero for y positive and not an odd integer.pow(-1, ±Inf)returns 1.pow(+1,y)returns 1 for any y, even a NaN.pow(x, ±0)returns 1 for any x, even a NaN.pow(x,y)returns NaN for finite negative x and finite non-integer y.pow(x, -Inf)returns plus infinity for 0 < abs(x) < 1, and plus zero for abs(x) > 1.pow(x, +Inf)returns plus zero for 0 < abs(x) < 1, and plus infinity for abs(x) > 1.pow(-Inf,y)returns minus zero for y a negative odd integer.pow(-Inf,y)returns plus zero for y negative and not an odd integer.pow(-Inf,y)returns minus infinity for y a positive odd integer.pow(-Inf,y)returns plus infinity for y positive and not an odd integer.pow(+Inf,y)returns plus zero for y negative, and plus infinity for y positive.
Set rop to -op rounded in the direction rnd. Just changes the sign if rop and op are the same variable.
Set rop to the absolute value of op, rounded in the direction rnd. Just changes the sign if rop and op are the same variable.
Set rop to the positive difference of op1 and op2, i.e., op1 - op2 rounded in the direction rnd if op1 > op2, and +0 otherwise. Returns NaN when op1 or op2 is NaN.
Set rop to op1 times 2 raised to op2 rounded in the direction rnd. Just increases the exponent by op2 when rop and op1 are identical.
Set rop to op1 divided by 2 raised to op2 rounded in the direction rnd. Just decreases the exponent by op2 when rop and op1 are identical.
Compare op1 and op2. Return a positive value if op1 > op2, zero if op1 = op2, and a negative value if op1 < op2. Both op1 and op2 are considered to their full own precision, which may differ. If one of the operands is NaN, set the erange flag and return zero.
Note: These functions may be useful to distinguish the three possible cases. If you need to distinguish two cases only, it is recommended to use the predicate functions (e.g.,
mpfr_equal_pfor the equality) described below; they behave like the IEEE-754 comparisons, in particular when one or both arguments are NaN. But only floating-point numbers can be compared (you may need to do a conversion first).
Compare op1 and op2 multiplied by two to the power e. Similar as above.
Compare |op1| and |op2|. Return a positive value if |op1| > |op2|, zero if |op1| = |op2|, and a negative value if |op1| < |op2|. If one of the operands is NaN, set the erange flag and return zero.
Return non-zero if op is respectively NaN, an infinity, an ordinary number (i.e. neither NaN nor an infinity) or zero. Return zero otherwise.
Return a positive value if op > 0, zero if op = 0, and a negative value if op < 0. If the operand is NaN, set the erange flag and return zero.
Return non-zero if op1 > op2, zero otherwise.
Return non-zero if op1 >= op2, zero otherwise.
Return non-zero if op1 <= op2, zero otherwise.
Return non-zero if op1 < op2 or op1 > op2 (i.e. neither op1, nor op2 is NaN, and op1 <> op2), zero otherwise (i.e. op1 and/or op2 are NaN, or op1 = op2).
Return non-zero if op1 = op2, zero otherwise (i.e. op1 and/or op2 are NaN, or op1 <> op2).
Return non-zero if op1 or op2 is a NaN (i.e. they cannot be compared), zero otherwise.
All those functions, except explicitly stated, return zero for an exact return value, a positive value for a return value larger than the exact result, and a negative value otherwise.
Important note: in some domains, computing special functions (either with correct or incorrect rounding) is expensive, even for small precision, for example the trigonometric and Bessel functions for large argument.
Set rop to the natural logarithm of op, log2(op) or log10(op), respectively, rounded in the direction rnd. Return −Inf if op is −0 (i.e. the sign of the zero has no influence on the result).
Set rop to the exponential of op, to 2 power of op or to 10 power of op, respectively, rounded in the direction rnd.
Set rop to the cosine of op, sine of op, tangent of op, rounded in the direction rnd.
Set rop to the secant of op, cosecant of op, cotangent of op, rounded in the direction rnd.
Set simultaneously sop to the sine of op and cop to the cosine of op, rounded in the direction rnd with the corresponding precisions of sop and cop, which must be different variables. Return 0 iff both results are exact.
Set rop to the arc-cosine, arc-sine or arc-tangent of op, rounded in the direction rnd. Note that since
acos(-1)returns the floating-point number closest to Pi according to the given rounding mode, this number might not be in the output range 0 <= rop < \pi of the arc-cosine function; still, the result lies in the image of the output range by the rounding function. The same holds forasin(-1),asin(1),atan(-Inf),atan(+Inf).
Set rop to the arc-tangent2 of y and x, rounded in the direction rnd: if
x > 0,atan2(y, x) = atan (y/x); ifx < 0,atan2(y, x) = sign(y)*(Pi - atan (abs(y/x))). As foratan, in case the exact mathematical result is +Pi or -Pi, its rounded result might be outside the function output range.
atan2(y, 0)does not raise any floating-point exception. Special values are currently handled as described in the ISO C99 standard for theatan2function (note this may change in future versions):
atan2(+0, -0)returns +Pi.atan2(-0, -0)returns -Pi.atan2(+0, +0)returns +0.atan2(-0, +0)returns −0.atan2(+0, x)returns +Pi for x < 0.atan2(-0, x)returns -Pi for x < 0.atan2(+0, x)returns +0 for x > 0.atan2(-0, x)returns −0 for x > 0.atan2(y, 0)returns -Pi/2 for y < 0.atan2(y, 0)returns +Pi/2 for y > 0.atan2(+Inf, -Inf)returns +3*Pi/4.atan2(-Inf, -Inf)returns -3*Pi/4.atan2(+Inf, +Inf)returns +Pi/4.atan2(-Inf, +Inf)returns -Pi/4.atan2(+Inf, x)returns +Pi/2 for finite x.atan2(-Inf, x)returns -Pi/2 for finite x.atan2(y, -Inf)returns +Pi for finite y > 0.atan2(y, -Inf)returns -Pi for finite y < 0.atan2(y, +Inf)returns +0 for finite y > 0.atan2(y, +Inf)returns −0 for finite y < 0.
Set rop to the hyperbolic cosine, sine or tangent of op, rounded in the direction rnd.
Set simultaneously sop to the hyperbolic sine of op and cop to the hyperbolic cosine of op, rounded in the direction rnd with the corresponding precision of sop and cop which must be different variables. Return 0 iff both results are exact.
Set rop to the hyperbolic secant of op, cosecant of op, cotangent of op, rounded in the direction rnd.
Set rop to the inverse hyperbolic cosine, sine or tangent of op, rounded in the direction rnd.
Set rop to the factorial of the
unsigned long intop, rounded in the direction rnd.
Set rop to the logarithm of one plus op, rounded in the direction rnd.
Set rop to the exponential of op minus one, rounded in the direction rnd.
Set y to the exponential integral of x, rounded in the direction rnd. For positive x, the exponential integral is the sum of Euler's constant, of the logarithm of x, and of the sum for k from 1 to infinity of x to the power k, divided by k and factorial(k). For negative x, the returned value is NaN.
Set rop to real part of the dilogarithm of op, rounded in the direction rnd_mode. The dilogarithm function is defined here as the integral of -log(1-t)/t from 0 to x.
Set rop to the value of the Gamma function on op, rounded in the direction rnd. When op is a negative integer, NaN is returned.
Set rop to the value of the logarithm of the Gamma function on op, rounded in the direction rnd. When −2k−1 <= x <= −2k, k being a non-negative integer, NaN is returned. See also
mpfr_lgamma.
Set rop to the value of the logarithm of the absolute value of the Gamma function on op, rounded in the direction rnd. The sign (1 or −1) of Gamma(op) is returned in the object pointed to by signp. When op is an infinity or a non-positive integer, +Inf is returned. When op is NaN, −Inf or a negative integer, *signp is undefined, and when op is ±0, *signp is the sign of the zero.
Set rop to the value of the Riemann Zeta function on op, rounded in the direction rnd.
Set rop to the value of the error function on op, rounded in the direction rnd.
Set rop to the value of the complementary error function on op, rounded in the direction rnd.
Set rop to the value of the first kind Bessel function of order 0, 1 and n on op, rounded in the direction rnd. When op is NaN, rop is always set to NaN. When op is plus or minus Infinity, rop is set to +0. When op is zero, and n is not zero, rop is +0 or −0 depending on the parity and sign of n, and the sign of op.
Set rop to the value of the second kind Bessel function of order 0, 1 and n on op, rounded in the direction rnd. When op is NaN or negative, rop is always set to NaN. When op is +Inf, rop is +0. When op is zero, rop is +Inf or −Inf depending on the parity and sign of n.
Set rop to (op1 times op2) + op3, rounded in the direction rnd.
Set rop to (op1 times op2) - op3, rounded in the direction rnd.
Set rop to the arithmetic-geometric mean of op1 and op2, rounded in the direction rnd. The arithmetic-geometric mean is the common limit of the sequences u[n] and v[n], where u[0]=op1, v[0]=op2, u[n+1] is the arithmetic mean of u[n] and v[n], and v[n+1] is the geometric mean of u[n] and v[n]. If any operand is negative, the return value is NaN.
Set rop to the Euclidean norm of x and y, i.e. the square root of the sum of the squares of x and y, rounded in the direction rnd. Special values are currently handled as described in Section F.9.4.3 of the ISO C99 standard, for the
hypotfunction (note this may change in future versions): If x or y is an infinity, then plus infinity is returned in rop, even if the other number is NaN.
Set rop to the logarithm of 2, the value of Pi, of Euler's constant 0.577..., of Catalan's constant 0.915..., respectively, rounded in the direction rnd. These functions cache the computed values to avoid other calculations if a lower or equal precision is requested. To free these caches, use
mpfr_free_cache.
Free various caches used by MPFR internally, in particular the caches used by the functions computing constants (currently
mpfr_const_log2,mpfr_const_pi,mpfr_const_eulerandmpfr_const_catalan). You should call this function before terminating a thread, even if you did not call these functions directly (they could have been called internally).
Set ret to the sum of all elements of tab whose size is n, rounded in the direction rnd. Warning, tab is a table of pointers to mpfr_t, not a table of mpfr_t (preliminary interface). The returned
intvalue is zero when the computed value is the exact value, and non-zero when this cannot be guaranteed, without giving the direction of the error as the other functions do.
This section describes functions that perform input from an input/output
stream, and functions that output to an input/output stream.
Passing a null pointer for a stream to any of these functions will make
them read from stdin and write to stdout, respectively.
When using any of these functions, you must include the <stdio.h>
standard header before mpfr.h, to allow mpfr.h to define
prototypes for these functions.
Output op on stream stream, as a string of digits in base base, rounded in the direction rnd. The base may vary from 2 to 36. Print n significant digits exactly, or if n is 0, enough digits so that op can be read back exactly (see
mpfr_get_str).In addition to the significant digits, a decimal point (defined by the current locale) at the right of the first digit and a trailing exponent in base 10, in the form ‘eNNN’, are printed. If base is greater than 10, ‘@’ will be used instead of ‘e’ as exponent delimiter.
Return the number of bytes written, or if an error occurred, return 0.
Input a string in base base from stream stream, rounded in the direction rnd, and put the read float in rop.
This function reads a word (defined as a sequence of characters between whitespace) and parses it using
mpfr_set_str(it may change). See the documentation ofmpfr_strtofrfor a detailed description of the valid string formats.Return the number of bytes read, or if an error occurred, return 0.
The class of mpfr_printf functions provides formatted output in a
similar manner as the standard C printf. These functions are defined
only if your system supports ISO C variadic functions and the corresponding
argument access macros.
When using any of these functions, you must include the <stdio.h>
standard header before mpfr.h, to allow mpfr.h to define
prototypes for these functions.
The format specification accepted by mpfr_printf is an extension of the
printf one. The conversion specification is of the form:
% [flags] [width] [.[precision]] [type] [rounding] conv
‘flags’, ‘width’, and ‘precision’ have the same meaning as for
the standard C function printf (in particular, notice that the
precision is related to the number of digits displayed in the base chosen by
‘conv’ and not related to the internal precision of the mpfr_t
variable). mpfr_printf accepts the same ‘type’ specifiers as
gmp (except the non-standard and deprecated ‘q’, use ‘ll’
instead), plus ‘R’ and ‘P’:
‘h’ short‘hh’ char‘j’ intmax_toruintmax_t‘l’ longorwchar_t‘ll’ long long‘L’ long double‘t’ ptrdiff_t‘z’ size_t
‘F’ mpf_t, float conversions‘Q’ mpq_t, integer conversions‘M’ mp_limb_t, integer conversions‘N’ mp_limb_tarray, integer conversions‘Z’ mpz_t, integer conversions
‘R’ mpfr_tinput, float conversions‘P’ mpfr_prec_tinput, integer conversions
The ‘type’ specifiers have the same restrictions as those
mentioned in the GMP documentation:
see Section “Formatted Output Strings” in GNU MP.
More precisely, except for ‘R’ and ‘P’
(which are defined by MPFR), the ‘type’ specifiers are supported
only if they are supported by gmp_printf in your GMP build;
this implies that the standard specifiers, such as ‘t’, must
also be supported by your C library if you want to use them.
The ‘rounding’ specifier is specific to mpfr_t parameter and shall
not be used with other types. mpfr_printf accepts the same conversion
specifier character ‘conv’ as gmp_printf plus ‘b’.
The ‘P’ type outputs the precision of an mpfr_t variable.
It is needed because the mpfr_prec_t type does not necessarily
correspond to an unsigned int or any fixed standard type.
For example:
mpfr_t x;
mpfr_prec_t p;
mpfr_init (x);
...
p = mpfr_get_prec (x);
mpfr_printf ("variable x with %Pu bits", p);
The ‘R’ type is used for a mpfr_t output and can be followed by
a rounding specifier denoted by one of the following characters:
‘U’ round toward plus infinity ‘D’ round toward minus infinity ‘Z’ round toward zero ‘N’ round to nearest ‘*’ rounding mode (as a mpfr_rnd_t) indicated by the argument just before the correspondingmpfr_tvariable.
If the precision field is not empty, the mpfr_t number is rounded to
the given precision in the direction specified by the rounding mode.
If the precision field is empty (as in ‘%.Rf’), the number is displayed
with enough digits so that it can be read back exactly (assuming rounding to
nearest, see mpfr_get_str).
If no rounding is specified, the mpfr_t argument is rounded to nearest.
The following three examples are equivalent:
mpfr_t x;
mpfr_init (x);
...
mpfr_printf ("%.128Rf", x);
mpfr_printf ("%.128RNf", x);
mpfr_printf ("%.128R*f", GMP_RNDN, x);
mpfr_printf also adds a new conversion specifier ‘b’ which
displays the mpfr_t parameter in binary, the behavior is undefined with
other parameter type.
The ‘conv’ specifiers allowed with mpfr_t parameter are:
‘a’ ‘A’ hex float, C99 style ‘b’ binary output ‘e’ ‘E’ scientific format float ‘f’ fixed point float ‘g’ ‘G’ fixed or scientific float
In case of non-decimal output, only the significand is written in the
specified base, the exponent is always displayed in decimal.
Special values are always displayed as nan, -inf, and
inf for ‘a’, ‘b’, ‘e’, ‘f’, and ‘g’
specifiers and NAN, -INF, and
INF for ‘A’, ‘E’, ‘F’, and ‘G’
specifiers.
In binary output, the precision is silently increased up to 2 if it equals 1.
Print to the stream stream the optional arguments under the control of the template string template.
Return the number of characters written or a negative value if an error occurred. If the number of characters which ought to be written appears to exceed the maximum limit for an
int, nothing is written in the stream, the function returns −1, sets the erange flag, and (in POSIX system only)errnois set toEOVERFLOW.
Print to stdout the optional arguments under the control of the template string template.
Return the number of characters written or a negative value if an error occurred. If the number of characters which ought to be written appears to exceed the maximum limit for an
int, nothing is written instdout, the function returns −1, sets the erange flag, and (in POSIX system only)errnois set toEOVERFLOW.