Home | History | Annotate | Download | only in mpfr
      1 Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
      2 Contributed by the AriC and Caramel projects, INRIA.
      3 
      4 This file is part of the GNU MPFR Library.
      5 
      6 The GNU MPFR Library is free software; you can redistribute it and/or modify
      7 it under the terms of the GNU Lesser General Public License as published by
      8 the Free Software Foundation; either version 3 of the License, or (at your
      9 option) any later version.
     10 
     11 The GNU MPFR Library is distributed in the hope that it will be useful, but
     12 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
     13 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
     14 License for more details.
     15 
     16 You should have received a copy of the GNU Lesser General Public License
     17 along with the GNU MPFR Library; see the file COPYING.LESSER.  If not, see
     18 http://www.gnu.org/licenses/ or write to the Free Software Foundation, Inc.,
     19 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
     20 
     21 ##############################################################################
     22 
     23 Changes from version 3.1.0 to version 3.1.1:
     24 - Improved MPFR manual.
     25 - Test coverage: 96.5% lines of code.
     26 - Bug fixes (see <http://www.mpfr.org/mpfr-3.1.0/#fixed> or ChangeLog file).
     27 
     28 Changes from versions 3.0.* to version 3.1.0:
     29 - The "canard  l'orange" release.
     30 - The MPFR source has been reorganized.
     31 - Dropped ansi2knr support.
     32 - TLS support is now detected automatically. If TLS is supported, MPFR is
     33   built as thread safe by default. To disable TLS explicitly, configure
     34   MPFR with --disable-thread-safe.
     35 - New --enable-gmp-internals configure option to use GMP's undocumented
     36   functions (not from the public API). Note that library versioning is
     37   not guaranteed to work if this option is used.
     38 - The mpfr_urandom and mpfr_urandomb functions now return identical values
     39   on processors with different word size (assuming the same random seed, and
     40   since the GMP random generator does not depend itself on the word size,
     41   cf http://gmplib.org/list-archives/gmp-devel/2010-September/001642.html).
     42 - The mpfr_add_one_ulp and mpfr_sub_one_ulp macros (which are obsolete and
     43   no more documented) will be removed in a future release.
     44 - Speed improvement for the mpfr_sqr and mpfr_div functions using Mulders'
     45   algorithm. As a consequence, other functions using those routines are
     46   also faster.
     47 - Much faster formatted output (mpfr_printf, etc.) with %Rg and similar.
     48 - The --with-gmp-build configure option can now be used when the GMP
     49   source directory and the GMP build directory are different (without
     50   having to copy header files manually as before).
     51 - New functions mpfr_buildopt_gmpinternals_p, mpfr_buildopt_tune_case,
     52   mpfr_frexp, mpfr_grandom and mpfr_z_sub.
     53 - New divide-by-zero exception (flag) and associated functions.
     54 - The mpfr.h header can be included several times, while still supporting
     55   optional functions (see Section "Headers and Libraries" in the manual).
     56 - Updated tuning parameters.
     57 - Improved MPFR manual.
     58 - MPFR tests: libtool no longer generates wrapper scripts with "make check"
     59   (so that running the tests under valgrind or gdb is easier).
     60 - Internal change: the logging mechanism has been improved.
     61 - Test coverage: 95.2% lines of code.
     62 - Bug fixes, in particular a huge inefficiency in mpfr_exp (when the
     63   target precision is less than MPFR_EXP_THRESHOLD) on hard-to-round
     64   cases, which can take several minutes.
     65   Note: The mpfr_subnormalize implementation up to MPFR 3.0.0 did not change
     66   the flags. In particular, it did not follow the generic rule concerning
     67   the inexact flag (and no special behavior was specified). The case of the
     68   underflow flag was more a lack of specification.
     69 
     70 Changes from versions 2.4.* to version 3.0.0:
     71 - The "boudin aux pommes" release.
     72 - MPFR 3.0.0 is binary incompatible with previous versions but (almost)
     73   API compatible.  More precisely the obsolete functions mpfr_random
     74   and mpfr_random2 have been removed, the meaning of the return type
     75   of the function mpfr_get_f has changed, and the return type of the
     76   function mpfr_get_z is now int instead of void.  In practice, this
     77   should not break any existing code.
     78 - MPFR is now distributed under the GNU Lesser General Public License
     79   version 3 or later (LGPL v3+).
     80 - Rounding modes GMP_RNDx are now MPFR_RNDx (GMP_RNDx kept for
     81   compatibility).
     82 - A new rounding mode (MPFR_RNDA) is available to round away from zero.
     83 - The rounding mode type is now mpfr_rnd_t (as in previous versions,
     84   both mpfr_rnd_t and mp_rnd_t are accepted, but mp_rnd_t may be
     85   removed in the future).
     86 - The precision type is now mpfr_prec_t (as in previous versions, both
     87   mpfr_prec_t and mp_prec_t are accepted, but mp_prec_t may be removed
     88   in the future) and it is now signed (it was unsigned in MPFR 2.*, but
     89   this was not documented). In practice, this change should not affect
     90   existing code that assumed nothing on the precision type.
     91 - MPFR now has its own exponent type mpfr_exp_t, which is currently
     92   the same as GMP's mp_exp_t.
     93 - Functions mpfr_random and mpfr_random2 have been removed.
     94 - mpfr_get_f and mpfr_get_z now return a ternary value.
     95 - mpfr_strtofr now accepts bases from 37 to 62.
     96 - mpfr_custom_get_mantissa was renamed to mpfr_custom_get_significand
     97   (mpfr_custom_get_mantissa is still available via a #define).
     98 - Functions mpfr_get_si, mpfr_get_ui, mpfr_get_sj, mpfr_get_uj,
     99   mpfr_get_z and mpfr_get_z_2exp no longer have cases with undefined
    100   behavior; in these cases, the behavior is now specified, and in
    101   particular, the erange flag is set.
    102 - New functions mpfr_buildopt_tls_p and mpfr_buildopt_decimal_p giving
    103   information about options used at MPFR build time.
    104 - New function mpfr_regular_p.
    105 - New function mpfr_set_zero.
    106 - New function mpfr_digamma.
    107 - New function mpfr_ai (incomplete, experimental).
    108 - New functions mpfr_set_flt and mpfr_get_flt to convert from/to the
    109   float type.
    110 - New function mpfr_urandom.
    111 - New function mpfr_set_z_2exp (companion to mpfr_get_z_2exp, which
    112   was renamed from mpfr_get_z_exp in previous versions).
    113 - New function mpfr_min_prec.
    114 - Speed improvement for large precisions in the trigonometric functions
    115   (mpfr_sin, mpfr_cos, mpfr_tan, mpfr_sin_cos): speedup of about 2.5
    116   for 10^5 digits, of about 5 for 10^6 digits.
    117 - Speed improvement for large precisions of the inverse trigonometric
    118   functions (arcsin, arccos, arctan): about 2 for 10^3 digits, up to
    119   2.7 for 10^6 digits.
    120 - Some documentation files are installed in $docdir.
    121 - The detection of a GMP build directory (more precisely, the internal
    122   header files of GMP) was previously done separately from the use of
    123   the --with-gmp-build configure option. This was not consistent with
    124   the documentation and with other parts of the configure script. So,
    125   as of MPFR 3.0.0, the internal header files of GMP are now used if
    126   and only if the --with-gmp-build configure option is given.
    127 - The configure script recognizes some extra "long double" formats
    128   (double big endian, double little endian, double-double big endian).
    129 - MPFR manual: added "API Compatibility" section.
    130 - Test coverage: 97.1% lines of code.
    131 - Bug fixes.
    132 
    133 Changes from versions 2.3.* to version 2.4.0:
    134 - The "andouillette sauce moutarde" release.
    135 - MPFR is now a GNU package.
    136 - Changes in the behavior of mpfr_strtofr and in its documentation
    137   concerning particular cases where the code and the documentation
    138   did not match; this change is also present in MPFR 2.3.1.
    139 - Behavior of mpfr_check_range changed: if the value is an inexact
    140   infinity, the overflow flag is set (in case it was lost); this
    141   change is also present in MPFR 2.3.2.
    142 - Function mpfr_init_gmp_rand (only defined when building MPFR without
    143   the --with-gmp-build configure option) is no longer defined at all.
    144   This function was private and not documented, and was used only in
    145   the MPFR test suite. User code that calls it is regarded as broken
    146   and may fail as a consequence. Running the old test suite against
    147   MPFR 2.4.0 may also fail.
    148 - New functions:
    149   * between a MPFR number and a double: mpfr_add_d, mpfr_sub_d,
    150     mpfr_d_sub, mpfr_mul_d, mpfr_div_d, mpfr_d_div,
    151   * formatted input/output:
    152     mpfr_printf, mpfr_fprintf, mpfr_vprintf, mpfr_vfprintf,
    153     mpfr_sprintf, mpfr_snprintf, mpfr_vsprintf, mpfr_vsnprintf,
    154     mpfr_asprintf, mpfr_vasprintf.
    155   * mpfr_sinh_cosh, mpfr_li2, mpfr_modf, mpfr_fmod, mpfr_rec_sqrt.
    156 - Configure test for TLS support.
    157 - Get default $CC and $CFLAGS from gmp.h (__GMP_CC / __GMP_CFLAGS,
    158   which are available as of GMP 4.2.3).
    159 - Documented the fact that mpfr_random and mpfr_random2 will be
    160   suppressed in the next release, and that the specification of
    161   mpfr_eq may change in the next release (for compatibility with
    162   the mpf layer of GMP).
    163 - Test coverage: 96.7% lines of code.
    164 - Bug fixes.
    165 
    166 Changes from versions 2.2.* to version 2.3.0:
    167 - The mpfr.info file is now installed in the share subdirectory
    168   (as required by the Filesystem Hierarchy Standard); see output
    169   of "./configure --help".
    170 - The shared library is now enabled by default. If the MPFR build
    171   fails on your platform, try the --disable-shared configure option
    172   to disable the shared library.
    173 - Thread-safe support with Microsoft Visual compiler.
    174 - New functions mpfr_j0, mpfr_j1, mpfr_jn, mpfr_y0, mpfr_y1, mpfr_yn,
    175   mpfr_lgamma, mpfr_remainder, mpfr_remquo, mpfr_fms, mpfr_signbit,
    176   mpfr_setsign, mpfr_copysign, mpfr_get_patches.
    177 - Functions mpfr_sin, mpfr_cos and mpfr_sin_cos improved (argument
    178   reduction).
    179 - More detailed MPFR manual.
    180 - Improved tests (make check).
    181 - Bug fixes.
    182 
    183 Changes from versions 2.1.* to version 2.2.0:
    184 - Bug fixes.
    185 - new functions mpfr_set_overflow, mpfr_set_underflow, mpfr_set_inexflag,
    186   mpfr_set_erangeflag, mpfr_set_nanflag, mpfr_erfc, mpfr_atan2, mpfr_pow_z,
    187   mpfr_subnormalize, mpfr_const_catalan, mpfr_sec, mpfr_csc, mpfr_cot,
    188   mpfr_root, mpfr_eint, mpfr_get_f, mpfr_sech, mpfr_csch, mpfr_coth,
    189   mpfr_lngamma.
    190 - new macro: MPFR_VERSION_STRING
    191 - Remove the exported MPFR variables from mpfr.h to mpfr-impl.h.
    192   (They were undocumented, so programs which respect the API still work).
    193 - Grep CC and CFLAGS from GMP Makefile if possible.
    194 - Math functions are faster (both average and worst cases).
    195 - Better support for long double.
    196 - Shared library of MPFR.
    197 - Binary compatible with previous versions if you do not use undocumented
    198   features.
    199 - Thread safe (if built with --enable-thread-safe).
    200 - Logging facility.
    201 - Change in the semantics of mpfr_out_str/mpfr_get_str when n_digits=0.
    202 - Better locale support.
    203 
    204 Changes from version 2.1.0 to version 2.1.1:
    205 - Better way to detect the GMP library.
    206 - Bug fixes.
    207 
    208 Changes from version 2.0.3 to version 2.1.0:
    209 - Bug fixes.
    210 - new functions mpfr_strtofr, mpfr_set_uj, mpfr_set_sj, mpfr_set_ui_2exp,
    211   mpfr_set_si_2exp, mpfr_set_sj_2exp, mpfr_set_uj_2exp, mpfr_get_uj,
    212   mpfr_get_sj, mpfr_get_z, mpfr_free_str, mpfr_si_sub, mpfr_sub_si,
    213   mpfr_mul_si, mpfr_si_div, mpfr_div_si, mpfr_sqr, mpfr_cmp_z, mpfr_cmp_q,
    214   mpfr_zero_p, mpfr_free_cache, mpfr_sum, mpfr_get_version,
    215   mpfr_get_default_rounding_mode, mpfr_get_emin_min, mpfr_get_emin_max,
    216   mpfr_get_emax_min, mpfr_get_emax_max, mpfr_inits, mpfr_inits2, mpfr_clears,
    217   mpfr_fits_intmax_p, mpfr_fits_uintmax_p, mpfr_clear_erangeflag,
    218   mpfr_erangeflag_p, mpfr_rint_round, mpfr_rint_trunc, mpfr_rint_ceil,
    219   mpfr_rint_floor.
    220 - new macros MPFR_DECL_INIT, MPFR_VERSION, MPFR_VERSION_NUM,
    221   MPFR_VERSION_MAJOR, MPFR_VERSION_MINOR, MPFR_VERSION_PATCHLEVEL.
    222 - improved documentation.
    223 - improved configure.
    224 - improved portability (library and test suite).
    225 - It handles correctly non IEEE-754 double.
    226 - GMP internal files are not needed to install MPFR.
    227 - It is faster with low-precision floating point.
    228 - New global flag: ERANGE_FLAG.
    229 - Binary incompatible with previous versions, but API compatible.
    230 - mpfr_set_str doesn't allow anymore "@NAN@garbagechar" and "@INF@garbagechar",
    231   allows base 0 (detection of the base), prefix (0x, 0b), leading whitespace.
    232 
    233 Changes from version 2.0.2 to version 2.0.3:
    234 - Bug fixes.
    235 - Support GMP as a shared library (not fully tested).
    236 
    237 Changes from version 2.0.1 to version 2.0.2:
    238 - many bug fixes and other improvements.
    239 - new functions mpfr_prec_round (replaces mpfr_round_prec), mpfr_get_exp,
    240   mpfr_set_exp, mpfr_get_ld, mpfr_set_ld, mpfr_get_d_2exp, mpfr_get_si,
    241   mpfr_get_ui, mpfr_nextabove, mpfr_nextbelow, mpfr_nexttoward, mpfr_frac,
    242   mpfr_fits_*, mpfr_cmp_d, mpfr_cmpabs, mpfr_erf, mpfr_gamma, mpfr_zeta,
    243   mpfr_greater_p, mpfr_greaterequal_p, mpfr_less_p, mpfr_lessequal_p,
    244   mpfr_lessgreater_p, mpfr_equal_p, mpfr_unordered_p.
    245 - removed functions: mpfr_print_binary, mpfr_round_prec (replaced by
    246   mpfr_prec_round), mpfr_set_str_raw, mpfr_set_machine_rnd_mode.
    247 - function mpfr_isinteger renamed mpfr_integer_p.
    248 - return type of some functions changed from void to int, for consistency.
    249 - return type of mpfr_set_prec changed from int to void.
    250 - new values for exponent range.
    251 - rename internal variables.
    252 
    253 Changes from version 2001 to version 2.0.1:
    254 - new mathematical functions: acos, acosh, asin, asinh, atan, atanh, cosh,
    255   base-2 exponential and logarithm, base-10 logarithm, expm1, factorial,
    256   pow, pow_si, pow_ui, sinh, tan, tanh, ui_pow, ui_pow_ui
    257 - other new functions: mpfr_const_euler, mpfr_dim, mpfr_fma, mpfr_hypot,
    258   mpfr_min, mpfr_max, mpfr_rint, mpfr_set_inf, mpfr_set_nan
    259 - new operations with MPZ or MPQ: mpfr_{add,sub,mul,div}_[zq]
    260 - new predicates: mpfr_inf_p, mpfr_nan_p, mpfr_number_p, mpfr_isinteger,
    261 - add mechanism to set/check exponent range (overflow, underflow), partially
    262   implemented in the mpfr functions.
    263 - efficiency: mpfr_div is now faster when the divisor has a few limbs
    264 - rounding: now mpfr_pow implements exact rounding, and most functions return a
    265   ternary value indicating the position of the returned value wrt the exact one
    266   (thus the return value is now 'int' instead of 'void')
    267 - complete rewrite of the configuration files
    268 - mpfr_get_d, mpfr_{add,sub}_one_ulp now get a rounding mode as 2nd argument
    269 - some function names did change: mpz_set_fr is now mpfr_get_z_exp,
    270   mpfr_print_raw is now mpfr_print_binary.
    271 
    272 Changes from version 1.0 to version 2001:
    273 - the default installation does not provide any more access to machine
    274   rounding mode, and as a consequence does not compare MPFR results with
    275   precision=53 to machine results. Add option -DTEST if you want to have
    276   access to machine rounding mode, and to check MPFR results against.
    277 - the MPFR files do not need <math.h> any more
    278 - the header file <mpfr.h> was split into <mpfr.h> for exported functions
    279   and <mpfr-impl.h> for internal functions. The user should not use functions
    280   or macros from <mpfr-impl.h>, since those may change in further releases.
    281 - <mpfr.h> was modified in order to make easy a C++ interface
    282 - MPFR now deals with infinities (+infinity and -infinity) and NaN
    283 - the missing function mpfr_swap is now available
    284 - mpfr_zeta was removed (was incomplete)
    285 - mpfr_init and mpfr_init2 now initialize the corresponding variable to 0
    286   (like in other initialization functions from GNU MP)
    287 - in case memory allocation fails, an error message is output
    288 - several bugs of version 1.0 were fixed
    289 
    290 Changes from version 0.4 to version 1.0:
    291 
    292 - Version 1.0 now uses a standard configure/make installation.
    293 - Version 1.0 implements all functions that are available in the MPF class
    294   from GMP 3.1 (except mpf_swap) and a header file mpf2mpfr.h is included in
    295   the distribution for easy change from MPF to MPFR.
    296 - Version 1.0 implements new elementary functions: mpfr_sincos
    297 - Some functions and macros have been renamed: mpfr_log2 is now
    298   mpfr_const_log2, mpfr_pi is now mpfr_const_pi, SIGN is now MPFR_SIGN.
    299 - Version 1.0 uses faster algorithms for mpfr_exp, mpfr_const_pi,
    300   mpfr_const_log2. Compare the timings from version 1.0 and version 0.4.
    301 - Version 1.0 corrects some bugs of version 0.4.
    302 - The precision of MPFR variables is now named mpfr_prec, which makes it
    303   easier to change it, to say unsigned long long. Same for the rounding mode
    304   which is called mp_rnd_t.
    305 
    306 You'll find other news concerning the GNU MPFR library on the web
    307 page <http://www.mpfr.org/>.
    308