include/llvm/ADT/APInt.h

   1 //===-- llvm/ADT/APInt.h - For Arbitrary Precision Integer -----*- 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 implements a class to represent arbitrary precision integral
  11 // constant values and operations on them.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_APINT_H
  16 #define LLVM_APINT_H
  17
  18 #include "llvm/Support/DataTypes.h"
  19 #include "llvm/Support/MathExtras.h"
  20 #include <cassert>
  21 #include <cstring>
  22 #include <iosfwd>
  23 #include <string>
  24
  25 namespace llvm {
  26   class Serializer;
  27   class Deserializer;
  28   class FoldingSetNodeID;
  29
  30   template<typename T>
  31   class SmallVectorImpl;
  32
  33   /* An unsigned host type used as a single part of a multi-part
  34      bignum.  */
  35   typedef uint64_t integerPart;
  36
  37   const unsigned int host_char_bit = 8;
  38   const unsigned int integerPartWidth = host_char_bit *
  39     static_cast<unsigned int>(sizeof(integerPart));
  40
  41 //===----------------------------------------------------------------------===//
  42 //                              APInt Class
  43 //===----------------------------------------------------------------------===//
  44
  45 /// APInt - This class represents arbitrary precision constant integral values.
  46 /// It is a functional replacement for common case unsigned integer type like
  47 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
  48 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
  49 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
  50 /// and methods to manipulate integer values of any bit-width. It supports both
  51 /// the typical integer arithmetic and comparison operations as well as bitwise
  52 /// manipulation.
  53 ///
  54 /// The class has several invariants worth noting:
  55 ///   * All bit, byte, and word positions are zero-based.
  56 ///   * Once the bit width is set, it doesn't change except by the Truncate,
  57 ///     SignExtend, or ZeroExtend operations.
  58 ///   * All binary operators must be on APInt instances of the same bit width.
  59 ///     Attempting to use these operators on instances with different bit
  60 ///     widths will yield an assertion.
  61 ///   * The value is stored canonically as an unsigned value. For operations
  62 ///     where it makes a difference, there are both signed and unsigned variants
  63 ///     of the operation. For example, sdiv and udiv. However, because the bit
  64 ///     widths must be the same, operations such as Mul and Add produce the same
  65 ///     results regardless of whether the values are interpreted as signed or
  66 ///     not.
  67 ///   * In general, the class tries to follow the style of computation that LLVM
  68 ///     uses in its IR. This simplifies its use for LLVM.
  69 ///
  70 /// @brief Class for arbitrary precision integers.
  71 class APInt {
  72   uint32_t BitWidth;      ///< The number of bits in this APInt.
  73
  74   /// This union is used to store the integer value. When the
  75   /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
  76   union {
  77     uint64_t VAL;    ///< Used to store the <= 64 bits integer value.
  78     uint64_t *pVal;  ///< Used to store the >64 bits integer value.
  79   };
  80
  81   /// This enum is used to hold the constants we needed for APInt.
  82   enum {
  83     /// Bits in a word
  84     APINT_BITS_PER_WORD = static_cast<unsigned int>(sizeof(uint64_t)) * 8,
  85     /// Byte size of a word
  86     APINT_WORD_SIZE = static_cast<unsigned int>(sizeof(uint64_t))
  87   };
  88
  89   /// This constructor is used only internally for speed of construction of
  90   /// temporaries. It is unsafe for general use so it is not public.
  91   /// @brief Fast internal constructor
  92   APInt(uint64_t* val, uint32_t bits) : BitWidth(bits), pVal(val) { }
  93
  94   /// @returns true if the number of bits <= 64, false otherwise.
  95   /// @brief Determine if this APInt just has one word to store value.
  96   bool isSingleWord() const {
  97     return BitWidth <= APINT_BITS_PER_WORD;
  98   }
  99
 100   /// @returns the word position for the specified bit position.
 101   /// @brief Determine which word a bit is in.
 102   static uint32_t whichWord(uint32_t bitPosition) {
 103     return bitPosition / APINT_BITS_PER_WORD;
 104   }
 105
 106   /// @returns the bit position in a word for the specified bit position
 107   /// in the APInt.
 108   /// @brief Determine which bit in a word a bit is in.
 109   static uint32_t whichBit(uint32_t bitPosition) {
 110     return bitPosition % APINT_BITS_PER_WORD;
 111   }
 112
 113   /// This method generates and returns a uint64_t (word) mask for a single
 114   /// bit at a specific bit position. This is used to mask the bit in the
 115   /// corresponding word.
 116   /// @returns a uint64_t with only bit at "whichBit(bitPosition)" set
 117   /// @brief Get a single bit mask.
 118   static uint64_t maskBit(uint32_t bitPosition) {
 119     return 1ULL << whichBit(bitPosition);
 120   }
 121
 122   /// This method is used internally to clear the to "N" bits in the high order
 123   /// word that are not used by the APInt. This is needed after the most
 124   /// significant word is assigned a value to ensure that those bits are
 125   /// zero'd out.
 126   /// @brief Clear unused high order bits
 127   APInt& clearUnusedBits() {
 128     // Compute how many bits are used in the final word
 129     uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
 130     if (wordBits == 0)
 131       // If all bits are used, we want to leave the value alone. This also
 132       // avoids the undefined behavior of >> when the shift is the same size as
 133       // the word size (64).
 134       return *this;
 135
 136     // Mask out the high bits.
 137     uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
 138     if (isSingleWord())
 139       VAL &= mask;
 140     else
 141       pVal[getNumWords() - 1] &= mask;
 142     return *this;
 143   }
 144
 145   /// @returns the corresponding word for the specified bit position.
 146   /// @brief Get the word corresponding to a bit position
 147   uint64_t getWord(uint32_t bitPosition) const {
 148     return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
 149   }
 150
 151   /// This is used by the constructors that take string arguments.
 152   /// @brief Convert a char array into an APInt
 153   void fromString(uint32_t numBits, const char *strStart, uint32_t slen,
 154                   uint8_t radix);
 155
 156   /// This is used by the toString method to divide by the radix. It simply
 157   /// provides a more convenient form of divide for internal use since KnuthDiv
 158   /// has specific constraints on its inputs. If those constraints are not met
 159   /// then it provides a simpler form of divide.
 160   /// @brief An internal division function for dividing APInts.
 161   static void divide(const APInt LHS, uint32_t lhsWords,
 162                      const APInt &RHS, uint32_t rhsWords,
 163                      APInt *Quotient, APInt *Remainder);
 164
 165   /// out-of-line slow case for inline constructor
 166   void initSlowCase(uint32_t numBits, uint64_t val, bool isSigned);
 167
 168   /// out-of-line slow case for inline copy constructor
 169   void initSlowCase(const APInt& that);
 170
 171   /// out-of-line slow case for shl
 172   APInt shlSlowCase(uint32_t shiftAmt) const;
 173
 174   /// out-of-line slow case for operator&
 175   APInt AndSlowCase(const APInt& RHS) const;
 176
 177   /// out-of-line slow case for operator|
 178   APInt OrSlowCase(const APInt& RHS) const;
 179
 180   /// out-of-line slow case for operator^
 181   APInt XorSlowCase(const APInt& RHS) const;
 182
 183   /// out-of-line slow case for operator=
 184   APInt& AssignSlowCase(const APInt& RHS);
 185
 186   /// out-of-line slow case for operator==
 187   bool EqualSlowCase(const APInt& RHS) const;
 188
 189   /// out-of-line slow case for operator==
 190   bool EqualSlowCase(uint64_t Val) const;
 191
 192   /// out-of-line slow case for countLeadingZeros
 193   uint32_t countLeadingZerosSlowCase() const;
 194
 195   /// out-of-line slow case for countTrailingOnes
 196   uint32_t countTrailingOnesSlowCase() const;
 197
 198   /// out-of-line slow case for countPopulation
 199   uint32_t countPopulationSlowCase() const;
 200
 201 public:
 202   /// @name Constructors
 203   /// @{
 204   /// If isSigned is true then val is treated as if it were a signed value
 205   /// (i.e. as an int64_t) and the appropriate sign extension to the bit width
 206   /// will be done. Otherwise, no sign extension occurs (high order bits beyond
 207   /// the range of val are zero filled).
 208   /// @param numBits the bit width of the constructed APInt
 209   /// @param val the initial value of the APInt
 210   /// @param isSigned how to treat signedness of val
 211   /// @brief Create a new APInt of numBits width, initialized as val.
 212   APInt(uint32_t numBits, uint64_t val, bool isSigned = false)
 213     : BitWidth(numBits), VAL(0) {
 214     assert(BitWidth && "bitwidth too small");
 215     if (isSingleWord())
 216       VAL = val;
 217     else
 218       initSlowCase(numBits, val, isSigned);
 219     clearUnusedBits();
 220   }
 221
 222   /// Note that numWords can be smaller or larger than the corresponding bit
 223   /// width but any extraneous bits will be dropped.
 224   /// @param numBits the bit width of the constructed APInt
 225   /// @param numWords the number of words in bigVal
 226   /// @param bigVal a sequence of words to form the initial value of the APInt
 227   /// @brief Construct an APInt of numBits width, initialized as bigVal[].
 228   APInt(uint32_t numBits, uint32_t numWords, const uint64_t bigVal[]);
 229
 230   /// This constructor interprets the slen characters starting at StrStart as
 231   /// a string in the given radix. The interpretation stops when the first
 232   /// character that is not suitable for the radix is encountered. Acceptable
 233   /// radix values are 2, 8, 10 and 16. It is an error for the value implied by
 234   /// the string to require more bits than numBits.
 235   /// @param numBits the bit width of the constructed APInt
 236   /// @param strStart the start of the string to be interpreted
 237   /// @param slen the maximum number of characters to interpret
 238   /// @param radix the radix to use for the conversion
 239   /// @brief Construct an APInt from a string representation.
 240   APInt(uint32_t numBits, const char strStart[], uint32_t slen, uint8_t radix);
 241
 242   /// Simply makes *this a copy of that.
 243   /// @brief Copy Constructor.
 244   APInt(const APInt& that)
 245     : BitWidth(that.BitWidth), VAL(0) {
 246     assert(BitWidth && "bitwidth too small");
 247     if (isSingleWord())
 248       VAL = that.VAL;
 249     else
 250       initSlowCase(that);
 251   }
 252
 253   /// @brief Destructor.
 254   ~APInt() {
 255     if (!isSingleWord())
 256       delete [] pVal;
 257   }
 258
 259   /// Default constructor that creates an uninitialized APInt.  This is useful
 260   ///  for object deserialization (pair this with the static method Read).
 261   explicit APInt() : BitWidth(1) {}
 262
 263   /// Profile - Used to insert APInt objects, or objects that contain APInt
 264   ///  objects, into FoldingSets.
 265   void Profile(FoldingSetNodeID& id) const;
 266
 267   /// @brief Used by the Bitcode serializer to emit APInts to Bitcode.
 268   void Emit(Serializer& S) const;
 269
 270   /// @brief Used by the Bitcode deserializer to deserialize APInts.
 271   void Read(Deserializer& D);
 272
 273   /// @}
 274   /// @name Value Tests
 275   /// @{
 276   /// This tests the high bit of this APInt to determine if it is set.
 277   /// @returns true if this APInt is negative, false otherwise
 278   /// @brief Determine sign of this APInt.
 279   bool isNegative() const {
 280     return (*this)[BitWidth - 1];
 281   }
 282
 283   /// This tests the high bit of the APInt to determine if it is unset.
 284   /// @brief Determine if this APInt Value is non-negative (>= 0)
 285   bool isNonNegative() const {
 286     return !isNegative();
 287   }
 288
 289   /// This tests if the value of this APInt is positive (> 0). Note
 290   /// that 0 is not a positive value.
 291   /// @returns true if this APInt is positive.
 292   /// @brief Determine if this APInt Value is positive.
 293   bool isStrictlyPositive() const {
 294     return isNonNegative() && (*this) != 0;
 295   }
 296
 297   /// This checks to see if the value has all bits of the APInt are set or not.
 298   /// @brief Determine if all bits are set
 299   bool isAllOnesValue() const {
 300     return countPopulation() == BitWidth;
 301   }
 302
 303   /// This checks to see if the value of this APInt is the maximum unsigned
 304   /// value for the APInt's bit width.
 305   /// @brief Determine if this is the largest unsigned value.
 306   bool isMaxValue() const {
 307     return countPopulation() == BitWidth;
 308   }
 309
 310   /// This checks to see if the value of this APInt is the maximum signed
 311   /// value for the APInt's bit width.
 312   /// @brief Determine if this is the largest signed value.
 313   bool isMaxSignedValue() const {
 314     return BitWidth == 1 ? VAL == 0 :
 315                           !isNegative() && countPopulation() == BitWidth - 1;
 316   }
 317
 318   /// This checks to see if the value of this APInt is the minimum unsigned
 319   /// value for the APInt's bit width.
 320   /// @brief Determine if this is the smallest unsigned value.
 321   bool isMinValue() const {
 322     return countPopulation() == 0;
 323   }
 324
 325   /// This checks to see if the value of this APInt is the minimum signed
 326   /// value for the APInt's bit width.
 327   /// @brief Determine if this is the smallest signed value.
 328   bool isMinSignedValue() const {
 329     return BitWidth == 1 ? VAL == 1 :
 330                            isNegative() && countPopulation() == 1;
 331   }
 332
 333   /// @brief Check if this APInt has an N-bits unsigned integer value.
 334   bool isIntN(uint32_t N) const {
 335     assert(N && "N == 0 ???");
 336     if (isSingleWord()) {
 337       return VAL == (VAL & (~0ULL >> (64 - N)));
 338     } else {
 339       APInt Tmp(N, getNumWords(), pVal);
 340       return Tmp == (*this);
 341     }
 342   }
 343
 344   /// @brief Check if this APInt has an N-bits signed integer value.
 345   bool isSignedIntN(uint32_t N) const {
 346     assert(N && "N == 0 ???");
 347     return getMinSignedBits() <= N;
 348   }
 349
 350   /// @returns true if the argument APInt value is a power of two > 0.
 351   bool isPowerOf2() const;
 352
 353   /// isSignBit - Return true if this is the value returned by getSignBit.
 354   bool isSignBit() const { return isMinSignedValue(); }
 355
 356   /// This converts the APInt to a boolean value as a test against zero.
 357   /// @brief Boolean conversion function.
 358   bool getBoolValue() const {
 359     return *this != 0;
 360   }
 361
 362   /// getLimitedValue - If this value is smaller than the specified limit,
 363   /// return it, otherwise return the limit value.  This causes the value
 364   /// to saturate to the limit.
 365   uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
 366     return (getActiveBits() > 64 || getZExtValue() > Limit) ?
 367       Limit :  getZExtValue();
 368   }
 369
 370   /// @}
 371   /// @name Value Generators
 372   /// @{
 373   /// @brief Gets maximum unsigned value of APInt for specific bit width.
 374   static APInt getMaxValue(uint32_t numBits) {
 375     return APInt(numBits, 0).set();
 376   }
 377
 378   /// @brief Gets maximum signed value of APInt for a specific bit width.
 379   static APInt getSignedMaxValue(uint32_t numBits) {
 380     return APInt(numBits, 0).set().clear(numBits - 1);
 381   }
 382
 383   /// @brief Gets minimum unsigned value of APInt for a specific bit width.
 384   static APInt getMinValue(uint32_t numBits) {
 385     return APInt(numBits, 0);
 386   }
 387
 388   /// @brief Gets minimum signed value of APInt for a specific bit width.
 389   static APInt getSignedMinValue(uint32_t numBits) {
 390     return APInt(numBits, 0).set(numBits - 1);
 391   }
 392
 393   /// getSignBit - This is just a wrapper function of getSignedMinValue(), and
 394   /// it helps code readability when we want to get a SignBit.
 395   /// @brief Get the SignBit for a specific bit width.
 396   static APInt getSignBit(uint32_t BitWidth) {
 397     return getSignedMinValue(BitWidth);
 398   }
 399
 400   /// @returns the all-ones value for an APInt of the specified bit-width.
 401   /// @brief Get the all-ones value.
 402   static APInt getAllOnesValue(uint32_t numBits) {
 403     return APInt(numBits, 0).set();
 404   }
 405
 406   /// @returns the '0' value for an APInt of the specified bit-width.
 407   /// @brief Get the '0' value.
 408   static APInt getNullValue(uint32_t numBits) {
 409     return APInt(numBits, 0);
 410   }
 411
 412   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 413   /// the low bits and right shift to the least significant bit.
 414   /// @returns the high "numBits" bits of this APInt.
 415   APInt getHiBits(uint32_t numBits) const;
 416
 417   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 418   /// the high bits.
 419   /// @returns the low "numBits" bits of this APInt.
 420   APInt getLoBits(uint32_t numBits) const;
 421
 422   /// Constructs an APInt value that has a contiguous range of bits set. The
 423   /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
 424   /// bits will be zero. For example, with parameters(32, 0, 16) you would get
 425   /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
 426   /// example, with parameters (32, 28, 4), you would get 0xF000000F.
 427   /// @param numBits the intended bit width of the result
 428   /// @param loBit the index of the lowest bit set.
 429   /// @param hiBit the index of the highest bit set.
 430   /// @returns An APInt value with the requested bits set.
 431   /// @brief Get a value with a block of bits set.
 432   static APInt getBitsSet(uint32_t numBits, uint32_t loBit, uint32_t hiBit) {
 433     assert(hiBit <= numBits && "hiBit out of range");
 434     assert(loBit < numBits && "loBit out of range");
 435     if (hiBit < loBit)
 436       return getLowBitsSet(numBits, hiBit) |
 437              getHighBitsSet(numBits, numBits-loBit);
 438     return getLowBitsSet(numBits, hiBit-loBit).shl(loBit);
 439   }
 440
 441   /// Constructs an APInt value that has the top hiBitsSet bits set.
 442   /// @param numBits the bitwidth of the result
 443   /// @param hiBitsSet the number of high-order bits set in the result.
 444   /// @brief Get a value with high bits set
 445   static APInt getHighBitsSet(uint32_t numBits, uint32_t hiBitsSet) {
 446     assert(hiBitsSet <= numBits && "Too many bits to set!");
 447     // Handle a degenerate case, to avoid shifting by word size
 448     if (hiBitsSet == 0)
 449       return APInt(numBits, 0);
 450     uint32_t shiftAmt = numBits - hiBitsSet;
 451     // For small values, return quickly
 452     if (numBits <= APINT_BITS_PER_WORD)
 453       return APInt(numBits, ~0ULL << shiftAmt);
 454     return (~APInt(numBits, 0)).shl(shiftAmt);
 455   }
 456
 457   /// Constructs an APInt value that has the bottom loBitsSet bits set.
 458   /// @param numBits the bitwidth of the result
 459   /// @param loBitsSet the number of low-order bits set in the result.
 460   /// @brief Get a value with low bits set
 461   // XXX why isn't this inlining?
 462   static APInt getLowBitsSet(uint32_t numBits, uint32_t loBitsSet) {
 463     assert(loBitsSet <= numBits && "Too many bits to set!");
 464     // Handle a degenerate case, to avoid shifting by word size
 465     if (loBitsSet == 0)
 466       return APInt(numBits, 0);
 467     if (loBitsSet == APINT_BITS_PER_WORD)
 468       return APInt(numBits, -1ULL);
 469     // For small values, return quickly
 470     if (numBits < APINT_BITS_PER_WORD)
 471       return APInt(numBits, (1ULL << loBitsSet) - 1);
 472     return (~APInt(numBits, 0)).lshr(numBits - loBitsSet);
 473   }
 474
 475   /// The hash value is computed as the sum of the words and the bit width.
 476   /// @returns A hash value computed from the sum of the APInt words.
 477   /// @brief Get a hash value based on this APInt
 478   uint64_t getHashValue() const;
 479
 480   /// This function returns a pointer to the internal storage of the APInt.
 481   /// This is useful for writing out the APInt in binary form without any
 482   /// conversions.
 483   const uint64_t* getRawData() const {
 484     if (isSingleWord())
 485       return &VAL;
 486     return &pVal[0];
 487   }
 488
 489   /// @}
 490   /// @name Unary Operators
 491   /// @{
 492   /// @returns a new APInt value representing *this incremented by one
 493   /// @brief Postfix increment operator.
 494   const APInt operator++(int) {
 495     APInt API(*this);
 496     ++(*this);
 497     return API;
 498   }
 499
 500   /// @returns *this incremented by one
 501   /// @brief Prefix increment operator.
 502   APInt& operator++();
 503
 504   /// @returns a new APInt representing *this decremented by one.
 505   /// @brief Postfix decrement operator.
 506   const APInt operator--(int) {
 507     APInt API(*this);
 508     --(*this);
 509     return API;
 510   }
 511
 512   /// @returns *this decremented by one.
 513   /// @brief Prefix decrement operator.
 514   APInt& operator--();
 515
 516   /// Performs a bitwise complement operation on this APInt.
 517   /// @returns an APInt that is the bitwise complement of *this
 518   /// @brief Unary bitwise complement operator.
 519   APInt operator~() const {
 520     APInt Result(*this);
 521     Result.flip();
 522     return Result;
 523   }
 524
 525   /// Negates *this using two's complement logic.
 526   /// @returns An APInt value representing the negation of *this.
 527   /// @brief Unary negation operator
 528   APInt operator-() const {
 529     return APInt(BitWidth, 0) - (*this);
 530   }
 531
 532   /// Performs logical negation operation on this APInt.
 533   /// @returns true if *this is zero, false otherwise.
 534   /// @brief Logical negation operator.
 535   bool operator!() const;
 536
 537   /// @}
 538   /// @name Assignment Operators
 539   /// @{
 540   /// @returns *this after assignment of RHS.
 541   /// @brief Copy assignment operator.
 542   APInt& operator=(const APInt& RHS) {
 543     // If the bitwidths are the same, we can avoid mucking with memory
 544     if (isSingleWord() && RHS.isSingleWord()) {
 545       VAL = RHS.VAL;
 546       BitWidth = RHS.BitWidth;
 547       return clearUnusedBits();
 548     }
 549
 550     return AssignSlowCase(RHS);
 551   }
 552
 553   /// The RHS value is assigned to *this. If the significant bits in RHS exceed
 554   /// the bit width, the excess bits are truncated. If the bit width is larger
 555   /// than 64, the value is zero filled in the unspecified high order bits.
 556   /// @returns *this after assignment of RHS value.
 557   /// @brief Assignment operator.
 558   APInt& operator=(uint64_t RHS);
 559
 560   /// Performs a bitwise AND operation on this APInt and RHS. The result is
 561   /// assigned to *this.
 562   /// @returns *this after ANDing with RHS.
 563   /// @brief Bitwise AND assignment operator.
 564   APInt& operator&=(const APInt& RHS);
 565
 566   /// Performs a bitwise OR operation on this APInt and RHS. The result is
 567   /// assigned *this;
 568   /// @returns *this after ORing with RHS.
 569   /// @brief Bitwise OR assignment operator.
 570   APInt& operator|=(const APInt& RHS);
 571
 572   /// Performs a bitwise XOR operation on this APInt and RHS. The result is
 573   /// assigned to *this.
 574   /// @returns *this after XORing with RHS.
 575   /// @brief Bitwise XOR assignment operator.
 576   APInt& operator^=(const APInt& RHS);
 577
 578   /// Multiplies this APInt by RHS and assigns the result to *this.
 579   /// @returns *this
 580   /// @brief Multiplication assignment operator.
 581   APInt& operator*=(const APInt& RHS);
 582
 583   /// Adds RHS to *this and assigns the result to *this.
 584   /// @returns *this
 585   /// @brief Addition assignment operator.
 586   APInt& operator+=(const APInt& RHS);
 587
 588   /// Subtracts RHS from *this and assigns the result to *this.
 589   /// @returns *this
 590   /// @brief Subtraction assignment operator.
 591   APInt& operator-=(const APInt& RHS);
 592
 593   /// Shifts *this left by shiftAmt and assigns the result to *this.
 594   /// @returns *this after shifting left by shiftAmt
 595   /// @brief Left-shift assignment function.
 596   APInt& operator<<=(uint32_t shiftAmt) {
 597     *this = shl(shiftAmt);
 598     return *this;
 599   }
 600
 601   /// @}
 602   /// @name Binary Operators
 603   /// @{
 604   /// Performs a bitwise AND operation on *this and RHS.
 605   /// @returns An APInt value representing the bitwise AND of *this and RHS.
 606   /// @brief Bitwise AND operator.
 607   APInt operator&(const APInt& RHS) const {
 608     assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 609     if (isSingleWord())
 610       return APInt(getBitWidth(), VAL & RHS.VAL);
 611     return AndSlowCase(RHS);
 612   }
 613   APInt And(const APInt& RHS) const {
 614     return this->operator&(RHS);
 615   }
 616
 617   /// Performs a bitwise OR operation on *this and RHS.
 618   /// @returns An APInt value representing the bitwise OR of *this and RHS.
 619   /// @brief Bitwise OR operator.
 620   APInt operator|(const APInt& RHS) const {
 621     assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 622     if (isSingleWord())
 623       return APInt(getBitWidth(), VAL | RHS.VAL);
 624     return OrSlowCase(RHS);
 625   }
 626   APInt Or(const APInt& RHS) const {
 627     return this->operator|(RHS);
 628   }
 629
 630   /// Performs a bitwise XOR operation on *this and RHS.
 631   /// @returns An APInt value representing the bitwise XOR of *this and RHS.
 632   /// @brief Bitwise XOR operator.
 633   APInt operator^(const APInt& RHS) const {
 634     assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 635     if (isSingleWord())
 636       return APInt(BitWidth, VAL ^ RHS.VAL);
 637     return XorSlowCase(RHS);
 638   }
 639   APInt Xor(const APInt& RHS) const {
 640     return this->operator^(RHS);
 641   }
 642
 643   /// Multiplies this APInt by RHS and returns the result.
 644   /// @brief Multiplication operator.
 645   APInt operator*(const APInt& RHS) const;
 646
 647   /// Adds RHS to this APInt and returns the result.
 648   /// @brief Addition operator.
 649   APInt operator+(const APInt& RHS) const;
 650   APInt operator+(uint64_t RHS) const {
 651     return (*this) + APInt(BitWidth, RHS);
 652   }
 653
 654   /// Subtracts RHS from this APInt and returns the result.
 655   /// @brief Subtraction operator.
 656   APInt operator-(const APInt& RHS) const;
 657   APInt operator-(uint64_t RHS) const {
 658     return (*this) - APInt(BitWidth, RHS);
 659   }
 660
 661   APInt operator<<(unsigned Bits) const {
 662     return shl(Bits);
 663   }
 664
 665   APInt operator<<(const APInt &Bits) const {
 666     return shl(Bits);
 667   }
 668
 669   /// Arithmetic right-shift this APInt by shiftAmt.
 670   /// @brief Arithmetic right-shift function.
 671   APInt ashr(uint32_t shiftAmt) const;
 672
 673   /// Logical right-shift this APInt by shiftAmt.
 674   /// @brief Logical right-shift function.
 675   APInt lshr(uint32_t shiftAmt) const;
 676
 677   /// Left-shift this APInt by shiftAmt.
 678   /// @brief Left-shift function.
 679   APInt shl(uint32_t shiftAmt) const {
 680     assert(shiftAmt <= BitWidth && "Invalid shift amount");
 681     if (isSingleWord()) {
 682       if (shiftAmt == BitWidth)
 683         return APInt(BitWidth, 0); // avoid undefined shift results
 684       return APInt(BitWidth, VAL << shiftAmt);
 685     }
 686     return shlSlowCase(shiftAmt);
 687   }
 688
 689   /// @brief Rotate left by rotateAmt.
 690   APInt rotl(uint32_t rotateAmt) const;
 691
 692   /// @brief Rotate right by rotateAmt.
 693   APInt rotr(uint32_t rotateAmt) const;
 694
 695   /// Arithmetic right-shift this APInt by shiftAmt.
 696   /// @brief Arithmetic right-shift function.
 697   APInt ashr(const APInt &shiftAmt) const;
 698
 699   /// Logical right-shift this APInt by shiftAmt.
 700   /// @brief Logical right-shift function.
 701   APInt lshr(const APInt &shiftAmt) const;
 702
 703   /// Left-shift this APInt by shiftAmt.
 704   /// @brief Left-shift function.
 705   APInt shl(const APInt &shiftAmt) const;
 706
 707   /// @brief Rotate left by rotateAmt.
 708   APInt rotl(const APInt &rotateAmt) const;
 709
 710   /// @brief Rotate right by rotateAmt.
 711   APInt rotr(const APInt &rotateAmt) const;
 712
 713   /// Perform an unsigned divide operation on this APInt by RHS. Both this and
 714   /// RHS are treated as unsigned quantities for purposes of this division.
 715   /// @returns a new APInt value containing the division result
 716   /// @brief Unsigned division operation.
 717   APInt udiv(const APInt& RHS) const;
 718
 719   /// Signed divide this APInt by APInt RHS.
 720   /// @brief Signed division function for APInt.
 721   APInt sdiv(const APInt& RHS) const {
 722     if (isNegative())
 723       if (RHS.isNegative())
 724         return (-(*this)).udiv(-RHS);
 725       else
 726         return -((-(*this)).udiv(RHS));
 727     else if (RHS.isNegative())
 728       return -(this->udiv(-RHS));
 729     return this->udiv(RHS);
 730   }
 731
 732   /// Perform an unsigned remainder operation on this APInt with RHS being the
 733   /// divisor. Both this and RHS are treated as unsigned quantities for purposes
 734   /// of this operation. Note that this is a true remainder operation and not
 735   /// a modulo operation because the sign follows the sign of the dividend
 736   /// which is *this.
 737   /// @returns a new APInt value containing the remainder result
 738   /// @brief Unsigned remainder operation.
 739   APInt urem(const APInt& RHS) const;
 740
 741   /// Signed remainder operation on APInt.
 742   /// @brief Function for signed remainder operation.
 743   APInt srem(const APInt& RHS) const {
 744     if (isNegative())
 745       if (RHS.isNegative())
 746         return -((-(*this)).urem(-RHS));
 747       else
 748         return -((-(*this)).urem(RHS));
 749     else if (RHS.isNegative())
 750       return this->urem(-RHS);
 751     return this->urem(RHS);
 752   }
 753
 754   /// Sometimes it is convenient to divide two APInt values and obtain both the
 755   /// quotient and remainder. This function does both operations in the same
 756   /// computation making it a little more efficient. The pair of input arguments
 757   /// may overlap with the pair of output arguments. It is safe to call
 758   /// udivrem(X, Y, X, Y), for example.
 759   /// @brief Dual division/remainder interface.
 760   static void udivrem(const APInt &LHS, const APInt &RHS,
 761                       APInt &Quotient, APInt &Remainder);
 762
 763   static void sdivrem(const APInt &LHS, const APInt &RHS,
 764                       APInt &Quotient, APInt &Remainder)
 765   {
 766     if (LHS.isNegative()) {
 767       if (RHS.isNegative())
 768         APInt::udivrem(-LHS, -RHS, Quotient, Remainder);
 769       else
 770         APInt::udivrem(-LHS, RHS, Quotient, Remainder);
 771       Quotient = -Quotient;
 772       Remainder = -Remainder;
 773     } else if (RHS.isNegative()) {
 774       APInt::udivrem(LHS, -RHS, Quotient, Remainder);
 775       Quotient = -Quotient;
 776     } else {
 777       APInt::udivrem(LHS, RHS, Quotient, Remainder);
 778     }
 779   }
 780
 781   /// @returns the bit value at bitPosition
 782   /// @brief Array-indexing support.
 783   bool operator[](uint32_t bitPosition) const;
 784
 785   /// @}
 786   /// @name Comparison Operators
 787   /// @{
 788   /// Compares this APInt with RHS for the validity of the equality
 789   /// relationship.
 790   /// @brief Equality operator.
 791   bool operator==(const APInt& RHS) const {
 792     assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
 793     if (isSingleWord())
 794       return VAL == RHS.VAL;
 795     return EqualSlowCase(RHS);
 796   }
 797
 798   /// Compares this APInt with a uint64_t for the validity of the equality
 799   /// relationship.
 800   /// @returns true if *this == Val
 801   /// @brief Equality operator.
 802   bool operator==(uint64_t Val) const {
 803     if (isSingleWord())
 804       return VAL == Val;
 805     return EqualSlowCase(Val);
 806   }
 807
 808   /// Compares this APInt with RHS for the validity of the equality
 809   /// relationship.
 810   /// @returns true if *this == Val
 811   /// @brief Equality comparison.
 812   bool eq(const APInt &RHS) const {
 813     return (*this) == RHS;
 814   }
 815
 816   /// Compares this APInt with RHS for the validity of the inequality
 817   /// relationship.
 818   /// @returns true if *this != Val
 819   /// @brief Inequality operator.
 820   bool operator!=(const APInt& RHS) const {
 821     return !((*this) == RHS);
 822   }
 823
 824   /// Compares this APInt with a uint64_t for the validity of the inequality
 825   /// relationship.
 826   /// @returns true if *this != Val
 827   /// @brief Inequality operator.
 828   bool operator!=(uint64_t Val) const {
 829     return !((*this) == Val);
 830   }
 831
 832   /// Compares this APInt with RHS for the validity of the inequality
 833   /// relationship.
 834   /// @returns true if *this != Val
 835   /// @brief Inequality comparison
 836   bool ne(const APInt &RHS) const {
 837     return !((*this) == RHS);
 838   }
 839
 840   /// Regards both *this and RHS as unsigned quantities and compares them for
 841   /// the validity of the less-than relationship.
 842   /// @returns true if *this < RHS when both are considered unsigned.
 843   /// @brief Unsigned less than comparison
 844   bool ult(const APInt& RHS) const;
 845
 846   /// Regards both *this and RHS as signed quantities and compares them for
 847   /// validity of the less-than relationship.
 848   /// @returns true if *this < RHS when both are considered signed.
 849   /// @brief Signed less than comparison
 850   bool slt(const APInt& RHS) const;
 851
 852   /// Regards both *this and RHS as unsigned quantities and compares them for
 853   /// validity of the less-or-equal relationship.
 854   /// @returns true if *this <= RHS when both are considered unsigned.
 855   /// @brief Unsigned less or equal comparison
 856   bool ule(const APInt& RHS) const {
 857     return ult(RHS) || eq(RHS);
 858   }
 859
 860   /// Regards both *this and RHS as signed quantities and compares them for
 861   /// validity of the less-or-equal relationship.
 862   /// @returns true if *this <= RHS when both are considered signed.
 863   /// @brief Signed less or equal comparison
 864   bool sle(const APInt& RHS) const {
 865     return slt(RHS) || eq(RHS);
 866   }
 867
 868   /// Regards both *this and RHS as unsigned quantities and compares them for
 869   /// the validity of the greater-than relationship.
 870   /// @returns true if *this > RHS when both are considered unsigned.
 871   /// @brief Unsigned greather than comparison
 872   bool ugt(const APInt& RHS) const {
 873     return !ult(RHS) && !eq(RHS);
 874   }
 875
 876   /// Regards both *this and RHS as signed quantities and compares them for
 877   /// the validity of the greater-than relationship.
 878   /// @returns true if *this > RHS when both are considered signed.
 879   /// @brief Signed greather than comparison
 880   bool sgt(const APInt& RHS) const {
 881     return !slt(RHS) && !eq(RHS);
 882   }
 883
 884   /// Regards both *this and RHS as unsigned quantities and compares them for
 885   /// validity of the greater-or-equal relationship.
 886   /// @returns true if *this >= RHS when both are considered unsigned.
 887   /// @brief Unsigned greater or equal comparison
 888   bool uge(const APInt& RHS) const {
 889     return !ult(RHS);
 890   }
 891
 892   /// Regards both *this and RHS as signed quantities and compares them for
 893   /// validity of the greater-or-equal relationship.
 894   /// @returns true if *this >= RHS when both are considered signed.
 895   /// @brief Signed greather or equal comparison
 896   bool sge(const APInt& RHS) const {
 897     return !slt(RHS);
 898   }
 899
 900   /// This operation tests if there are any pairs of corresponding bits
 901   /// between this APInt and RHS that are both set.
 902   bool intersects(const APInt &RHS) const {
 903     return (*this & RHS) != 0;
 904   }
 905
 906   /// @}
 907   /// @name Resizing Operators
 908   /// @{
 909   /// Truncate the APInt to a specified width. It is an error to specify a width
 910   /// that is greater than or equal to the current width.
 911   /// @brief Truncate to new width.
 912   APInt &trunc(uint32_t width);
 913
 914   /// This operation sign extends the APInt to a new width. If the high order
 915   /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
 916   /// It is an error to specify a width that is less than or equal to the
 917   /// current width.
 918   /// @brief Sign extend to a new width.
 919   APInt &sext(uint32_t width);
 920
 921   /// This operation zero extends the APInt to a new width. The high order bits
 922   /// are filled with 0 bits.  It is an error to specify a width that is less
 923   /// than or equal to the current width.
 924   /// @brief Zero extend to a new width.
 925   APInt &zext(uint32_t width);
 926
 927   /// Make this APInt have the bit width given by \p width. The value is sign
 928   /// extended, truncated, or left alone to make it that width.
 929   /// @brief Sign extend or truncate to width
 930   APInt &sextOrTrunc(uint32_t width);
 931
 932   /// Make this APInt have the bit width given by \p width. The value is zero
 933   /// extended, truncated, or left alone to make it that width.
 934   /// @brief Zero extend or truncate to width
 935   APInt &zextOrTrunc(uint32_t width);
 936
 937   /// @}
 938   /// @name Bit Manipulation Operators
 939   /// @{
 940   /// @brief Set every bit to 1.
 941   APInt& set() {
 942     if (isSingleWord()) {
 943       VAL = -1ULL;
 944       return clearUnusedBits();
 945     }
 946
 947     // Set all the bits in all the words.
 948     for (uint32_t i = 0; i < getNumWords(); ++i)
 949       pVal[i] = -1ULL;
 950     // Clear the unused ones
 951     return clearUnusedBits();
 952   }
 953
 954   /// Set the given bit to 1 whose position is given as "bitPosition".
 955   /// @brief Set a given bit to 1.
 956   APInt& set(uint32_t bitPosition);
 957
 958   /// @brief Set every bit to 0.
 959   APInt& clear() {
 960     if (isSingleWord())
 961       VAL = 0;
 962     else
 963       memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
 964     return *this;
 965   }
 966
 967   /// Set the given bit to 0 whose position is given as "bitPosition".
 968   /// @brief Set a given bit to 0.
 969   APInt& clear(uint32_t bitPosition);
 970
 971   /// @brief Toggle every bit to its opposite value.
 972   APInt& flip() {
 973     if (isSingleWord()) {
 974       VAL ^= -1ULL;
 975       return clearUnusedBits();
 976     }
 977     for (uint32_t i = 0; i < getNumWords(); ++i)
 978       pVal[i] ^= -1ULL;
 979     return clearUnusedBits();
 980   }
 981
 982   /// Toggle a given bit to its opposite value whose position is given
 983   /// as "bitPosition".
 984   /// @brief Toggles a given bit to its opposite value.
 985   APInt& flip(uint32_t bitPosition);
 986
 987   /// @}
 988   /// @name Value Characterization Functions
 989   /// @{
 990
 991   /// @returns the total number of bits.
 992   uint32_t getBitWidth() const {
 993     return BitWidth;
 994   }
 995
 996   /// Here one word's bitwidth equals to that of uint64_t.
 997   /// @returns the number of words to hold the integer value of this APInt.
 998   /// @brief Get the number of words.
 999   uint32_t getNumWords() const {
1000     return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1001   }
1002
1003   /// This function returns the number of active bits which is defined as the
1004   /// bit width minus the number of leading zeros. This is used in several
1005   /// computations to see how "wide" the value is.
1006   /// @brief Compute the number of active bits in the value
1007   uint32_t getActiveBits() const {
1008     return BitWidth - countLeadingZeros();
1009   }
1010
1011   /// This function returns the number of active words in the value of this
1012   /// APInt. This is used in conjunction with getActiveData to extract the raw
1013   /// value of the APInt.
1014   uint32_t getActiveWords() const {
1015     return whichWord(getActiveBits()-1) + 1;
1016   }
1017
1018   /// Computes the minimum bit width for this APInt while considering it to be
1019   /// a signed (and probably negative) value. If the value is not negative,
1020   /// this function returns the same value as getActiveBits()+1. Otherwise, it
1021   /// returns the smallest bit width that will retain the negative value. For
1022   /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1023   /// for -1, this function will always return 1.
1024   /// @brief Get the minimum bit size for this signed APInt
1025   uint32_t getMinSignedBits() const {
1026     if (isNegative())
1027       return BitWidth - countLeadingOnes() + 1;
1028     return getActiveBits()+1;
1029   }
1030
1031   /// This method attempts to return the value of this APInt as a zero extended
1032   /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1033   /// uint64_t. Otherwise an assertion will result.
1034   /// @brief Get zero extended value
1035   uint64_t getZExtValue() const {
1036     if (isSingleWord())
1037       return VAL;
1038     assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1039     return pVal[0];
1040   }
1041
1042   /// This method attempts to return the value of this APInt as a sign extended
1043   /// int64_t. The bit width must be <= 64 or the value must fit within an
1044   /// int64_t. Otherwise an assertion will result.
1045   /// @brief Get sign extended value
1046   int64_t getSExtValue() const {
1047     if (isSingleWord())
1048       return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1049                      (APINT_BITS_PER_WORD - BitWidth);
1050     assert(getActiveBits() <= 64 && "Too many bits for int64_t");
1051     return int64_t(pVal[0]);
1052   }
1053
1054   /// This method determines how many bits are required to hold the APInt
1055   /// equivalent of the string given by \p str of length \p slen.
1056   /// @brief Get bits required for string value.
1057   static uint32_t getBitsNeeded(const char* str, uint32_t slen, uint8_t radix);
1058
1059   /// countLeadingZeros - This function is an APInt version of the
1060   /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
1061   /// of zeros from the most significant bit to the first one bit.
1062   /// @returns BitWidth if the value is zero.
1063   /// @returns the number of zeros from the most significant bit to the first
1064   /// one bits.
1065   uint32_t countLeadingZeros() const {
1066     if (isSingleWord()) {
1067       uint32_t unusedBits = APINT_BITS_PER_WORD - BitWidth;
1068       return CountLeadingZeros_64(VAL) - unusedBits;
1069     }
1070     return countLeadingZerosSlowCase();
1071   }
1072
1073   /// countLeadingOnes - This function is an APInt version of the
1074   /// countLeadingOnes_{32,64} functions in MathExtras.h. It counts the number
1075   /// of ones from the most significant bit to the first zero bit.
1076   /// @returns 0 if the high order bit is not set
1077   /// @returns the number of 1 bits from the most significant to the least
1078   /// @brief Count the number of leading one bits.
1079   uint32_t countLeadingOnes() const;
1080
1081   /// countTrailingZeros - This function is an APInt version of the
1082   /// countTrailingZeros_{32,64} functions in MathExtras.h. It counts
1083   /// the number of zeros from the least significant bit to the first set bit.
1084   /// @returns BitWidth if the value is zero.
1085   /// @returns the number of zeros from the least significant bit to the first
1086   /// one bit.
1087   /// @brief Count the number of trailing zero bits.
1088   uint32_t countTrailingZeros() const;
1089
1090   /// countTrailingOnes - This function is an APInt version of the
1091   /// countTrailingOnes_{32,64} functions in MathExtras.h. It counts
1092   /// the number of ones from the least significant bit to the first zero bit.
1093   /// @returns BitWidth if the value is all ones.
1094   /// @returns the number of ones from the least significant bit to the first
1095   /// zero bit.
1096   /// @brief Count the number of trailing one bits.
1097   uint32_t countTrailingOnes() const {
1098     if (isSingleWord())
1099       return CountTrailingOnes_64(VAL);
1100     return countTrailingOnesSlowCase();
1101   }
1102
1103   /// countPopulation - This function is an APInt version of the
1104   /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
1105   /// of 1 bits in the APInt value.
1106   /// @returns 0 if the value is zero.
1107   /// @returns the number of set bits.
1108   /// @brief Count the number of bits set.
1109   uint32_t countPopulation() const {
1110     if (isSingleWord())
1111       return CountPopulation_64(VAL);
1112     return countPopulationSlowCase();
1113   }
1114
1115   /// @}
1116   /// @name Conversion Functions
1117   /// @{
1118
1119   void print(std::ostream &OS, bool isSigned) const;
1120
1121   /// toString - Converts an APInt to a string and append it to Str.  Str is
1122   /// commonly a SmallString.
1123   void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed) const;
1124
1125   /// Considers the APInt to be unsigned and converts it into a string in the
1126   /// radix given. The radix can be 2, 8, 10 or 16.
1127   void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1128     return toString(Str, Radix, false);
1129   }
1130
1131   /// Considers the APInt to be signed and converts it into a string in the
1132   /// radix given. The radix can be 2, 8, 10 or 16.
1133   void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1134     return toString(Str, Radix, true);
1135   }
1136
1137   /// toString - This returns the APInt as a std::string.  Note that this is an
1138   /// inefficient method.  It is better to pass in a SmallVector/SmallString
1139   /// to the methods above to avoid thrashing the heap for the string.
1140   std::string toString(unsigned Radix, bool Signed) const;
1141
1142
1143   /// @returns a byte-swapped representation of this APInt Value.
1144   APInt byteSwap() const;
1145
1146   /// @brief Converts this APInt to a double value.
1147   double roundToDouble(bool isSigned) const;
1148
1149   /// @brief Converts this unsigned APInt to a double value.
1150   double roundToDouble() const {
1151     return roundToDouble(false);
1152   }
1153
1154   /// @brief Converts this signed APInt to a double value.
1155   double signedRoundToDouble() const {
1156     return roundToDouble(true);
1157   }
1158
1159   /// The conversion does not do a translation from integer to double, it just
1160   /// re-interprets the bits as a double. Note that it is valid to do this on
1161   /// any bit width. Exactly 64 bits will be translated.
1162   /// @brief Converts APInt bits to a double
1163   double bitsToDouble() const {
1164     union {
1165       uint64_t I;
1166       double D;
1167     } T;
1168     T.I = (isSingleWord() ? VAL : pVal[0]);
1169     return T.D;
1170   }
1171
1172   /// The conversion does not do a translation from integer to float, it just
1173   /// re-interprets the bits as a float. Note that it is valid to do this on
1174   /// any bit width. Exactly 32 bits will be translated.
1175   /// @brief Converts APInt bits to a double
1176   float bitsToFloat() const {
1177     union {
1178       uint32_t I;
1179       float F;
1180     } T;
1181     T.I = uint32_t((isSingleWord() ? VAL : pVal[0]));
1182     return T.F;
1183   }
1184
1185   /// The conversion does not do a translation from double to integer, it just
1186   /// re-interprets the bits of the double. Note that it is valid to do this on
1187   /// any bit width but bits from V may get truncated.
1188   /// @brief Converts a double to APInt bits.
1189   APInt& doubleToBits(double V) {
1190     union {
1191       uint64_t I;
1192       double D;
1193     } T;
1194     T.D = V;
1195     if (isSingleWord())
1196       VAL = T.I;
1197     else
1198       pVal[0] = T.I;
1199     return clearUnusedBits();
1200   }
1201
1202   /// The conversion does not do a translation from float to integer, it just
1203   /// re-interprets the bits of the float. Note that it is valid to do this on
1204   /// any bit width but bits from V may get truncated.
1205   /// @brief Converts a float to APInt bits.
1206   APInt& floatToBits(float V) {
1207     union {
1208       uint32_t I;
1209       float F;
1210     } T;
1211     T.F = V;
1212     if (isSingleWord())
1213       VAL = T.I;
1214     else
1215       pVal[0] = T.I;
1216     return clearUnusedBits();
1217   }
1218
1219   /// @}
1220   /// @name Mathematics Operations
1221   /// @{
1222
1223   /// @returns the floor log base 2 of this APInt.
1224   uint32_t logBase2() const {
1225     return BitWidth - 1 - countLeadingZeros();
1226   }
1227
1228   /// @returns the log base 2 of this APInt if its an exact power of two, -1
1229   /// otherwise
1230   int32_t exactLogBase2() const {
1231     if (!isPowerOf2())
1232       return -1;
1233     return logBase2();
1234   }
1235
1236   /// @brief Compute the square root
1237   APInt sqrt() const;
1238
1239   /// If *this is < 0 then return -(*this), otherwise *this;
1240   /// @brief Get the absolute value;
1241   APInt abs() const {
1242     if (isNegative())
1243       return -(*this);
1244     return *this;
1245   }
1246
1247   /// @returns the multiplicative inverse for a given modulo.
1248   APInt multiplicativeInverse(const APInt& modulo) const;
1249
1250   /// @}
1251   /// @name Building-block Operations for APInt and APFloat
1252   /// @{
1253
1254   // These building block operations operate on a representation of
1255   // arbitrary precision, two's-complement, bignum integer values.
1256   // They should be sufficient to implement APInt and APFloat bignum
1257   // requirements.  Inputs are generally a pointer to the base of an
1258   // array of integer parts, representing an unsigned bignum, and a
1259   // count of how many parts there are.
1260
1261   /// Sets the least significant part of a bignum to the input value,
1262   /// and zeroes out higher parts.  */
1263   static void tcSet(integerPart *, integerPart, unsigned int);
1264
1265   /// Assign one bignum to another.
1266   static void tcAssign(integerPart *, const integerPart *, unsigned int);
1267
1268   /// Returns true if a bignum is zero, false otherwise.
1269   static bool tcIsZero(const integerPart *, unsigned int);
1270
1271   /// Extract the given bit of a bignum; returns 0 or 1.  Zero-based.
1272   static int tcExtractBit(const integerPart *, unsigned int bit);
1273
1274   /// Copy the bit vector of width srcBITS from SRC, starting at bit
1275   /// srcLSB, to DST, of dstCOUNT parts, such that the bit srcLSB
1276   /// becomes the least significant bit of DST.  All high bits above
1277   /// srcBITS in DST are zero-filled.
1278   static void tcExtract(integerPart *, unsigned int dstCount, const integerPart *,
1279                         unsigned int srcBits, unsigned int srcLSB);
1280
1281   /// Set the given bit of a bignum.  Zero-based.
1282   static void tcSetBit(integerPart *, unsigned int bit);
1283
1284   /// Returns the bit number of the least or most significant set bit
1285   /// of a number.  If the input number has no bits set -1U is
1286   /// returned.
1287   static unsigned int tcLSB(const integerPart *, unsigned int);
1288   static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1289
1290   /// Negate a bignum in-place.
1291   static void tcNegate(integerPart *, unsigned int);
1292
1293   /// DST += RHS + CARRY where CARRY is zero or one.  Returns the
1294   /// carry flag.
1295   static integerPart tcAdd(integerPart *, const integerPart *,
1296                            integerPart carry, unsigned);
1297
1298   /// DST -= RHS + CARRY where CARRY is zero or one.  Returns the
1299   /// carry flag.
1300   static integerPart tcSubtract(integerPart *, const integerPart *,
1301                                 integerPart carry, unsigned);
1302
1303   ///  DST += SRC * MULTIPLIER + PART   if add is true
1304   ///  DST  = SRC * MULTIPLIER + PART   if add is false
1305   ///
1306   ///  Requires 0 <= DSTPARTS <= SRCPARTS + 1.  If DST overlaps SRC
1307   ///  they must start at the same point, i.e. DST == SRC.
1308   ///
1309   ///  If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is
1310   ///  returned.  Otherwise DST is filled with the least significant
1311   ///  DSTPARTS parts of the result, and if all of the omitted higher
1312   ///  parts were zero return zero, otherwise overflow occurred and
1313   ///  return one.
1314   static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1315                             integerPart multiplier, integerPart carry,
1316                             unsigned int srcParts, unsigned int dstParts,
1317                             bool add);
1318
1319   /// DST = LHS * RHS, where DST has the same width as the operands
1320   /// and is filled with the least significant parts of the result.
1321   /// Returns one if overflow occurred, otherwise zero.  DST must be
1322   /// disjoint from both operands.
1323   static int tcMultiply(integerPart *, const integerPart *,
1324                         const integerPart *, unsigned);
1325
1326   /// DST = LHS * RHS, where DST has width the sum of the widths of
1327   /// the operands.  No overflow occurs.  DST must be disjoint from
1328   /// both operands. Returns the number of parts required to hold the
1329   /// result.
1330   static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1331                                      const integerPart *, unsigned, unsigned);
1332
1333   /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1334   /// Otherwise set LHS to LHS / RHS with the fractional part
1335   /// discarded, set REMAINDER to the remainder, return zero.  i.e.
1336   ///
1337   ///  OLD_LHS = RHS * LHS + REMAINDER
1338   ///
1339   ///  SCRATCH is a bignum of the same size as the operands and result
1340   ///  for use by the routine; its contents need not be initialized
1341   ///  and are destroyed.  LHS, REMAINDER and SCRATCH must be
1342   ///  distinct.
1343   static int tcDivide(integerPart *lhs, const integerPart *rhs,
1344                       integerPart *remainder, integerPart *scratch,
1345                       unsigned int parts);
1346
1347   /// Shift a bignum left COUNT bits.  Shifted in bits are zero.
1348   /// There are no restrictions on COUNT.
1349   static void tcShiftLeft(integerPart *, unsigned int parts,
1350                           unsigned int count);
1351
1352   /// Shift a bignum right COUNT bits.  Shifted in bits are zero.
1353   /// There are no restrictions on COUNT.
1354   static void tcShiftRight(integerPart *, unsigned int parts,
1355                            unsigned int count);
1356
1357   /// The obvious AND, OR and XOR and complement operations.
1358   static void tcAnd(integerPart *, const integerPart *, unsigned int);
1359   static void tcOr(integerPart *, const integerPart *, unsigned int);
1360   static void tcXor(integerPart *, const integerPart *, unsigned int);
1361   static void tcComplement(integerPart *, unsigned int);
1362
1363   /// Comparison (unsigned) of two bignums.
1364   static int tcCompare(const integerPart *, const integerPart *,
1365                        unsigned int);
1366
1367   /// Increment a bignum in-place.  Return the carry flag.
1368   static integerPart tcIncrement(integerPart *, unsigned int);
1369
1370   /// Set the least significant BITS and clear the rest.
1371   static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1372                                         unsigned int bits);
1373
1374   /// @brief debug method
1375   void dump() const;
1376
1377   /// @}
1378 };
1379
1380 inline bool operator==(uint64_t V1, const APInt& V2) {
1381   return V2 == V1;
1382 }
1383
1384 inline bool operator!=(uint64_t V1, const APInt& V2) {
1385   return V2 != V1;
1386 }
1387
1388 inline std::ostream &operator<<(std::ostream &OS, const APInt &I) {
1389   I.print(OS, true);
1390   return OS;
1391 }
1392
1393 namespace APIntOps {
1394
1395 /// @brief Determine the smaller of two APInts considered to be signed.
1396 inline APInt smin(const APInt &A, const APInt &B) {
1397   return A.slt(B) ? A : B;
1398 }
1399
1400 /// @brief Determine the larger of two APInts considered to be signed.
1401 inline APInt smax(const APInt &A, const APInt &B) {
1402   return A.sgt(B) ? A : B;
1403 }
1404
1405 /// @brief Determine the smaller of two APInts considered to be signed.
1406 inline APInt umin(const APInt &A, const APInt &B) {
1407   return A.ult(B) ? A : B;
1408 }
1409
1410 /// @brief Determine the larger of two APInts considered to be unsigned.
1411 inline APInt umax(const APInt &A, const APInt &B) {
1412   return A.ugt(B) ? A : B;
1413 }
1414
1415 /// @brief Check if the specified APInt has a N-bits unsigned integer value.
1416 inline bool isIntN(uint32_t N, const APInt& APIVal) {
1417   return APIVal.isIntN(N);
1418 }
1419
1420 /// @brief Check if the specified APInt has a N-bits signed integer value.
1421 inline bool isSignedIntN(uint32_t N, const APInt& APIVal) {
1422   return APIVal.isSignedIntN(N);
1423 }
1424
1425 /// @returns true if the argument APInt value is a sequence of ones
1426 /// starting at the least significant bit with the remainder zero.
1427 inline bool isMask(uint32_t numBits, const APInt& APIVal) {
1428   return numBits <= APIVal.getBitWidth() &&
1429     APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
1430 }
1431
1432 /// @returns true if the argument APInt value contains a sequence of ones
1433 /// with the remainder zero.
1434 inline bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
1435   return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
1436 }
1437
1438 /// @returns a byte-swapped representation of the specified APInt Value.
1439 inline APInt byteSwap(const APInt& APIVal) {
1440   return APIVal.byteSwap();
1441 }
1442
1443 /// @returns the floor log base 2 of the specified APInt value.
1444 inline uint32_t logBase2(const APInt& APIVal) {
1445   return APIVal.logBase2();
1446 }
1447
1448 /// GreatestCommonDivisor - This function returns the greatest common
1449 /// divisor of the two APInt values using Euclid's algorithm.
1450 /// @returns the greatest common divisor of Val1 and Val2
1451 /// @brief Compute GCD of two APInt values.
1452 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
1453
1454 /// Treats the APInt as an unsigned value for conversion purposes.
1455 /// @brief Converts the given APInt to a double value.
1456 inline double RoundAPIntToDouble(const APInt& APIVal) {
1457   return APIVal.roundToDouble();
1458 }
1459
1460 /// Treats the APInt as a signed value for conversion purposes.
1461 /// @brief Converts the given APInt to a double value.
1462 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
1463   return APIVal.signedRoundToDouble();
1464 }
1465
1466 /// @brief Converts the given APInt to a float vlalue.
1467 inline float RoundAPIntToFloat(const APInt& APIVal) {
1468   return float(RoundAPIntToDouble(APIVal));
1469 }
1470
1471 /// Treast the APInt as a signed value for conversion purposes.
1472 /// @brief Converts the given APInt to a float value.
1473 inline float RoundSignedAPIntToFloat(const APInt& APIVal) {
1474   return float(APIVal.signedRoundToDouble());
1475 }
1476
1477 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
1478 /// @brief Converts the given double value into a APInt.
1479 APInt RoundDoubleToAPInt(double Double, uint32_t width);
1480
1481 /// RoundFloatToAPInt - Converts a float value into an APInt value.
1482 /// @brief Converts a float value into a APInt.
1483 inline APInt RoundFloatToAPInt(float Float, uint32_t width) {
1484   return RoundDoubleToAPInt(double(Float), width);
1485 }
1486
1487 /// Arithmetic right-shift the APInt by shiftAmt.
1488 /// @brief Arithmetic right-shift function.
1489 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
1490   return LHS.ashr(shiftAmt);
1491 }
1492
1493 /// Logical right-shift the APInt by shiftAmt.
1494 /// @brief Logical right-shift function.
1495 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
1496   return LHS.lshr(shiftAmt);
1497 }
1498
1499 /// Left-shift the APInt by shiftAmt.
1500 /// @brief Left-shift function.
1501 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
1502   return LHS.shl(shiftAmt);
1503 }
1504
1505 /// Signed divide APInt LHS by APInt RHS.
1506 /// @brief Signed division function for APInt.
1507 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
1508   return LHS.sdiv(RHS);
1509 }
1510
1511 /// Unsigned divide APInt LHS by APInt RHS.
1512 /// @brief Unsigned division function for APInt.
1513 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
1514   return LHS.udiv(RHS);
1515 }
1516
1517 /// Signed remainder operation on APInt.
1518 /// @brief Function for signed remainder operation.
1519 inline APInt srem(const APInt& LHS, const APInt& RHS) {
1520   return LHS.srem(RHS);
1521 }
1522
1523 /// Unsigned remainder operation on APInt.
1524 /// @brief Function for unsigned remainder operation.
1525 inline APInt urem(const APInt& LHS, const APInt& RHS) {
1526   return LHS.urem(RHS);
1527 }
1528
1529 /// Performs multiplication on APInt values.
1530 /// @brief Function for multiplication operation.
1531 inline APInt mul(const APInt& LHS, const APInt& RHS) {
1532   return LHS * RHS;
1533 }
1534
1535 /// Performs addition on APInt values.
1536 /// @brief Function for addition operation.
1537 inline APInt add(const APInt& LHS, const APInt& RHS) {
1538   return LHS + RHS;
1539 }
1540
1541 /// Performs subtraction on APInt values.
1542 /// @brief Function for subtraction operation.
1543 inline APInt sub(const APInt& LHS, const APInt& RHS) {
1544   return LHS - RHS;
1545 }
1546
1547 /// Performs bitwise AND operation on APInt LHS and
1548 /// APInt RHS.
1549 /// @brief Bitwise AND function for APInt.
1550 inline APInt And(const APInt& LHS, const APInt& RHS) {
1551   return LHS & RHS;
1552 }
1553
1554 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1555 /// @brief Bitwise OR function for APInt.
1556 inline APInt Or(const APInt& LHS, const APInt& RHS) {
1557   return LHS | RHS;
1558 }
1559
1560 /// Performs bitwise XOR operation on APInt.
1561 /// @brief Bitwise XOR function for APInt.
1562 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
1563   return LHS ^ RHS;
1564 }
1565
1566 /// Performs a bitwise complement operation on APInt.
1567 /// @brief Bitwise complement function.
1568 inline APInt Not(const APInt& APIVal) {
1569   return ~APIVal;
1570 }
1571
1572 } // End of APIntOps namespace
1573
1574 } // End of llvm namespace
1575
1576 #endif