include/llvm/ADT/APInt.h

   1 //===-- llvm/Support/APInt.h - For Arbitrary Precision Integer -*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Sheng Zhou and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a class to represent arbitrary precision integral
  11 // constant values.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_APINT_H
  16 #define LLVM_APINT_H
  17
  18 #include "llvm/Support/DataTypes.h"
  19 #include <cassert>
  20 #include <string>
  21
  22 namespace llvm {
  23
  24 /// Forward declaration.
  25 class APInt;
  26 namespace APIntOps {
  27   APInt udiv(const APInt& LHS, const APInt& RHS);
  28   APInt urem(const APInt& LHS, const APInt& RHS);
  29 }
  30
  31 //===----------------------------------------------------------------------===//
  32 //                              APInt Class
  33 //===----------------------------------------------------------------------===//
  34
  35 /// APInt - This class represents arbitrary precision constant integral values.
  36 /// It is a functional replacement for common case unsigned integer type like
  37 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
  38 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
  39 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
  40 /// and methods to manipulate integer values of any bit-width. It supports both
  41 /// the typical integer arithmetic and comparison operations as well as bitwise
  42 /// manipulation.
  43 ///
  44 /// The class has several invariants worth noting:
  45 ///   * All bit, byte, and word positions are zero-based.
  46 ///   * Once the bit width is set, it doesn't change except by the Truncate,
  47 ///     SignExtend, or ZeroExtend operations.
  48 ///   * All binary operators must be on APInt instances of the same bit width.
  49 ///     Attempting to use these operators on instances with different bit
  50 ///     widths will yield an assertion.
  51 ///   * The value is stored canonically as an unsigned value. For operations
  52 ///     where it makes a difference, there are both signed and unsigned variants
  53 ///     of the operation. For example, sdiv and udiv. However, because the bit
  54 ///     widths must be the same, operations such as Mul and Add produce the same
  55 ///     results regardless of whether the values are interpreted as signed or
  56 ///     not.
  57 ///   * In general, the class tries to follow the style of computation that LLVM
  58 ///     uses in its IR. This simplifies its use for LLVM.
  59 ///
  60 /// @brief Class for arbitrary precision integers.
  61 class APInt {
  62
  63   uint32_t BitWidth;      ///< The number of bits in this APInt.
  64
  65   /// This union is used to store the integer value. When the
  66   /// integer bit-width <= 64, it uses VAL;
  67   /// otherwise it uses the pVal.
  68   union {
  69     uint64_t VAL;    ///< Used to store the <= 64 bits integer value.
  70     uint64_t *pVal;  ///< Used to store the >64 bits integer value.
  71   };
  72
  73   /// This enum is just used to hold a constant we needed for APInt.
  74   enum {
  75     APINT_BITS_PER_WORD = sizeof(uint64_t) * 8,
  76     APINT_WORD_SIZE = sizeof(uint64_t)
  77   };
  78
  79   // Fast internal constructor
  80   APInt(uint64_t* val, uint32_t bits) : BitWidth(bits), pVal(val) { }
  81
  82   /// Here one word's bitwidth equals to that of uint64_t.
  83   /// @returns the number of words to hold the integer value of this APInt.
  84   /// @brief Get the number of words.
  85   inline uint32_t getNumWords() const {
  86     return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
  87   }
  88
  89   /// @returns true if the number of bits <= 64, false otherwise.
  90   /// @brief Determine if this APInt just has one word to store value.
  91   inline bool isSingleWord() const {
  92     return BitWidth <= APINT_BITS_PER_WORD;
  93   }
  94
  95   /// @returns the word position for the specified bit position.
  96   static inline uint32_t whichWord(uint32_t bitPosition) {
  97     return bitPosition / APINT_BITS_PER_WORD;
  98   }
  99
 100   /// @returns the bit position in a word for the specified bit position
 101   /// in APInt.
 102   static inline uint32_t whichBit(uint32_t bitPosition) {
 103     return bitPosition % APINT_BITS_PER_WORD;
 104   }
 105
 106   /// @returns a uint64_t type integer with just bit position at
 107   /// "whichBit(bitPosition)" setting, others zero.
 108   static inline uint64_t maskBit(uint32_t bitPosition) {
 109     return (static_cast<uint64_t>(1)) << whichBit(bitPosition);
 110   }
 111
 112   /// This method is used internally to clear the to "N" bits that are not used
 113   /// by the APInt. This is needed after the most significant word is assigned
 114   /// a value to ensure that those bits are zero'd out.
 115   /// @brief Clear high order bits
 116   inline APInt& clearUnusedBits() {
 117     // Compute how many bits are used in the final word
 118     uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
 119     if (wordBits == 0)
 120       // If all bits are used, we want to leave the value alone. This also
 121       // avoids the undefined behavior of >> when the shfit is the same size as
 122       // the word size (64).
 123       return *this;
 124
 125     // Mask out the hight bits.
 126     uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
 127     if (isSingleWord())
 128       VAL &= mask;
 129     else
 130       pVal[getNumWords() - 1] &= mask;
 131     return *this;
 132   }
 133
 134   /// @returns the corresponding word for the specified bit position.
 135   /// @brief Get the word corresponding to a bit position
 136   inline uint64_t getWord(uint32_t bitPosition) const {
 137     return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
 138   }
 139
 140   /// This is used by the constructors that take string arguments.
 141   /// @brief Converts a char array into an APInt
 142   void fromString(uint32_t numBits, const char *StrStart, uint32_t slen,
 143                   uint8_t radix);
 144
 145   /// This is used by the toString method to divide by the radix. It simply
 146   /// provides a more convenient form of divide for internal use since KnuthDiv
 147   /// has specific constraints on its inputs. If those constraints are not met
 148   /// then it provides a simpler form of divide.
 149   /// @brief An internal division function for dividing APInts.
 150   static void divide(const APInt LHS, uint32_t lhsWords,
 151                      const APInt &RHS, uint32_t rhsWords,
 152                      APInt *Quotient, APInt *Remainder);
 153
 154 #ifndef NDEBUG
 155   /// @brief debug method
 156   void dump() const;
 157 #endif
 158
 159 public:
 160   /// @brief Create a new APInt of numBits width, initialized as val.
 161   APInt(uint32_t numBits, uint64_t val);
 162
 163   /// Note that numWords can be smaller or larger than the corresponding bit
 164   /// width but any extraneous bits will be dropped.
 165   /// @brief Create a new APInt of numBits width, initialized as bigVal[].
 166   APInt(uint32_t numBits, uint32_t numWords, uint64_t bigVal[]);
 167
 168   /// @brief Create a new APInt by translating the string represented
 169   /// integer value.
 170   APInt(uint32_t numBits, const std::string& Val, uint8_t radix);
 171
 172   /// @brief Create a new APInt by translating the char array represented
 173   /// integer value.
 174   APInt(uint32_t numBits, const char StrStart[], uint32_t slen, uint8_t radix);
 175
 176   /// @brief Copy Constructor.
 177   APInt(const APInt& API);
 178
 179   /// @brief Destructor.
 180   ~APInt();
 181
 182   /// @brief Copy assignment operator.
 183   APInt& operator=(const APInt& RHS);
 184
 185   /// Assigns an integer value to the APInt.
 186   /// @brief Assignment operator.
 187   APInt& operator=(uint64_t RHS);
 188
 189   /// Increments the APInt by one.
 190   /// @brief Postfix increment operator.
 191   inline const APInt operator++(int) {
 192     APInt API(*this);
 193     ++(*this);
 194     return API;
 195   }
 196
 197   /// Increments the APInt by one.
 198   /// @brief Prefix increment operator.
 199   APInt& operator++();
 200
 201   /// Decrements the APInt by one.
 202   /// @brief Postfix decrement operator.
 203   inline const APInt operator--(int) {
 204     APInt API(*this);
 205     --(*this);
 206     return API;
 207   }
 208
 209   /// Decrements the APInt by one.
 210   /// @brief Prefix decrement operator.
 211   APInt& operator--();
 212
 213   /// Performs bitwise AND operation on this APInt and the given APInt& RHS,
 214   /// assigns the result to this APInt.
 215   /// @brief Bitwise AND assignment operator.
 216   APInt& operator&=(const APInt& RHS);
 217
 218   /// Performs bitwise OR operation on this APInt and the given APInt& RHS,
 219   /// assigns the result to this APInt.
 220   /// @brief Bitwise OR assignment operator.
 221   APInt& operator|=(const APInt& RHS);
 222
 223   /// Performs bitwise XOR operation on this APInt and the given APInt& RHS,
 224   /// assigns the result to this APInt.
 225   /// @brief Bitwise XOR assignment operator.
 226   APInt& operator^=(const APInt& RHS);
 227
 228   /// Performs a bitwise complement operation on this APInt.
 229   /// @brief Bitwise complement operator.
 230   APInt operator~() const;
 231
 232   /// Multiplies this APInt by the  given APInt& RHS and
 233   /// assigns the result to this APInt.
 234   /// @brief Multiplication assignment operator.
 235   APInt& operator*=(const APInt& RHS);
 236
 237   /// Adds this APInt by the given APInt& RHS and
 238   /// assigns the result to this APInt.
 239   /// @brief Addition assignment operator.
 240   APInt& operator+=(const APInt& RHS);
 241
 242   /// Subtracts this APInt by the given APInt &RHS and
 243   /// assigns the result to this APInt.
 244   /// @brief Subtraction assignment operator.
 245   APInt& operator-=(const APInt& RHS);
 246
 247   /// Performs bitwise AND operation on this APInt and
 248   /// the given APInt& RHS.
 249   /// @brief Bitwise AND operator.
 250   APInt operator&(const APInt& RHS) const;
 251
 252   /// Performs bitwise OR operation on this APInt and the given APInt& RHS.
 253   /// @brief Bitwise OR operator.
 254   APInt operator|(const APInt& RHS) const;
 255
 256   /// Performs bitwise XOR operation on this APInt and the given APInt& RHS.
 257   /// @brief Bitwise XOR operator.
 258   APInt operator^(const APInt& RHS) const;
 259
 260   /// Performs logical negation operation on this APInt.
 261   /// @brief Logical negation operator.
 262   bool operator !() const;
 263
 264   /// Multiplies this APInt by the given APInt& RHS.
 265   /// @brief Multiplication operator.
 266   APInt operator*(const APInt& RHS) const;
 267
 268   /// Adds this APInt by the given APInt& RHS.
 269   /// @brief Addition operator.
 270   APInt operator+(const APInt& RHS) const;
 271   APInt operator+(uint64_t RHS) const {
 272     return (*this) + APInt(BitWidth, RHS);
 273   }
 274
 275
 276   /// Subtracts this APInt by the given APInt& RHS
 277   /// @brief Subtraction operator.
 278   APInt operator-(const APInt& RHS) const;
 279   APInt operator-(uint64_t RHS) const {
 280     return (*this) - APInt(BitWidth, RHS);
 281   }
 282
 283   /// @brief Unary negation operator
 284   inline APInt operator-() const {
 285     return APInt(BitWidth, 0) - (*this);
 286   }
 287
 288   /// @brief Array-indexing support.
 289   bool operator[](uint32_t bitPosition) const;
 290
 291   /// Compare this APInt with the given APInt& RHS
 292   /// for the validity of the equality relationship.
 293   /// @brief Equality operator.
 294   bool operator==(const APInt& RHS) const;
 295
 296   /// Compare this APInt with the given uint64_t value
 297   /// for the validity of the equality relationship.
 298   /// @brief Equality operator.
 299   bool operator==(uint64_t Val) const;
 300
 301   /// Compare this APInt with the given APInt& RHS
 302   /// for the validity of the inequality relationship.
 303   /// @brief Inequality operator.
 304   inline bool operator!=(const APInt& RHS) const {
 305     return !((*this) == RHS);
 306   }
 307
 308   /// Compare this APInt with the given uint64_t value
 309   /// for the validity of the inequality relationship.
 310   /// @brief Inequality operator.
 311   inline bool operator!=(uint64_t Val) const {
 312     return !((*this) == Val);
 313   }
 314
 315   /// @brief Equality comparison
 316   bool eq(const APInt &RHS) const {
 317     return (*this) == RHS;
 318   }
 319
 320   /// @brief Inequality comparison
 321   bool ne(const APInt &RHS) const {
 322     return !((*this) == RHS);
 323   }
 324
 325   /// @brief Unsigned less than comparison
 326   bool ult(const APInt& RHS) const;
 327
 328   /// @brief Signed less than comparison
 329   bool slt(const APInt& RHS) const;
 330
 331   /// @brief Unsigned less or equal comparison
 332   bool ule(const APInt& RHS) const {
 333     return ult(RHS) || eq(RHS);
 334   }
 335
 336   /// @brief Signed less or equal comparison
 337   bool sle(const APInt& RHS) const {
 338     return slt(RHS) || eq(RHS);
 339   }
 340
 341   /// @brief Unsigned greather than comparison
 342   bool ugt(const APInt& RHS) const {
 343     return !ult(RHS) && !eq(RHS);
 344   }
 345
 346   /// @brief Signed greather than comparison
 347   bool sgt(const APInt& RHS) const {
 348     return !slt(RHS) && !eq(RHS);
 349   }
 350
 351   /// @brief Unsigned greater or equal comparison
 352   bool uge(const APInt& RHS) const {
 353     return !ult(RHS);
 354   }
 355
 356   /// @brief Signed greather or equal comparison
 357   bool sge(const APInt& RHS) const {
 358     return !slt(RHS);
 359   }
 360
 361   /// This just tests the high bit of this APInt to determine if it is negative.
 362   /// @returns true if this APInt is negative, false otherwise
 363   /// @brief Determine sign of this APInt.
 364   bool isNegative() const {
 365     return (*this)[BitWidth - 1];
 366   }
 367
 368   /// Arithmetic right-shift this APInt by shiftAmt.
 369   /// @brief Arithmetic right-shift function.
 370   APInt ashr(uint32_t shiftAmt) const;
 371
 372   /// Logical right-shift this APInt by shiftAmt.
 373   /// @brief Logical right-shift function.
 374   APInt lshr(uint32_t shiftAmt) const;
 375
 376   /// Left-shift this APInt by shiftAmt.
 377   /// @brief Left-shift function.
 378   APInt shl(uint32_t shiftAmt) const;
 379
 380   /// Signed divide this APInt by APInt RHS.
 381   /// @brief Signed division function for APInt.
 382   inline APInt sdiv(const APInt& RHS) const {
 383     bool isNegativeLHS = isNegative();
 384     bool isNegativeRHS = RHS.isNegative();
 385     APInt Result = APIntOps::udiv(
 386         isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
 387     return isNegativeLHS != isNegativeRHS ? -Result : Result;
 388   }
 389
 390   /// Unsigned divide this APInt by APInt RHS.
 391   /// @brief Unsigned division function for APInt.
 392   APInt udiv(const APInt& RHS) const;
 393
 394   /// Signed remainder operation on APInt.
 395   /// @brief Function for signed remainder operation.
 396   inline APInt srem(const APInt& RHS) const {
 397     bool isNegativeLHS = isNegative();
 398     bool isNegativeRHS = RHS.isNegative();
 399     APInt Result = APIntOps::urem(
 400         isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
 401     return isNegativeLHS ? -Result : Result;
 402   }
 403
 404   /// Unsigned remainder operation on APInt.
 405   /// @brief Function for unsigned remainder operation.
 406   APInt urem(const APInt& RHS) const;
 407
 408   /// Truncate the APInt to a specified width. It is an error to specify a width
 409   /// that is greater than or equal to the current width.
 410   /// @brief Truncate to new width.
 411   APInt &trunc(uint32_t width);
 412
 413   /// This operation sign extends the APInt to a new width. If the high order
 414   /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
 415   /// It is an error to specify a width that is less than or equal to the
 416   /// current width.
 417   /// @brief Sign extend to a new width.
 418   APInt &sext(uint32_t width);
 419
 420   /// This operation zero extends the APInt to a new width. Thie high order bits
 421   /// are filled with 0 bits.  It is an error to specify a width that is less
 422   /// than or equal to the current width.
 423   /// @brief Zero extend to a new width.
 424   APInt &zext(uint32_t width);
 425
 426   /// @brief Set every bit to 1.
 427   APInt& set();
 428
 429   /// Set the given bit to 1 whose position is given as "bitPosition".
 430   /// @brief Set a given bit to 1.
 431   APInt& set(uint32_t bitPosition);
 432
 433   /// @brief Set every bit to 0.
 434   APInt& clear();
 435
 436   /// Set the given bit to 0 whose position is given as "bitPosition".
 437   /// @brief Set a given bit to 0.
 438   APInt& clear(uint32_t bitPosition);
 439
 440   /// @brief Toggle every bit to its opposite value.
 441   APInt& flip();
 442
 443   /// Toggle a given bit to its opposite value whose position is given
 444   /// as "bitPosition".
 445   /// @brief Toggles a given bit to its opposite value.
 446   APInt& flip(uint32_t bitPosition);
 447
 448   /// This function returns the number of active bits which is defined as the
 449   /// bit width minus the number of leading zeros. This is used in several
 450   /// computations to see how "wide" the value is.
 451   /// @brief Compute the number of active bits in the value
 452   inline uint32_t getActiveBits() const {
 453     return BitWidth - countLeadingZeros();
 454   }
 455
 456   /// This function returns the number of active words in the value of this
 457   /// APInt. This is used in conjunction with getActiveData to extract the raw
 458   /// value of the APInt.
 459   inline uint32_t getActiveWords() const {
 460     return whichWord(getActiveBits()-1) + 1;
 461   }
 462
 463   /// This function returns a pointer to the internal storage of the APInt.
 464   /// This is useful for writing out the APInt in binary form without any
 465   /// conversions.
 466   inline const uint64_t* getRawData() const {
 467     if (isSingleWord())
 468       return &VAL;
 469     return &pVal[0];
 470   }
 471
 472   /// Computes the minimum bit width for this APInt while considering it to be
 473   /// a signed (and probably negative) value. If the value is not negative,
 474   /// this function returns the same value as getActiveBits(). Otherwise, it
 475   /// returns the smallest bit width that will retain the negative value. For
 476   /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
 477   /// for -1, this function will always return 1.
 478   /// @brief Get the minimum bit size for this signed APInt
 479   inline uint32_t getMinSignedBits() const {
 480     if (isNegative())
 481       return BitWidth - countLeadingOnes() + 1;
 482     return getActiveBits();
 483   }
 484
 485   /// This method attempts to return the value of this APInt as a zero extended
 486   /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
 487   /// uint64_t. Otherwise an assertion will result.
 488   /// @brief Get zero extended value
 489   inline uint64_t getZExtValue() const {
 490     if (isSingleWord())
 491       return VAL;
 492     assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
 493     return pVal[0];
 494   }
 495
 496   /// This method attempts to return the value of this APInt as a sign extended
 497   /// int64_t. The bit width must be <= 64 or the value must fit within an
 498   /// int64_t. Otherwise an assertion will result.
 499   /// @brief Get sign extended value
 500   inline int64_t getSExtValue() const {
 501     if (isSingleWord())
 502       return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
 503                      (APINT_BITS_PER_WORD - BitWidth);
 504     assert(getActiveBits() <= 64 && "Too many bits for int64_t");
 505     return int64_t(pVal[0]);
 506   }
 507
 508   /// @brief Gets maximum unsigned value of APInt for specific bit width.
 509   static APInt getMaxValue(uint32_t numBits) {
 510     return APInt(numBits, 0).set();
 511   }
 512
 513   /// @brief Gets maximum signed value of APInt for a specific bit width.
 514   static APInt getSignedMaxValue(uint32_t numBits) {
 515     return APInt(numBits, 0).set().clear(numBits - 1);
 516   }
 517
 518   /// @brief Gets minimum unsigned value of APInt for a specific bit width.
 519   static APInt getMinValue(uint32_t numBits) {
 520     return APInt(numBits, 0);
 521   }
 522
 523   /// @brief Gets minimum signed value of APInt for a specific bit width.
 524   static APInt getSignedMinValue(uint32_t numBits) {
 525     return APInt(numBits, 0).set(numBits - 1);
 526   }
 527
 528   /// @returns the all-ones value for an APInt of the specified bit-width.
 529   /// @brief Get the all-ones value.
 530   static APInt getAllOnesValue(uint32_t numBits) {
 531     return APInt(numBits, 0).set();
 532   }
 533
 534   /// @returns the '0' value for an APInt of the specified bit-width.
 535   /// @brief Get the '0' value.
 536   static APInt getNullValue(uint32_t numBits) {
 537     return APInt(numBits, 0);
 538   }
 539
 540   /// The hash value is computed as the sum of the words and the bit width.
 541   /// @returns A hash value computed from the sum of the APInt words.
 542   /// @brief Get a hash value based on this APInt
 543   uint64_t getHashValue() const;
 544
 545   /// This converts the APInt to a boolean valy as a test against zero.
 546   /// @brief Boolean conversion function.
 547   inline bool getBoolValue() const {
 548     return countLeadingZeros() != BitWidth;
 549   }
 550
 551   /// This checks to see if the value has all bits of the APInt are set or not.
 552   /// @brief Determine if all bits are set
 553   inline bool isAllOnesValue() const {
 554     return countPopulation() == BitWidth;
 555   }
 556
 557   /// This checks to see if the value of this APInt is the maximum unsigned
 558   /// value for the APInt's bit width.
 559   /// @brief Determine if this is the largest unsigned value.
 560   bool isMaxValue() const {
 561     return countPopulation() == BitWidth;
 562   }
 563
 564   /// This checks to see if the value of this APInt is the maximum signed
 565   /// value for the APInt's bit width.
 566   /// @brief Determine if this is the largest signed value.
 567   bool isMaxSignedValue() const {
 568     return BitWidth == 1 ? VAL == 0 :
 569                           !isNegative() && countPopulation() == BitWidth - 1;
 570   }
 571
 572   /// This checks to see if the value of this APInt is the minimum signed
 573   /// value for the APInt's bit width.
 574   /// @brief Determine if this is the smallest unsigned value.
 575   bool isMinValue() const {
 576     return countPopulation() == 0;
 577   }
 578
 579   /// This checks to see if the value of this APInt is the minimum signed
 580   /// value for the APInt's bit width.
 581   /// @brief Determine if this is the smallest signed value.
 582   bool isMinSignedValue() const {
 583     return BitWidth == 1 ? VAL == 1 :
 584                            isNegative() && countPopulation() == 1;
 585   }
 586
 587   /// This is used internally to convert an APInt to a string.
 588   /// @brief Converts an APInt to a std::string
 589   std::string toString(uint8_t radix, bool wantSigned) const;
 590
 591   /// Considers the APInt to be unsigned and converts it into a string in the
 592   /// radix given. The radix can be 2, 8, 10 or 16.
 593   /// @returns a character interpretation of the APInt
 594   /// @brief Convert unsigned APInt to string representation.
 595   inline std::string toString(uint8_t radix = 10) const {
 596     return toString(radix, false);
 597   }
 598
 599   /// Considers the APInt to be unsigned and converts it into a string in the
 600   /// radix given. The radix can be 2, 8, 10 or 16.
 601   /// @returns a character interpretation of the APInt
 602   /// @brief Convert unsigned APInt to string representation.
 603   inline std::string toStringSigned(uint8_t radix = 10) const {
 604     return toString(radix, true);
 605   }
 606
 607   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 608   /// the low bits and right shift to the least significant bit.
 609   /// @returns the high "numBits" bits of this APInt.
 610   APInt getHiBits(uint32_t numBits) const;
 611
 612   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 613   /// the high bits.
 614   /// @returns the low "numBits" bits of this APInt.
 615   APInt getLoBits(uint32_t numBits) const;
 616
 617   /// @returns true if the argument APInt value is a power of two > 0.
 618   bool isPowerOf2() const;
 619
 620   /// countLeadingZeros - This function is an APInt version of the
 621   /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
 622   /// of zeros from the most significant bit to the first one bit.
 623   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 624   /// @returns the number of zeros from the most significant bit to the first
 625   /// one bits.
 626   /// @brief Count the number of leading one bits.
 627   uint32_t countLeadingZeros() const;
 628
 629   /// countLeadingOnes - This function counts the number of contiguous 1 bits
 630   /// in the high order bits. The count stops when the first 0 bit is reached.
 631   /// @returns 0 if the high order bit is not set
 632   /// @returns the number of 1 bits from the most significant to the least
 633   /// @brief Count the number of leading one bits.
 634   uint32_t countLeadingOnes() const;
 635
 636   /// countTrailingZeros - This function is an APInt version of the
 637   /// countTrailingZoers_{32,64} functions in MathExtras.h. It counts
 638   /// the number of zeros from the least significant bit to the first one bit.
 639   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 640   /// @returns the number of zeros from the least significant bit to the first
 641   /// one bit.
 642   /// @brief Count the number of trailing zero bits.
 643   uint32_t countTrailingZeros() const;
 644
 645   /// countPopulation - This function is an APInt version of the
 646   /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
 647   /// of 1 bits in the APInt value.
 648   /// @returns 0 if the value is zero.
 649   /// @returns the number of set bits.
 650   /// @brief Count the number of bits set.
 651   uint32_t countPopulation() const;
 652
 653   /// @returns the total number of bits.
 654   inline uint32_t getBitWidth() const {
 655     return BitWidth;
 656   }
 657
 658   /// @brief Check if this APInt has a N-bits integer value.
 659   inline bool isIntN(uint32_t N) const {
 660     assert(N && "N == 0 ???");
 661     if (isSingleWord()) {
 662       return VAL == (VAL & (~0ULL >> (64 - N)));
 663     } else {
 664       APInt Tmp(N, getNumWords(), pVal);
 665       return Tmp == (*this);
 666     }
 667   }
 668
 669   /// @returns a byte-swapped representation of this APInt Value.
 670   APInt byteSwap() const;
 671
 672   /// @returns the floor log base 2 of this APInt.
 673   inline uint32_t logBase2() const {
 674     return getNumWords() * APINT_BITS_PER_WORD - 1 - countLeadingZeros();
 675   }
 676
 677   /// @brief Converts this APInt to a double value.
 678   double roundToDouble(bool isSigned) const;
 679
 680   /// @brief Converts this unsigned APInt to a double value.
 681   double roundToDouble() const {
 682     return roundToDouble(false);
 683   }
 684
 685   /// @brief Converts this signed APInt to a double value.
 686   double signedRoundToDouble() const {
 687     return roundToDouble(true);
 688   }
 689
 690   /// @brief Compute the square root
 691   APInt sqrt() const;
 692 };
 693
 694 inline bool operator==(uint64_t V1, const APInt& V2) {
 695   return V2 == V1;
 696 }
 697
 698 inline bool operator!=(uint64_t V1, const APInt& V2) {
 699   return V2 != V1;
 700 }
 701
 702 namespace APIntOps {
 703
 704 /// @brief Determine the smaller of two APInts considered to be signed.
 705 inline APInt smin(const APInt &A, const APInt &B) {
 706   return A.slt(B) ? A : B;
 707 }
 708
 709 /// @brief Determine the larger of two APInts considered to be signed.
 710 inline APInt smax(const APInt &A, const APInt &B) {
 711   return A.sgt(B) ? A : B;
 712 }
 713
 714 /// @brief Determine the smaller of two APInts considered to be signed.
 715 inline APInt umin(const APInt &A, const APInt &B) {
 716   return A.ult(B) ? A : B;
 717 }
 718
 719 /// @brief Determine the larger of two APInts considered to be unsigned.
 720 inline APInt umax(const APInt &A, const APInt &B) {
 721   return A.ugt(B) ? A : B;
 722 }
 723
 724 /// @brief Check if the specified APInt has a N-bits integer value.
 725 inline bool isIntN(uint32_t N, const APInt& APIVal) {
 726   return APIVal.isIntN(N);
 727 }
 728
 729 /// @returns true if the argument APInt value is a sequence of ones
 730 /// starting at the least significant bit with the remainder zero.
 731 inline const bool isMask(uint32_t numBits, const APInt& APIVal) {
 732   return APIVal.getBoolValue() && ((APIVal + APInt(numBits,1)) & APIVal) == 0;
 733 }
 734
 735 /// @returns true if the argument APInt value contains a sequence of ones
 736 /// with the remainder zero.
 737 inline const bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
 738   return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
 739 }
 740
 741 /// @returns a byte-swapped representation of the specified APInt Value.
 742 inline APInt byteSwap(const APInt& APIVal) {
 743   return APIVal.byteSwap();
 744 }
 745
 746 /// @returns the floor log base 2 of the specified APInt value.
 747 inline uint32_t logBase2(const APInt& APIVal) {
 748   return APIVal.logBase2();
 749 }
 750
 751 /// GreatestCommonDivisor - This function returns the greatest common
 752 /// divisor of the two APInt values using Enclid's algorithm.
 753 /// @returns the greatest common divisor of Val1 and Val2
 754 /// @brief Compute GCD of two APInt values.
 755 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
 756
 757 /// Treats the APInt as an unsigned value for conversion purposes.
 758 /// @brief Converts the given APInt to a double value.
 759 inline double RoundAPIntToDouble(const APInt& APIVal) {
 760   return APIVal.roundToDouble();
 761 }
 762
 763 /// Treats the APInt as a signed value for conversion purposes.
 764 /// @brief Converts the given APInt to a double value.
 765 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
 766   return APIVal.signedRoundToDouble();
 767 }
 768
 769 /// @brief Converts the given APInt to a float vlalue.
 770 inline float RoundAPIntToFloat(const APInt& APIVal) {
 771   return float(RoundAPIntToDouble(APIVal));
 772 }
 773
 774 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
 775 /// @brief Converts the given double value into a APInt.
 776 APInt RoundDoubleToAPInt(double Double, uint32_t width = 64);
 777
 778 /// RoundFloatToAPInt - Converts a float value into an APInt value.
 779 /// @brief Converts a float value into a APInt.
 780 inline APInt RoundFloatToAPInt(float Float) {
 781   return RoundDoubleToAPInt(double(Float));
 782 }
 783
 784 /// Arithmetic right-shift the APInt by shiftAmt.
 785 /// @brief Arithmetic right-shift function.
 786 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
 787   return LHS.ashr(shiftAmt);
 788 }
 789
 790 /// Logical right-shift the APInt by shiftAmt.
 791 /// @brief Logical right-shift function.
 792 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
 793   return LHS.lshr(shiftAmt);
 794 }
 795
 796 /// Left-shift the APInt by shiftAmt.
 797 /// @brief Left-shift function.
 798 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
 799   return LHS.shl(shiftAmt);
 800 }
 801
 802 /// Signed divide APInt LHS by APInt RHS.
 803 /// @brief Signed division function for APInt.
 804 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
 805   return LHS.sdiv(RHS);
 806 }
 807
 808 /// Unsigned divide APInt LHS by APInt RHS.
 809 /// @brief Unsigned division function for APInt.
 810 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
 811   return LHS.udiv(RHS);
 812 }
 813
 814 /// Signed remainder operation on APInt.
 815 /// @brief Function for signed remainder operation.
 816 inline APInt srem(const APInt& LHS, const APInt& RHS) {
 817   return LHS.srem(RHS);
 818 }
 819
 820 /// Unsigned remainder operation on APInt.
 821 /// @brief Function for unsigned remainder operation.
 822 inline APInt urem(const APInt& LHS, const APInt& RHS) {
 823   return LHS.urem(RHS);
 824 }
 825
 826 /// Performs multiplication on APInt values.
 827 /// @brief Function for multiplication operation.
 828 inline APInt mul(const APInt& LHS, const APInt& RHS) {
 829   return LHS * RHS;
 830 }
 831
 832 /// Performs addition on APInt values.
 833 /// @brief Function for addition operation.
 834 inline APInt add(const APInt& LHS, const APInt& RHS) {
 835   return LHS + RHS;
 836 }
 837
 838 /// Performs subtraction on APInt values.
 839 /// @brief Function for subtraction operation.
 840 inline APInt sub(const APInt& LHS, const APInt& RHS) {
 841   return LHS - RHS;
 842 }
 843
 844 /// Performs bitwise AND operation on APInt LHS and
 845 /// APInt RHS.
 846 /// @brief Bitwise AND function for APInt.
 847 inline APInt And(const APInt& LHS, const APInt& RHS) {
 848   return LHS & RHS;
 849 }
 850
 851 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
 852 /// @brief Bitwise OR function for APInt.
 853 inline APInt Or(const APInt& LHS, const APInt& RHS) {
 854   return LHS | RHS;
 855 }
 856
 857 /// Performs bitwise XOR operation on APInt.
 858 /// @brief Bitwise XOR function for APInt.
 859 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
 860   return LHS ^ RHS;
 861 }
 862
 863 /// Performs a bitwise complement operation on APInt.
 864 /// @brief Bitwise complement function.
 865 inline APInt Not(const APInt& APIVal) {
 866   return ~APIVal;
 867 }
 868
 869 } // End of APIntOps namespace
 870
 871 } // End of llvm namespace
 872
 873 #endif