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 // This file declares a class to represent arbitrary precision floating
  11 // point values and provide a variety of arithmetic operations on them.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 /*  A self-contained host- and target-independent arbitrary-precision
  16     floating-point software implementation.  It uses bignum integer
  17     arithmetic as provided by static functions in the APInt class.
  18     The library will work with bignum integers whose parts are any
  19     unsigned type at least 16 bits wide, but 64 bits is recommended.
  20
  21     Written for clarity rather than speed, in particular with a view
  22     to use in the front-end of a cross compiler so that target
  23     arithmetic can be correctly performed on the host.  Performance
  24     should nonetheless be reasonable, particularly for its intended
  25     use.  It may be useful as a base implementation for a run-time
  26     library during development of a faster target-specific one.
  27
  28     All 5 rounding modes in the IEEE-754R draft are handled correctly
  29     for all implemented operations.  Currently implemented operations
  30     are add, subtract, multiply, divide, fused-multiply-add,
  31     conversion-to-float, conversion-to-integer and
  32     conversion-from-integer.  New rounding modes (e.g. away from zero)
  33     can be added with three or four lines of code.
  34
  35     Four formats are built-in: IEEE single precision, double
  36     precision, quadruple precision, and x87 80-bit extended double
  37     (when operating with full extended precision).  Adding a new
  38     format that obeys IEEE semantics only requires adding two lines of
  39     code: a declaration and definition of the format.
  40
  41     All operations return the status of that operation as an exception
  42     bit-mask, so multiple operations can be done consecutively with
  43     their results or-ed together.  The returned status can be useful
  44     for compiler diagnostics; e.g., inexact, underflow and overflow
  45     can be easily diagnosed on constant folding, and compiler
  46     optimizers can determine what exceptions would be raised by
  47     folding operations and optimize, or perhaps not optimize,
  48     accordingly.
  49
  50     At present, underflow tininess is detected after rounding; it
  51     should be straight forward to add support for the before-rounding
  52     case too.
  53
  54     The library reads hexadecimal floating point numbers as per C99,
  55     and correctly rounds if necessary according to the specified
  56     rounding mode.  Syntax is required to have been validated by the
  57     caller.  It also converts floating point numbers to hexadecimal
  58     text as per the C99 %a and %A conversions.  The output precision
  59     (or alternatively the natural minimal precision) can be specified;
  60     if the requested precision is less than the natural precision the
  61     output is correctly rounded for the specified rounding mode.
  62
  63     It also reads decimal floating point numbers and correctly rounds
  64     according to the specified rounding mode.
  65
  66     Conversion to decimal text is not currently implemented.
  67
  68     Non-zero finite numbers are represented internally as a sign bit,
  69     a 16-bit signed exponent, and the significand as an array of
  70     integer parts.  After normalization of a number of precision P the
  71     exponent is within the range of the format, and if the number is
  72     not denormal the P-th bit of the significand is set as an explicit
  73     integer bit.  For denormals the most significant bit is shifted
  74     right so that the exponent is maintained at the format's minimum,
  75     so that the smallest denormal has just the least significant bit
  76     of the significand set.  The sign of zeroes and infinities is
  77     significant; the exponent and significand of such numbers is not
  78     stored, but has a known implicit (deterministic) value: 0 for the
  79     significands, 0 for zero exponent, all 1 bits for infinity
  80     exponent.  For NaNs the sign and significand are deterministic,
  81     although not really meaningful, and preserved in non-conversion
  82     operations.  The exponent is implicitly all 1 bits.
  83
  84     TODO
  85     ====
  86
  87     Some features that may or may not be worth adding:
  88
  89     Binary to decimal conversion (hard).
  90
  91     Optional ability to detect underflow tininess before rounding.
  92
  93     New formats: x87 in single and double precision mode (IEEE apart
  94     from extended exponent range) (hard).
  95
  96     New operations: sqrt, IEEE remainder, C90 fmod, nextafter,
  97     nexttoward.
  98 */
  99
 100 #ifndef LLVM_FLOAT_H
 101 #define LLVM_FLOAT_H
 102
 103 // APInt contains static functions implementing bignum arithmetic.
 104 #include "llvm/ADT/APInt.h"
 105
 106 namespace llvm {
 107
 108   /* Exponents are stored as signed numbers.  */
 109   typedef signed short exponent_t;
 110
 111   struct fltSemantics;
 112   class StringRef;
 113
 114   /* When bits of a floating point number are truncated, this enum is
 115      used to indicate what fraction of the LSB those bits represented.
 116      It essentially combines the roles of guard and sticky bits.  */
 117   enum lostFraction {           // Example of truncated bits:
 118     lfExactlyZero,              // 000000
 119     lfLessThanHalf,             // 0xxxxx  x's not all zero
 120     lfExactlyHalf,              // 100000
 121     lfMoreThanHalf              // 1xxxxx  x's not all zero
 122   };
 123
 124   class APFloat {
 125   public:
 126
 127     /* We support the following floating point semantics.  */
 128     static const fltSemantics IEEEhalf;
 129     static const fltSemantics IEEEsingle;
 130     static const fltSemantics IEEEdouble;
 131     static const fltSemantics IEEEquad;
 132     static const fltSemantics PPCDoubleDouble;
 133     static const fltSemantics x87DoubleExtended;
 134     /* And this pseudo, used to construct APFloats that cannot
 135        conflict with anything real. */
 136     static const fltSemantics Bogus;
 137
 138     static unsigned int semanticsPrecision(const fltSemantics &);
 139
 140     /* Floating point numbers have a four-state comparison relation.  */
 141     enum cmpResult {
 142       cmpLessThan,
 143       cmpEqual,
 144       cmpGreaterThan,
 145       cmpUnordered
 146     };
 147
 148     /* IEEE-754R gives five rounding modes.  */
 149     enum roundingMode {
 150       rmNearestTiesToEven,
 151       rmTowardPositive,
 152       rmTowardNegative,
 153       rmTowardZero,
 154       rmNearestTiesToAway
 155     };
 156
 157     // Operation status.  opUnderflow or opOverflow are always returned
 158     // or-ed with opInexact.
 159     enum opStatus {
 160       opOK          = 0x00,
 161       opInvalidOp   = 0x01,
 162       opDivByZero   = 0x02,
 163       opOverflow    = 0x04,
 164       opUnderflow   = 0x08,
 165       opInexact     = 0x10
 166     };
 167
 168     // Category of internally-represented number.
 169     enum fltCategory {
 170       fcInfinity,
 171       fcNaN,
 172       fcNormal,
 173       fcZero
 174     };
 175
 176     // Constructors.
 177     APFloat(const fltSemantics &); // Default construct to 0.0
 178     APFloat(const fltSemantics &, const StringRef &);
 179     APFloat(const fltSemantics &, integerPart);
 180     APFloat(const fltSemantics &, fltCategory, bool negative, unsigned type=0);
 181     explicit APFloat(double d);
 182     explicit APFloat(float f);
 183     explicit APFloat(const APInt &, bool isIEEE = false);
 184     APFloat(const APFloat &);
 185     ~APFloat();
 186
 187     // Convenience "constructors"
 188     static APFloat getZero(const fltSemantics &Sem, bool Negative = false) {
 189       return APFloat(Sem, fcZero, Negative);
 190     }
 191     static APFloat getInf(const fltSemantics &Sem, bool Negative = false) {
 192       return APFloat(Sem, fcInfinity, Negative);
 193     }
 194     /// getNaN - Factory for QNaN values.
 195     ///
 196     /// \param Negative - True iff the NaN generated should be negative.
 197     /// \param type - The unspecified fill bits for creating the NaN, 0 by
 198     /// default.  The value is truncated as necessary.
 199     static APFloat getNaN(const fltSemantics &Sem, bool Negative = false,
 200                           unsigned type = 0) {
 201       return APFloat(Sem, fcNaN, Negative, type);
 202     }
 203
 204     /// Profile - Used to insert APFloat objects, or objects that contain
 205     ///  APFloat objects, into FoldingSets.
 206     void Profile(FoldingSetNodeID& NID) const;
 207
 208     /// @brief Used by the Bitcode serializer to emit APInts to Bitcode.
 209     void Emit(Serializer& S) const;
 210
 211     /// @brief Used by the Bitcode deserializer to deserialize APInts.
 212     static APFloat ReadVal(Deserializer& D);
 213
 214     /* Arithmetic.  */
 215     opStatus add(const APFloat &, roundingMode);
 216     opStatus subtract(const APFloat &, roundingMode);
 217     opStatus multiply(const APFloat &, roundingMode);
 218     opStatus divide(const APFloat &, roundingMode);
 219     /* IEEE remainder. */
 220     opStatus remainder(const APFloat &);
 221     /* C fmod, or llvm frem. */
 222     opStatus mod(const APFloat &, roundingMode);
 223     opStatus fusedMultiplyAdd(const APFloat &, const APFloat &, roundingMode);
 224
 225     /* Sign operations.  */
 226     void changeSign();
 227     void clearSign();
 228     void copySign(const APFloat &);
 229
 230     /* Conversions.  */
 231     opStatus convert(const fltSemantics &, roundingMode, bool *);
 232     opStatus convertToInteger(integerPart *, unsigned int, bool,
 233                               roundingMode, bool *) const;
 234     opStatus convertFromAPInt(const APInt &,
 235                               bool, roundingMode);
 236     opStatus convertFromSignExtendedInteger(const integerPart *, unsigned int,
 237                                             bool, roundingMode);
 238     opStatus convertFromZeroExtendedInteger(const integerPart *, unsigned int,
 239                                             bool, roundingMode);
 240     opStatus convertFromString(const StringRef&, roundingMode);
 241     APInt bitcastToAPInt() const;
 242     double convertToDouble() const;
 243     float convertToFloat() const;
 244
 245     /* The definition of equality is not straightforward for floating point,
 246        so we won't use operator==.  Use one of the following, or write
 247        whatever it is you really mean. */
 248     // bool operator==(const APFloat &) const;     // DO NOT IMPLEMENT
 249
 250     /* IEEE comparison with another floating point number (NaNs
 251        compare unordered, 0==-0). */
 252     cmpResult compare(const APFloat &) const;
 253
 254     /* Bitwise comparison for equality (QNaNs compare equal, 0!=-0). */
 255     bool bitwiseIsEqual(const APFloat &) const;
 256
 257     /* Write out a hexadecimal representation of the floating point
 258        value to DST, which must be of sufficient size, in the C99 form
 259        [-]0xh.hhhhp[+-]d.  Return the number of characters written,
 260        excluding the terminating NUL.  */
 261     unsigned int convertToHexString(char *dst, unsigned int hexDigits,
 262                                     bool upperCase, roundingMode) const;
 263
 264     /* Simple queries.  */
 265     fltCategory getCategory() const { return category; }
 266     const fltSemantics &getSemantics() const { return *semantics; }
 267     bool isZero() const { return category == fcZero; }
 268     bool isNonZero() const { return category != fcZero; }
 269     bool isNaN() const { return category == fcNaN; }
 270     bool isInfinity() const { return category == fcInfinity; }
 271     bool isNegative() const { return sign; }
 272     bool isPosZero() const { return isZero() && !isNegative(); }
 273     bool isNegZero() const { return isZero() && isNegative(); }
 274
 275     APFloat& operator=(const APFloat &);
 276
 277     /* Return an arbitrary integer value usable for hashing. */
 278     uint32_t getHashValue() const;
 279
 280   private:
 281
 282     /* Trivial queries.  */
 283     integerPart *significandParts();
 284     const integerPart *significandParts() const;
 285     unsigned int partCount() const;
 286
 287     /* Significand operations.  */
 288     integerPart addSignificand(const APFloat &);
 289     integerPart subtractSignificand(const APFloat &, integerPart);
 290     lostFraction addOrSubtractSignificand(const APFloat &, bool subtract);
 291     lostFraction multiplySignificand(const APFloat &, const APFloat *);
 292     lostFraction divideSignificand(const APFloat &);
 293     void incrementSignificand();
 294     void initialize(const fltSemantics *);
 295     void shiftSignificandLeft(unsigned int);
 296     lostFraction shiftSignificandRight(unsigned int);
 297     unsigned int significandLSB() const;
 298     unsigned int significandMSB() const;
 299     void zeroSignificand();
 300
 301     /* Arithmetic on special values.  */
 302     opStatus addOrSubtractSpecials(const APFloat &, bool subtract);
 303     opStatus divideSpecials(const APFloat &);
 304     opStatus multiplySpecials(const APFloat &);
 305     opStatus modSpecials(const APFloat &);
 306
 307     /* Miscellany.  */
 308     void makeNaN(unsigned = 0);
 309     opStatus normalize(roundingMode, lostFraction);
 310     opStatus addOrSubtract(const APFloat &, roundingMode, bool subtract);
 311     cmpResult compareAbsoluteValue(const APFloat &) const;
 312     opStatus handleOverflow(roundingMode);
 313     bool roundAwayFromZero(roundingMode, lostFraction, unsigned int) const;
 314     opStatus convertToSignExtendedInteger(integerPart *, unsigned int, bool,
 315                                           roundingMode, bool *) const;
 316     opStatus convertFromUnsignedParts(const integerPart *, unsigned int,
 317                                       roundingMode);
 318     opStatus convertFromHexadecimalString(const StringRef&, roundingMode);
 319     opStatus convertFromDecimalString (const StringRef&, roundingMode);
 320     char *convertNormalToHexString(char *, unsigned int, bool,
 321                                    roundingMode) const;
 322     opStatus roundSignificandWithExponent(const integerPart *, unsigned int,
 323                                           int, roundingMode);
 324
 325     APInt convertHalfAPFloatToAPInt() const;
 326     APInt convertFloatAPFloatToAPInt() const;
 327     APInt convertDoubleAPFloatToAPInt() const;
 328     APInt convertQuadrupleAPFloatToAPInt() const;
 329     APInt convertF80LongDoubleAPFloatToAPInt() const;
 330     APInt convertPPCDoubleDoubleAPFloatToAPInt() const;
 331     void initFromAPInt(const APInt& api, bool isIEEE = false);
 332     void initFromHalfAPInt(const APInt& api);
 333     void initFromFloatAPInt(const APInt& api);
 334     void initFromDoubleAPInt(const APInt& api);
 335     void initFromQuadrupleAPInt(const APInt &api);
 336     void initFromF80LongDoubleAPInt(const APInt& api);
 337     void initFromPPCDoubleDoubleAPInt(const APInt& api);
 338
 339     void assign(const APFloat &);
 340     void copySignificand(const APFloat &);
 341     void freeSignificand();
 342
 343     /* What kind of semantics does this value obey?  */
 344     const fltSemantics *semantics;
 345
 346     /* Significand - the fraction with an explicit integer bit.  Must be
 347        at least one bit wider than the target precision.  */
 348     union Significand
 349     {
 350       integerPart part;
 351       integerPart *parts;
 352     } significand;
 353
 354     /* The exponent - a signed number.  */
 355     exponent_t exponent;
 356
 357     /* What kind of floating point number this is.  */
 358     /* Only 2 bits are required, but VisualStudio incorrectly sign extends
 359        it.  Using the extra bit keeps it from failing under VisualStudio */
 360     fltCategory category: 3;
 361
 362     /* The sign bit of this number.  */
 363     unsigned int sign: 1;
 364
 365     /* For PPCDoubleDouble, we have a second exponent and sign (the second
 366        significand is appended to the first one, although it would be wrong to
 367        regard these as a single number for arithmetic purposes).  These fields
 368        are not meaningful for any other type. */
 369     exponent_t exponent2 : 11;
 370     unsigned int sign2: 1;
 371   };
 372 } /* namespace llvm */
 373
 374 #endif /* LLVM_FLOAT_H */