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 struct fltSemantics;
  25 class APSInt;
  26 class StringRef;
  27
  28 /// Enum that represents what fraction of the LSB truncated bits of an fp number
  29 /// represent.
  30 ///
  31 /// This essentially combines the roles of guard and sticky bits.
  32 enum lostFraction { // Example of truncated bits:
  33   lfExactlyZero,    // 000000
  34   lfLessThanHalf,   // 0xxxxx  x's not all zero
  35   lfExactlyHalf,    // 100000
  36   lfMoreThanHalf    // 1xxxxx  x's not all zero
  37 };
  38
  39 /// \brief A self-contained host- and target-independent arbitrary-precision
  40 /// floating-point software implementation.
  41 ///
  42 /// APFloat uses bignum integer arithmetic as provided by static functions in
  43 /// the APInt class.  The library will work with bignum integers whose parts are
  44 /// any unsigned type at least 16 bits wide, but 64 bits is recommended.
  45 ///
  46 /// Written for clarity rather than speed, in particular with a view to use in
  47 /// the front-end of a cross compiler so that target arithmetic can be correctly
  48 /// performed on the host.  Performance should nonetheless be reasonable,
  49 /// particularly for its intended use.  It may be useful as a base
  50 /// implementation for a run-time library during development of a faster
  51 /// target-specific one.
  52 ///
  53 /// All 5 rounding modes in the IEEE-754R draft are handled correctly for all
  54 /// implemented operations.  Currently implemented operations are add, subtract,
  55 /// multiply, divide, fused-multiply-add, conversion-to-float,
  56 /// conversion-to-integer and conversion-from-integer.  New rounding modes
  57 /// (e.g. away from zero) can be added with three or four lines of code.
  58 ///
  59 /// Four formats are built-in: IEEE single precision, double precision,
  60 /// quadruple precision, and x87 80-bit extended double (when operating with
  61 /// full extended precision).  Adding a new format that obeys IEEE semantics
  62 /// only requires adding two lines of code: a declaration and definition of the
  63 /// format.
  64 ///
  65 /// All operations return the status of that operation as an exception bit-mask,
  66 /// so multiple operations can be done consecutively with their results or-ed
  67 /// together.  The returned status can be useful for compiler diagnostics; e.g.,
  68 /// inexact, underflow and overflow can be easily diagnosed on constant folding,
  69 /// and compiler optimizers can determine what exceptions would be raised by
  70 /// folding operations and optimize, or perhaps not optimize, accordingly.
  71 ///
  72 /// At present, underflow tininess is detected after rounding; it should be
  73 /// straight forward to add support for the before-rounding case too.
  74 ///
  75 /// The library reads hexadecimal floating point numbers as per C99, and
  76 /// correctly rounds if necessary according to the specified rounding mode.
  77 /// Syntax is required to have been validated by the caller.  It also converts
  78 /// floating point numbers to hexadecimal text as per the C99 %a and %A
  79 /// conversions.  The output precision (or alternatively the natural minimal
  80 /// precision) can be specified; if the requested precision is less than the
  81 /// natural precision the output is correctly rounded for the specified rounding
  82 /// mode.
  83 ///
  84 /// It also reads decimal floating point numbers and correctly rounds according
  85 /// to the specified rounding mode.
  86 ///
  87 /// Conversion to decimal text is not currently implemented.
  88 ///
  89 /// Non-zero finite numbers are represented internally as a sign bit, a 16-bit
  90 /// signed exponent, and the significand as an array of integer parts.  After
  91 /// normalization of a number of precision P the exponent is within the range of
  92 /// the format, and if the number is not denormal the P-th bit of the
  93 /// significand is set as an explicit integer bit.  For denormals the most
  94 /// significant bit is shifted right so that the exponent is maintained at the
  95 /// format's minimum, so that the smallest denormal has just the least
  96 /// significant bit of the significand set.  The sign of zeroes and infinities
  97 /// is significant; the exponent and significand of such numbers is not stored,
  98 /// but has a known implicit (deterministic) value: 0 for the significands, 0
  99 /// for zero exponent, all 1 bits for infinity exponent.  For NaNs the sign and
 100 /// significand are deterministic, although not really meaningful, and preserved
 101 /// in non-conversion operations.  The exponent is implicitly all 1 bits.
 102 ///
 103 /// APFloat does not provide any exception handling beyond default exception
 104 /// handling. We represent Signaling NaNs via IEEE-754R 2008 6.2.1 should clause
 105 /// by encoding Signaling NaNs with the first bit of its trailing significand as
 106 /// 0.
 107 ///
 108 /// TODO
 109 /// ====
 110 ///
 111 /// Some features that may or may not be worth adding:
 112 ///
 113 /// Binary to decimal conversion (hard).
 114 ///
 115 /// Optional ability to detect underflow tininess before rounding.
 116 ///
 117 /// New formats: x87 in single and double precision mode (IEEE apart from
 118 /// extended exponent range) (hard).
 119 ///
 120 /// New operations: sqrt, IEEE remainder, C90 fmod, nextafter, nexttoward.
 121 ///
 122 class APFloat {
 123 public:
 124
 125   /// A signed type to represent a floating point numbers unbiased exponent.
 126   typedef signed short ExponentType;
 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   /// @}
 304
 305   /// \name Sign operations.
 306   /// @{
 307
 308   void changeSign();
 309   void clearSign();
 310   void copySign(const APFloat &);
 311
 312   /// @}
 313
 314   /// \name Conversions
 315   /// @{
 316
 317   opStatus convert(const fltSemantics &, roundingMode, bool *);
 318   opStatus convertToInteger(integerPart *, unsigned int, bool, roundingMode,
 319                             bool *) const;
 320   opStatus convertToInteger(APSInt &, roundingMode, bool *) const;
 321   opStatus convertFromAPInt(const APInt &, bool, roundingMode);
 322   opStatus convertFromSignExtendedInteger(const integerPart *, unsigned int,
 323                                           bool, roundingMode);
 324   opStatus convertFromZeroExtendedInteger(const integerPart *, unsigned int,
 325                                           bool, roundingMode);
 326   opStatus convertFromString(StringRef, roundingMode);
 327   APInt bitcastToAPInt() const;
 328   double convertToDouble() const;
 329   float convertToFloat() const;
 330
 331   /// @}
 332
 333   /// The definition of equality is not straightforward for floating point, so
 334   /// we won't use operator==.  Use one of the following, or write whatever it
 335   /// is you really mean.
 336   bool operator==(const APFloat &) const LLVM_DELETED_FUNCTION;
 337
 338   /// IEEE comparison with another floating point number (NaNs compare
 339   /// unordered, 0==-0).
 340   cmpResult compare(const APFloat &) const;
 341
 342   /// Bitwise comparison for equality (QNaNs compare equal, 0!=-0).
 343   bool bitwiseIsEqual(const APFloat &) const;
 344
 345   /// Write out a hexadecimal representation of the floating point value to DST,
 346   /// which must be of sufficient size, in the C99 form [-]0xh.hhhhp[+-]d.
 347   /// Return the number of characters written, excluding the terminating NUL.
 348   unsigned int convertToHexString(char *dst, unsigned int hexDigits,
 349                                   bool upperCase, roundingMode) const;
 350
 351   /// \name IEEE-754R 5.7.2 General operations.
 352   /// @{
 353
 354   /// IEEE-754R isSignMinus: Returns true if and only if the current value is
 355   /// negative.
 356   ///
 357   /// This applies to zeros and NaNs as well.
 358   bool isNegative() const { return sign; }
 359
 360   /// IEEE-754R isNormal: Returns true if and only if the current value is normal.
 361   ///
 362   /// This implies that the current value of the float is not zero, subnormal,
 363   /// infinite, or NaN following the definition of normality from IEEE-754R.
 364   bool isNormal() const { return !isDenormal() && isFiniteNonZero(); }
 365
 366   /// Returns true if and only if the current value is zero, subnormal, or
 367   /// normal.
 368   ///
 369   /// This means that the value is not infinite or NaN.
 370   bool isFinite() const { return !isNaN() && !isInfinity(); }
 371
 372   /// Returns true if and only if the float is plus or minus zero.
 373   bool isZero() const { return category == fcZero; }
 374
 375   /// IEEE-754R isSubnormal(): Returns true if and only if the float is a
 376   /// denormal.
 377   bool isDenormal() const;
 378
 379   /// IEEE-754R isInfinite(): Returns true if and only if the float is infinity.
 380   bool isInfinity() const { return category == fcInfinity; }
 381
 382   /// Returns true if and only if the float is a quiet or signaling NaN.
 383   bool isNaN() const { return category == fcNaN; }
 384
 385   /// Returns true if and only if the float is a signaling NaN.
 386   bool isSignaling() const;
 387
 388   /// @}
 389
 390   /// \name Simple Queries
 391   /// @{
 392
 393   fltCategory getCategory() const { return category; }
 394   const fltSemantics &getSemantics() const { return *semantics; }
 395   bool isNonZero() const { return category != fcZero; }
 396   bool isFiniteNonZero() const { return isFinite() && !isZero(); }
 397   bool isPosZero() const { return isZero() && !isNegative(); }
 398   bool isNegZero() const { return isZero() && isNegative(); }
 399
 400   /// Returns true if and only if the number has the smallest possible non-zero
 401   /// magnitude in the current semantics.
 402   bool isSmallest() const;
 403
 404   /// Returns true if and only if the number has the largest possible finite
 405   /// magnitude in the current semantics.
 406   bool isLargest() const;
 407
 408   /// @}
 409
 410   APFloat &operator=(const APFloat &);
 411
 412   /// \brief Overload to compute a hash code for an APFloat value.
 413   ///
 414   /// Note that the use of hash codes for floating point values is in general
 415   /// frought with peril. Equality is hard to define for these values. For
 416   /// example, should negative and positive zero hash to different codes? Are
 417   /// they equal or not? This hash value implementation specifically
 418   /// emphasizes producing different codes for different inputs in order to
 419   /// be used in canonicalization and memoization. As such, equality is
 420   /// bitwiseIsEqual, and 0 != -0.
 421   friend hash_code hash_value(const APFloat &Arg);
 422
 423   /// Converts this value into a decimal string.
 424   ///
 425   /// \param FormatPrecision The maximum number of digits of
 426   ///   precision to output.  If there are fewer digits available,
 427   ///   zero padding will not be used unless the value is
 428   ///   integral and small enough to be expressed in
 429   ///   FormatPrecision digits.  0 means to use the natural
 430   ///   precision of the number.
 431   /// \param FormatMaxPadding The maximum number of zeros to
 432   ///   consider inserting before falling back to scientific
 433   ///   notation.  0 means to always use scientific notation.
 434   ///
 435   /// Number       Precision    MaxPadding      Result
 436   /// ------       ---------    ----------      ------
 437   /// 1.01E+4              5             2       10100
 438   /// 1.01E+4              4             2       1.01E+4
 439   /// 1.01E+4              5             1       1.01E+4
 440   /// 1.01E-2              5             2       0.0101
 441   /// 1.01E-2              4             2       0.0101
 442   /// 1.01E-2              4             1       1.01E-2
 443   void toString(SmallVectorImpl<char> &Str, unsigned FormatPrecision = 0,
 444                 unsigned FormatMaxPadding = 3) const;
 445
 446   /// If this value has an exact multiplicative inverse, store it in inv and
 447   /// return true.
 448   bool getExactInverse(APFloat *inv) const;
 449
 450 private:
 451
 452   /// \name Simple Queries
 453   /// @{
 454
 455   integerPart *significandParts();
 456   const integerPart *significandParts() const;
 457   unsigned int partCount() const;
 458
 459   /// @}
 460
 461   /// \name Significand operations.
 462   /// @{
 463
 464   integerPart addSignificand(const APFloat &);
 465   integerPart subtractSignificand(const APFloat &, integerPart);
 466   lostFraction addOrSubtractSignificand(const APFloat &, bool subtract);
 467   lostFraction multiplySignificand(const APFloat &, const APFloat *);
 468   lostFraction divideSignificand(const APFloat &);
 469   void incrementSignificand();
 470   void initialize(const fltSemantics *);
 471   void shiftSignificandLeft(unsigned int);
 472   lostFraction shiftSignificandRight(unsigned int);
 473   unsigned int significandLSB() const;
 474   unsigned int significandMSB() const;
 475   void zeroSignificand();
 476   /// Return true if the significand excluding the integral bit is all ones.
 477   bool isSignificandAllOnes() const;
 478   /// Return true if the significand excluding the integral bit is all zeros.
 479   bool isSignificandAllZeros() const;
 480
 481   /// @}
 482
 483   /// \name Arithmetic on special values.
 484   /// @{
 485
 486   opStatus addOrSubtractSpecials(const APFloat &, bool subtract);
 487   opStatus divideSpecials(const APFloat &);
 488   opStatus multiplySpecials(const APFloat &);
 489   opStatus modSpecials(const APFloat &);
 490
 491   /// @}
 492
 493   /// \name Special value setters.
 494   /// @{
 495
 496   void makeLargest(bool Neg = false);
 497   void makeSmallest(bool Neg = false);
 498   void makeNaN(bool SNaN = false, bool Neg = false, const APInt *fill = 0);
 499   static APFloat makeNaN(const fltSemantics &Sem, bool SNaN, bool Negative,
 500                          const APInt *fill);
 501
 502   /// @}
 503
 504   /// \name Miscellany
 505   /// @{
 506
 507   opStatus normalize(roundingMode, lostFraction);
 508   opStatus addOrSubtract(const APFloat &, roundingMode, bool subtract);
 509   cmpResult compareAbsoluteValue(const APFloat &) const;
 510   opStatus handleOverflow(roundingMode);
 511   bool roundAwayFromZero(roundingMode, lostFraction, unsigned int) const;
 512   opStatus convertToSignExtendedInteger(integerPart *, unsigned int, bool,
 513                                         roundingMode, bool *) const;
 514   opStatus convertFromUnsignedParts(const integerPart *, unsigned int,
 515                                     roundingMode);
 516   opStatus convertFromHexadecimalString(StringRef, roundingMode);
 517   opStatus convertFromDecimalString(StringRef, roundingMode);
 518   char *convertNormalToHexString(char *, unsigned int, bool,
 519                                  roundingMode) const;
 520   opStatus roundSignificandWithExponent(const integerPart *, unsigned int, int,
 521                                         roundingMode);
 522
 523   /// @}
 524
 525   APInt convertHalfAPFloatToAPInt() const;
 526   APInt convertFloatAPFloatToAPInt() const;
 527   APInt convertDoubleAPFloatToAPInt() const;
 528   APInt convertQuadrupleAPFloatToAPInt() const;
 529   APInt convertF80LongDoubleAPFloatToAPInt() const;
 530   APInt convertPPCDoubleDoubleAPFloatToAPInt() const;
 531   void initFromAPInt(const fltSemantics *Sem, const APInt &api);
 532   void initFromHalfAPInt(const APInt &api);
 533   void initFromFloatAPInt(const APInt &api);
 534   void initFromDoubleAPInt(const APInt &api);
 535   void initFromQuadrupleAPInt(const APInt &api);
 536   void initFromF80LongDoubleAPInt(const APInt &api);
 537   void initFromPPCDoubleDoubleAPInt(const APInt &api);
 538
 539   void assign(const APFloat &);
 540   void copySignificand(const APFloat &);
 541   void freeSignificand();
 542
 543   /// The semantics that this value obeys.
 544   const fltSemantics *semantics;
 545
 546   /// A binary fraction with an explicit integer bit.
 547   ///
 548   /// The significand must be at least one bit wider than the target precision.
 549   union Significand {
 550     integerPart part;
 551     integerPart *parts;
 552   } significand;
 553
 554   /// The signed unbiased exponent of the value.
 555   ExponentType exponent;
 556
 557   /// What kind of floating point number this is.
 558   ///
 559   /// Only 2 bits are required, but VisualStudio incorrectly sign extends it.
 560   /// Using the extra bit keeps it from failing under VisualStudio.
 561   fltCategory category : 3;
 562
 563   /// Sign bit of the number.
 564   unsigned int sign : 1;
 565 };
 566
 567 /// See friend declaration above.
 568 ///
 569 /// This additional declaration is required in order to compile LLVM with IBM
 570 /// xlC compiler.
 571 hash_code hash_value(const APFloat &Arg);
 572 } // namespace llvm
 573
 574 #endif // LLVM_ADT_APFLOAT_H