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 was developed by Neil Booth and is distributed under the
   6 // University of Illinois Open Source 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 #include "llvm/CodeGen/ValueTypes.h"
 106
 107 namespace llvm {
 108
 109   /* Exponents are stored as signed numbers.  */
 110   typedef signed short exponent_t;
 111
 112   struct fltSemantics;
 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 IEEEsingle;
 129     static const fltSemantics IEEEdouble;
 130     static const fltSemantics IEEEquad;
 131     static const fltSemantics PPCDoubleDouble;
 132     static const fltSemantics x87DoubleExtended;
 133     /* And this psuedo, used to construct APFloats that cannot
 134        conflict with anything real. */
 135     static const fltSemantics Bogus;
 136
 137     static unsigned int semanticsPrecision(const fltSemantics &);
 138
 139     /* Floating point numbers have a four-state comparison relation.  */
 140     enum cmpResult {
 141       cmpLessThan,
 142       cmpEqual,
 143       cmpGreaterThan,
 144       cmpUnordered
 145     };
 146
 147     /* IEEE-754R gives five rounding modes.  */
 148     enum roundingMode {
 149       rmNearestTiesToEven,
 150       rmTowardPositive,
 151       rmTowardNegative,
 152       rmTowardZero,
 153       rmNearestTiesToAway
 154     };
 155
 156     /* Operation status.  opUnderflow or opOverflow are always returned
 157        or-ed with opInexact.  */
 158     enum opStatus {
 159       opOK          = 0x00,
 160       opInvalidOp   = 0x01,
 161       opDivByZero   = 0x02,
 162       opOverflow    = 0x04,
 163       opUnderflow   = 0x08,
 164       opInexact     = 0x10
 165     };
 166
 167     /* Category of internally-represented number.  */
 168     enum fltCategory {
 169       fcInfinity,
 170       fcNaN,
 171       fcNormal,
 172       fcZero
 173     };
 174
 175     /* Constructors.  */
 176     APFloat(const fltSemantics &, const char *);
 177     APFloat(const fltSemantics &, integerPart);
 178     APFloat(const fltSemantics &, fltCategory, bool negative);
 179     explicit APFloat(double d);
 180     explicit APFloat(float f);
 181     explicit APFloat(const APInt &, bool isIEEE = false);
 182     APFloat(const APFloat &);
 183     ~APFloat();
 184
 185     /// @brief Used by the Bitcode serializer to emit APInts to Bitcode.
 186     void Emit(Serializer& S) const;
 187
 188     /// @brief Used by the Bitcode deserializer to deserialize APInts.
 189     static APFloat ReadVal(Deserializer& D);
 190
 191     /* Arithmetic.  */
 192     opStatus add(const APFloat &, roundingMode);
 193     opStatus subtract(const APFloat &, roundingMode);
 194     opStatus multiply(const APFloat &, roundingMode);
 195     opStatus divide(const APFloat &, roundingMode);
 196     opStatus mod(const APFloat &, roundingMode);
 197     opStatus fusedMultiplyAdd(const APFloat &, const APFloat &, roundingMode);
 198
 199     /* Sign operations.  */
 200     void changeSign();
 201     void clearSign();
 202     void copySign(const APFloat &);
 203
 204     /* Conversions.  */
 205     opStatus convert(const fltSemantics &, roundingMode);
 206     opStatus convertToInteger(integerPart *, unsigned int, bool,
 207                               roundingMode) const;
 208     opStatus convertFromSignExtendedInteger(const integerPart *, unsigned int,
 209                                             bool, roundingMode);
 210     opStatus convertFromZeroExtendedInteger(const integerPart *, unsigned int,
 211                                             bool, roundingMode);
 212     opStatus convertFromString(const char *, roundingMode);
 213     APInt convertToAPInt() const;
 214     double convertToDouble() const;
 215     float convertToFloat() const;
 216
 217     /* The definition of equality is not straightforward for floating point,
 218        so we won't use operator==.  Use one of the following, or write
 219        whatever it is you really mean. */
 220     // bool operator==(const APFloat &) const;     // DO NOT IMPLEMENT
 221
 222     /* IEEE comparison with another floating point number (NaNs
 223        compare unordered, 0==-0). */
 224     cmpResult compare(const APFloat &) const;
 225
 226     /* Write out a hexadecimal representation of the floating point
 227        value to DST, which must be of sufficient size, in the C99 form
 228        [-]0xh.hhhhp[+-]d.  Return the number of characters written,
 229        excluding the terminating NUL.  */
 230     unsigned int convertToHexString(char *dst, unsigned int hexDigits,
 231                                     bool upperCase, roundingMode) const;
 232
 233     /* Bitwise comparison for equality (QNaNs compare equal, 0!=-0). */
 234     bool bitwiseIsEqual(const APFloat &) const;
 235
 236     /* Simple queries.  */
 237     fltCategory getCategory() const { return category; }
 238     const fltSemantics &getSemantics() const { return *semantics; }
 239     bool isZero() const { return category == fcZero; }
 240     bool isNonZero() const { return category != fcZero; }
 241     bool isNaN() const { return category == fcNaN; }
 242     bool isNegative() const { return sign; }
 243     bool isPosZero() const { return isZero() && !isNegative(); }
 244     bool isNegZero() const { return isZero() && isNegative(); }
 245
 246     APFloat& operator=(const APFloat &);
 247
 248     /* Return an arbitrary integer value usable for hashing. */
 249     uint32_t getHashValue() const;
 250
 251   private:
 252
 253     /* Trivial queries.  */
 254     integerPart *significandParts();
 255     const integerPart *significandParts() const;
 256     unsigned int partCount() const;
 257
 258     /* Significand operations.  */
 259     integerPart addSignificand(const APFloat &);
 260     integerPart subtractSignificand(const APFloat &, integerPart);
 261     lostFraction addOrSubtractSignificand(const APFloat &, bool subtract);
 262     lostFraction multiplySignificand(const APFloat &, const APFloat *);
 263     lostFraction divideSignificand(const APFloat &);
 264     void incrementSignificand();
 265     void initialize(const fltSemantics *);
 266     void shiftSignificandLeft(unsigned int);
 267     lostFraction shiftSignificandRight(unsigned int);
 268     unsigned int significandLSB() const;
 269     unsigned int significandMSB() const;
 270     void zeroSignificand();
 271
 272     /* Arithmetic on special values.  */
 273     opStatus addOrSubtractSpecials(const APFloat &, bool subtract);
 274     opStatus divideSpecials(const APFloat &);
 275     opStatus multiplySpecials(const APFloat &);
 276
 277     /* Miscellany.  */
 278     void makeNaN(void);
 279     opStatus normalize(roundingMode, lostFraction);
 280     opStatus addOrSubtract(const APFloat &, roundingMode, bool subtract);
 281     cmpResult compareAbsoluteValue(const APFloat &) const;
 282     opStatus handleOverflow(roundingMode);
 283     bool roundAwayFromZero(roundingMode, lostFraction, unsigned int) const;
 284     opStatus convertToSignExtendedInteger(integerPart *, unsigned int, bool,
 285                                           roundingMode) const;
 286     opStatus convertFromUnsignedParts(const integerPart *, unsigned int,
 287                                       roundingMode);
 288     opStatus convertFromHexadecimalString(const char *, roundingMode);
 289     opStatus convertFromDecimalString (const char *, roundingMode);
 290     char *convertNormalToHexString(char *, unsigned int, bool,
 291                                    roundingMode) const;
 292     opStatus roundSignificandWithExponent(const integerPart *, unsigned int,
 293                                           int, roundingMode);
 294
 295     APInt convertFloatAPFloatToAPInt() const;
 296     APInt convertDoubleAPFloatToAPInt() const;
 297     APInt convertF80LongDoubleAPFloatToAPInt() const;
 298     APInt convertPPCDoubleDoubleAPFloatToAPInt() const;
 299     void initFromAPInt(const APInt& api, bool isIEEE = false);
 300     void initFromFloatAPInt(const APInt& api);
 301     void initFromDoubleAPInt(const APInt& api);
 302     void initFromF80LongDoubleAPInt(const APInt& api);
 303     void initFromPPCDoubleDoubleAPInt(const APInt& api);
 304
 305     void assign(const APFloat &);
 306     void copySignificand(const APFloat &);
 307     void freeSignificand();
 308
 309     /* What kind of semantics does this value obey?  */
 310     const fltSemantics *semantics;
 311
 312     /* Significand - the fraction with an explicit integer bit.  Must be
 313        at least one bit wider than the target precision.  */
 314     union Significand
 315     {
 316       integerPart part;
 317       integerPart *parts;
 318     } significand;
 319
 320     /* The exponent - a signed number.  */
 321     exponent_t exponent;
 322
 323     /* What kind of floating point number this is.  */
 324     /* Only 2 bits are required, but VisualStudio incorrectly sign extends
 325        it.  Using the extra bit keeps it from failing under VisualStudio */
 326     fltCategory category: 3;
 327
 328     /* The sign bit of this number.  */
 329     unsigned int sign: 1;
 330
 331     /* For PPCDoubleDouble, we have a second exponent and sign (the second
 332        significand is appended to the first one, although it would be wrong to
 333        regard these as a single number for arithmetic purposes).  These fields
 334        are not meaningful for any other type. */
 335     exponent_t exponent2 : 11;
 336     unsigned int sign2: 1;
 337   };
 338 } /* namespace llvm */
 339
 340 #endif /* LLVM_FLOAT_H */