include/llvm/ADT/APFloat.h

   1 //== llvm/Support/APFloat.h - Arbitrary Precision Floating Point -*- C++ -*-==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief
  12 /// This file declares a class to represent arbitrary precision floating point
  13 /// values and provide a variety of arithmetic operations on them.
  14 ///
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ADT_APFLOAT_H
  18 #define LLVM_ADT_APFLOAT_H
  19
  20 #include "llvm/ADT/APInt.h"
  21
  22 namespace llvm {
  23
  24 /// A signed type to represent a floating point numbers unbiased exponent.
  25 typedef signed short exponent_t;
  26
  27 struct fltSemantics;
  28 class APSInt;
  29 class StringRef;
  30
  31 /// Enum that represents what fraction of the LSB truncated bits of an fp number
  32 /// represent.
  33 ///
  34 /// This essentially combines the roles of guard and sticky bits.
  35 enum lostFraction { // Example of truncated bits:
  36   lfExactlyZero,    // 000000
  37   lfLessThanHalf,   // 0xxxxx  x's not all zero
  38   lfExactlyHalf,    // 100000
  39   lfMoreThanHalf    // 1xxxxx  x's not all zero
  40 };
  41
  42 /// \brief A self-contained host- and target-independent arbitrary-precision
  43 /// floating-point software implementation.
  44 ///
  45 /// APFloat uses bignum integer arithmetic as provided by static functions in
  46 /// the APInt class.  The library will work with bignum integers whose parts are
  47 /// any unsigned type at least 16 bits wide, but 64 bits is recommended.
  48 ///
  49 /// Written for clarity rather than speed, in particular with a view to use in
  50 /// the front-end of a cross compiler so that target arithmetic can be correctly
  51 /// performed on the host.  Performance should nonetheless be reasonable,
  52 /// particularly for its intended use.  It may be useful as a base
  53 /// implementation for a run-time library during development of a faster
  54 /// target-specific one.
  55 ///
  56 /// All 5 rounding modes in the IEEE-754R draft are handled correctly for all
  57 /// implemented operations.  Currently implemented operations are add, subtract,
  58 /// multiply, divide, fused-multiply-add, conversion-to-float,
  59 /// conversion-to-integer and conversion-from-integer.  New rounding modes
  60 /// (e.g. away from zero) can be added with three or four lines of code.
  61 ///
  62 /// Four formats are built-in: IEEE single precision, double precision,
  63 /// quadruple precision, and x87 80-bit extended double (when operating with
  64 /// full extended precision).  Adding a new format that obeys IEEE semantics
  65 /// only requires adding two lines of code: a declaration and definition of the
  66 /// format.
  67 ///
  68 /// All operations return the status of that operation as an exception bit-mask,
  69 /// so multiple operations can be done consecutively with their results or-ed
  70 /// together.  The returned status can be useful for compiler diagnostics; e.g.,
  71 /// inexact, underflow and overflow can be easily diagnosed on constant folding,
  72 /// and compiler optimizers can determine what exceptions would be raised by
  73 /// folding operations and optimize, or perhaps not optimize, accordingly.
  74 ///
  75 /// At present, underflow tininess is detected after rounding; it should be
  76 /// straight forward to add support for the before-rounding case too.
  77 ///
  78 /// The library reads hexadecimal floating point numbers as per C99, and
  79 /// correctly rounds if necessary according to the specified rounding mode.
  80 /// Syntax is required to have been validated by the caller.  It also converts
  81 /// floating point numbers to hexadecimal text as per the C99 %a and %A
  82 /// conversions.  The output precision (or alternatively the natural minimal
  83 /// precision) can be specified; if the requested precision is less than the
  84 /// natural precision the output is correctly rounded for the specified rounding
  85 /// mode.
  86 ///
  87 /// It also reads decimal floating point numbers and correctly rounds according
  88 /// to the specified rounding mode.
  89 ///
  90 /// Conversion to decimal text is not currently implemented.
  91 ///
  92 /// Non-zero finite numbers are represented internally as a sign bit, a 16-bit
  93 /// signed exponent, and the significand as an array of integer parts.  After
  94 /// normalization of a number of precision P the exponent is within the range of
  95 /// the format, and if the number is not denormal the P-th bit of the
  96 /// significand is set as an explicit integer bit.  For denormals the most
  97 /// significant bit is shifted right so that the exponent is maintained at the
  98 /// format's minimum, so that the smallest denormal has just the least
  99 /// significant bit of the significand set.  The sign of zeroes and infinities
 100 /// is significant; the exponent and significand of such numbers is not stored,
 101 /// but has a known implicit (deterministic) value: 0 for the significands, 0
 102 /// for zero exponent, all 1 bits for infinity exponent.  For NaNs the sign and
 103 /// significand are deterministic, although not really meaningful, and preserved
 104 /// in non-conversion operations.  The exponent is implicitly all 1 bits.
 105 ///
 106 /// APFloat does not provide any exception handling beyond default exception
 107 /// handling. We represent Signaling NaNs via IEEE-754R 2008 6.2.1 should clause
 108 /// by encoding Signaling NaNs with the first bit of its trailing significand as
 109 /// 0.
 110 ///
 111 /// TODO
 112 /// ====
 113 ///
 114 /// Some features that may or may not be worth adding:
 115 ///
 116 /// Binary to decimal conversion (hard).
 117 ///
 118 /// Optional ability to detect underflow tininess before rounding.
 119 ///
 120 /// New formats: x87 in single and double precision mode (IEEE apart from
 121 /// extended exponent range) (hard).
 122 ///
 123 /// New operations: sqrt, IEEE remainder, C90 fmod, nextafter, nexttoward.
 124 ///
 125 class APFloat {
 126 public:
 127
 128   /// \name Floating Point Semantics.
 129   /// @{
 130
 131   static const fltSemantics IEEEhalf;
 132   static const fltSemantics IEEEsingle;
 133   static const fltSemantics IEEEdouble;
 134   static const fltSemantics IEEEquad;
 135   static const fltSemantics PPCDoubleDouble;
 136   static const fltSemantics x87DoubleExtended;
 137
 138   /// A Pseudo fltsemantic used to construct APFloats that cannot conflict with
 139   /// anything real.
 140   static const fltSemantics Bogus;
 141
 142   /// @}
 143
 144   static unsigned int semanticsPrecision(const fltSemantics &);
 145
 146   /// IEEE-754R 5.11: Floating Point Comparison Relations.
 147   enum cmpResult {
 148     cmpLessThan,
 149     cmpEqual,
 150     cmpGreaterThan,
 151     cmpUnordered
 152   };
 153
 154   /// IEEE-754R 4.3: Rounding-direction attributes.
 155   enum roundingMode {
 156     rmNearestTiesToEven,
 157     rmTowardPositive,
 158     rmTowardNegative,
 159     rmTowardZero,
 160     rmNearestTiesToAway
 161   };
 162
 163   /// IEEE-754R 7: Default exception handling.
 164   ///
 165   /// opUnderflow or opOverflow are always returned or-ed with opInexact.
 166   enum opStatus {
 167     opOK = 0x00,
 168     opInvalidOp = 0x01,
 169     opDivByZero = 0x02,
 170     opOverflow = 0x04,
 171     opUnderflow = 0x08,
 172     opInexact = 0x10
 173   };
 174
 175   /// Category of internally-represented number.
 176   enum fltCategory {
 177     fcInfinity,
 178     fcNaN,
 179     fcNormal,
 180     fcZero
 181   };
 182
 183   /// Convenience enum used to construct an uninitialized APFloat.
 184   enum uninitializedTag {
 185     uninitialized
 186   };
 187
 188   /// \name Constructors
 189   /// @{
 190
 191   APFloat(const fltSemantics &); // Default construct to 0.0
 192   APFloat(const fltSemantics &, StringRef);
 193   APFloat(const fltSemantics &, integerPart);
 194   APFloat(const fltSemantics &, fltCategory, bool negative);
 195   APFloat(const fltSemantics &, uninitializedTag);
 196   APFloat(const fltSemantics &, const APInt &);
 197   explicit APFloat(double d);
 198   explicit APFloat(float f);
 199   APFloat(const APFloat &);
 200   ~APFloat();
 201
 202   /// @}
 203
 204   /// \brief Returns whether this instance allocated memory.
 205   bool needsCleanup() const { return partCount() > 1; }
 206
 207   /// \name Convenience "constructors"
 208   /// @{
 209
 210   /// Factory for Positive and Negative Zero.
 211   ///
 212   /// \param Negative True iff the number should be negative.
 213   static APFloat getZero(const fltSemantics &Sem, bool Negative = false) {
 214     return APFloat(Sem, fcZero, Negative);
 215   }
 216
 217   /// Factory for Positive and Negative Infinity.
 218   ///
 219   /// \param Negative True iff the number should be negative.
 220   static APFloat getInf(const fltSemantics &Sem, bool Negative = false) {
 221     return APFloat(Sem, fcInfinity, Negative);
 222   }
 223
 224   /// Factory for QNaN values.
 225   ///
 226   /// \param Negative - True iff the NaN generated should be negative.
 227   /// \param type - The unspecified fill bits for creating the NaN, 0 by
 228   /// default.  The value is truncated as necessary.
 229   static APFloat getNaN(const fltSemantics &Sem, bool Negative = false,
 230                         unsigned type = 0) {
 231     if (type) {
 232       APInt fill(64, type);
 233       return getQNaN(Sem, Negative, &fill);
 234     } else {
 235       return getQNaN(Sem, Negative, 0);
 236     }
 237   }
 238
 239   /// Factory for QNaN values.
 240   static APFloat getQNaN(const fltSemantics &Sem, bool Negative = false,
 241                          const APInt *payload = 0) {
 242     return makeNaN(Sem, false, Negative, payload);
 243   }
 244
 245   /// Factory for SNaN values.
 246   static APFloat getSNaN(const fltSemantics &Sem, bool Negative = false,
 247                          const APInt *payload = 0) {
 248     return makeNaN(Sem, true, Negative, payload);
 249   }
 250
 251   /// Returns the largest finite number in the given semantics.
 252   ///
 253   /// \param Negative - True iff the number should be negative
 254   static APFloat getLargest(const fltSemantics &Sem, bool Negative = false);
 255
 256   /// Returns the smallest (by magnitude) finite number in the given semantics.
 257   /// Might be denormalized, which implies a relative loss of precision.
 258   ///
 259   /// \param Negative - True iff the number should be negative
 260   static APFloat getSmallest(const fltSemantics &Sem, bool Negative = false);
 261
 262   /// Returns the smallest (by magnitude) normalized finite number in the given
 263   /// semantics.
 264   ///
 265   /// \param Negative - True iff the number should be negative
 266   static APFloat getSmallestNormalized(const fltSemantics &Sem,
 267                                        bool Negative = false);
 268
 269   /// Returns a float which is bitcasted from an all one value int.
 270   ///
 271   /// \param BitWidth - Select float type
 272   /// \param isIEEE   - If 128 bit number, select between PPC and IEEE
 273   static APFloat getAllOnesValue(unsigned BitWidth, bool isIEEE = false);
 274
 275   /// @}
 276
 277   /// Used to insert APFloat objects, or objects that contain APFloat objects,
 278   /// into FoldingSets.
 279   void Profile(FoldingSetNodeID &NID) const;
 280
 281   /// \brief Used by the Bitcode serializer to emit APInts to Bitcode.
 282   void Emit(Serializer &S) const;
 283
 284   /// \brief Used by the Bitcode deserializer to deserialize APInts.
 285   static APFloat ReadVal(Deserializer &D);
 286
 287   /// \name Arithmetic
 288   /// @{
 289
 290   opStatus add(const APFloat &, roundingMode);
 291   opStatus subtract(const APFloat &, roundingMode);
 292   opStatus multiply(const APFloat &, roundingMode);
 293   opStatus divide(const APFloat &, roundingMode);
 294   /// IEEE remainder.
 295   opStatus remainder(const APFloat &);
 296   /// C fmod, or llvm frem.
 297   opStatus mod(const APFloat &, roundingMode);
 298   opStatus fusedMultiplyAdd(const APFloat &, const APFloat &, roundingMode);
 299   opStatus roundToIntegral(roundingMode);
 300   /// IEEE-754R 5.3.1: nextUp/nextDown.
 301   opStatus next(bool nextDown);
 302
 303   /// \name Sign operations.
 304   /// @{
 305
 306   void changeSign();
 307   void clearSign();
 308   void copySign(const APFloat &);
 309
 310   /// @}
 311
 312   /// \name Conversions
 313   /// @{
 314
 315   opStatus convert(const fltSemantics &, roundingMode, bool *);
 316   opStatus convertToInteger(integerPart *, unsigned int, bool, roundingMode,
 317                             bool *) const;
 318   opStatus convertToInteger(APSInt &, roundingMode, bool *) const;
 319   opStatus convertFromAPInt(const APInt &, bool, roundingMode);
 320   opStatus convertFromSignExtendedInteger(const integerPart *, unsigned int,
 321                                           bool, roundingMode);
 322   opStatus convertFromZeroExtendedInteger(const integerPart *, unsigned int,
 323                                           bool, roundingMode);
 324   opStatus convertFromString(StringRef, roundingMode);
 325   APInt bitcastToAPInt() const;
 326   double convertToDouble() const;
 327   float convertToFloat() const;
 328
 329   /// @}
 330
 331   /// The definition of equality is not straightforward for floating point, so
 332   /// we won't use operator==.  Use one of the following, or write whatever it
 333   /// is you really mean.
 334   bool operator==(const APFloat &) const LLVM_DELETED_FUNCTION;
 335
 336   /// IEEE comparison with another floating point number (NaNs compare
 337   /// unordered, 0==-0).
 338   cmpResult compare(const APFloat &) const;
 339
 340   /// Bitwise comparison for equality (QNaNs compare equal, 0!=-0).
 341   bool bitwiseIsEqual(const APFloat &) const;
 342
 343   /// Write out a hexadecimal representation of the floating point value to DST,
 344   /// which must be of sufficient size, in the C99 form [-]0xh.hhhhp[+-]d.
 345   /// Return the number of characters written, excluding the terminating NUL.
 346   unsigned int convertToHexString(char *dst, unsigned int hexDigits,
 347                                   bool upperCase, roundingMode) const;
 348
 349   /// \name IEEE-754R 5.7.2 General operations.
 350   /// @{
 351
 352   /// IEEE-754R isSignMinus: Returns true if and only if the current value is
 353   /// negative.
 354   ///
 355   /// This applies to zeros and NaNs as well.
 356   bool isNegative() const { return sign; }
 357
 358   /// IEEE-754R isNormal: Returns true if and only if the current value is normal.
 359   ///
 360   /// This implies that the current value of the float is not zero, subnormal,
 361   /// infinite, or NaN following the definition of normality from IEEE-754R.
 362   ///
 363   /// The current implementation of isNormal() differs from this by treating
 364   /// subnormal values as normal values.
 365   bool isIEEENormal() const { return !isDenormal() && isFiniteNonZero(); }
 366
 367   /// Returns true if and only if the current value is zero, subnormal, or
 368   /// normal.
 369   ///
 370   /// This means that the value is not infinite or NaN.
 371   bool isFinite() const { return !isNaN() && !isInfinity(); }
 372
 373   /// Returns true if and only if the float is plus or minus zero.
 374   bool isZero() const { return category == fcZero; }
 375
 376   /// IEEE-754R isSubnormal(): Returns true if and only if the float is a
 377   /// denormal.
 378   bool isDenormal() const;
 379
 380   /// IEEE-754R isInfinite(): Returns true if and only if the float is infinity.
 381   bool isInfinity() const { return category == fcInfinity; }
 382
 383   /// Returns true if and only if the float is a quiet or signaling NaN.
 384   bool isNaN() const { return category == fcNaN; }
 385
 386   /// Returns true if and only if the float is a signaling NaN.
 387   bool isSignaling() const;
 388
 389   /// @}
 390
 391   /// \name Simple Queries
 392   /// @{
 393
 394   fltCategory getCategory() const { return category; }
 395   const fltSemantics &getSemantics() const { return *semantics; }
 396   bool isNonZero() const { return category != fcZero; }
 397   bool isNormal() const { return category == fcNormal; }
 398   bool isFiniteNonZero() const { return isFinite() && !isZero(); }
 399   bool isPosZero() const { return isZero() && !isNegative(); }
 400   bool isNegZero() const { return isZero() && isNegative(); }
 401
 402   /// Returns true if and only if the number has the smallest possible non-zero
 403   /// magnitude in the current semantics.
 404   bool isSmallest() const;
 405
 406   /// Returns true if and only if the number has the largest possible finite
 407   /// magnitude in the current semantics.
 408   bool isLargest() const;
 409
 410   /// @}
 411
 412   APFloat &operator=(const APFloat &);
 413
 414   /// \brief Overload to compute a hash code for an APFloat value.
 415   ///
 416   /// Note that the use of hash codes for floating point values is in general
 417   /// frought with peril. Equality is hard to define for these values. For
 418   /// example, should negative and positive zero hash to different codes? Are
 419   /// they equal or not? This hash value implementation specifically
 420   /// emphasizes producing different codes for different inputs in order to
 421   /// be used in canonicalization and memoization. As such, equality is
 422   /// bitwiseIsEqual, and 0 != -0.
 423   friend hash_code hash_value(const APFloat &Arg);
 424
 425   /// Converts this value into a decimal string.
 426   ///
 427   /// \param FormatPrecision The maximum number of digits of
 428   ///   precision to output.  If there are fewer digits available,
 429   ///   zero padding will not be used unless the value is
 430   ///   integral and small enough to be expressed in
 431   ///   FormatPrecision digits.  0 means to use the natural
 432   ///   precision of the number.
 433   /// \param FormatMaxPadding The maximum number of zeros to
 434   ///   consider inserting before falling back to scientific
 435   ///   notation.  0 means to always use scientific notation.
 436   ///
 437   /// Number       Precision    MaxPadding      Result
 438   /// ------       ---------    ----------      ------
 439   /// 1.01E+4              5             2       10100
 440   /// 1.01E+4              4             2       1.01E+4
 441   /// 1.01E+4              5             1       1.01E+4
 442   /// 1.01E-2              5             2       0.0101
 443   /// 1.01E-2              4             2       0.0101
 444   /// 1.01E-2              4             1       1.01E-2
 445   void toString(SmallVectorImpl<char> &Str, unsigned FormatPrecision = 0,
 446                 unsigned FormatMaxPadding = 3) const;
 447
 448   /// If this value has an exact multiplicative inverse, store it in inv and
 449   /// return true.
 450   bool getExactInverse(APFloat *inv) const;
 451
 452 private:
 453
 454   /// \name Simple Queries
 455   /// @{
 456
 457   integerPart *significandParts();
 458   const integerPart *significandParts() const;
 459   unsigned int partCount() const;
 460
 461   /// @}
 462
 463   /// \name Significand operations.
 464   /// @{
 465
 466   integerPart addSignificand(const APFloat &);
 467   integerPart subtractSignificand(const APFloat &, integerPart);
 468   lostFraction addOrSubtractSignificand(const APFloat &, bool subtract);
 469   lostFraction multiplySignificand(const APFloat &, const APFloat *);
 470   lostFraction divideSignificand(const APFloat &);
 471   void incrementSignificand();
 472   void initialize(const fltSemantics *);
 473   void shiftSignificandLeft(unsigned int);
 474   lostFraction shiftSignificandRight(unsigned int);
 475   unsigned int significandLSB() const;
 476   unsigned int significandMSB() const;
 477   void zeroSignificand();
 478   /// Return true if the significand excluding the integral bit is all ones.
 479   bool isSignificandAllOnes() const;
 480   /// Return true if the significand excluding the integral bit is all zeros.
 481   bool isSignificandAllZeros() const;
 482
 483   /// @}
 484
 485   /// \name Arithmetic on special values.
 486   /// @{
 487
 488   opStatus addOrSubtractSpecials(const APFloat &, bool subtract);
 489   opStatus divideSpecials(const APFloat &);
 490   opStatus multiplySpecials(const APFloat &);
 491   opStatus modSpecials(const APFloat &);
 492
 493   /// @}
 494
 495   /// \name Special value setters.
 496   /// @{
 497
 498   void makeLargest(bool Neg = false);
 499   void makeSmallest(bool Neg = false);
 500   void makeNaN(bool SNaN = false, bool Neg = false, const APInt *fill = 0);
 501   static APFloat makeNaN(const fltSemantics &Sem, bool SNaN, bool Negative,
 502                          const APInt *fill);
 503
 504   /// @}
 505
 506   /// \name Miscellany
 507   /// @{
 508
 509   opStatus normalize(roundingMode, lostFraction);
 510   opStatus addOrSubtract(const APFloat &, roundingMode, bool subtract);
 511   cmpResult compareAbsoluteValue(const APFloat &) const;
 512   opStatus handleOverflow(roundingMode);
 513   bool roundAwayFromZero(roundingMode, lostFraction, unsigned int) const;
 514   opStatus convertToSignExtendedInteger(integerPart *, unsigned int, bool,
 515                                         roundingMode, bool *) const;
 516   opStatus convertFromUnsignedParts(const integerPart *, unsigned int,
 517                                     roundingMode);
 518   opStatus convertFromHexadecimalString(StringRef, roundingMode);
 519   opStatus convertFromDecimalString(StringRef, roundingMode);
 520   char *convertNormalToHexString(char *, unsigned int, bool,
 521                                  roundingMode) const;
 522   opStatus roundSignificandWithExponent(const integerPart *, unsigned int, int,
 523                                         roundingMode);
 524
 525   /// @}
 526
 527   APInt convertHalfAPFloatToAPInt() const;
 528   APInt convertFloatAPFloatToAPInt() const;
 529   APInt convertDoubleAPFloatToAPInt() const;
 530   APInt convertQuadrupleAPFloatToAPInt() const;
 531   APInt convertF80LongDoubleAPFloatToAPInt() const;
 532   APInt convertPPCDoubleDoubleAPFloatToAPInt() const;
 533   void initFromAPInt(const fltSemantics *Sem, const APInt &api);
 534   void initFromHalfAPInt(const APInt &api);
 535   void initFromFloatAPInt(const APInt &api);
 536   void initFromDoubleAPInt(const APInt &api);
 537   void initFromQuadrupleAPInt(const APInt &api);
 538   void initFromF80LongDoubleAPInt(const APInt &api);
 539   void initFromPPCDoubleDoubleAPInt(const APInt &api);
 540
 541   void assign(const APFloat &);
 542   void copySignificand(const APFloat &);
 543   void freeSignificand();
 544
 545   /// The semantics that this value obeys.
 546   const fltSemantics *semantics;
 547
 548   /// A binary fraction with an explicit integer bit.
 549   ///
 550   /// The significand must be at least one bit wider than the target precision.
 551   union Significand {
 552     integerPart part;
 553     integerPart *parts;
 554   } significand;
 555
 556   /// The signed unbiased exponent of the value.
 557   exponent_t exponent;
 558
 559   /// What kind of floating point number this is.
 560   ///
 561   /// Only 2 bits are required, but VisualStudio incorrectly sign extends it.
 562   /// Using the extra bit keeps it from failing under VisualStudio.
 563   fltCategory category : 3;
 564
 565   /// Sign bit of the number.
 566   unsigned int sign : 1;
 567 };
 568
 569 /// See friend declaration above.
 570 ///
 571 /// This additional declaration is required in order to compile LLVM with IBM
 572 /// xlC compiler.
 573 hash_code hash_value(const APFloat &Arg);
 574 } // namespace llvm
 575
 576 #endif // LLVM_ADT_APFLOAT_H