Improve documentation.
[oota-llvm.git] / include / llvm / ADT / APInt.h
index 8cfb1d566bfdad6d5f570109a512e886e1a4b0bb..ca09ff68acffc9f2ecab7f192b5dc219384d678b 100644 (file)
 #define LLVM_APINT_H
 
 #include "llvm/Support/DataTypes.h"
+#include <cassert>
 #include <string>
 
 namespace llvm {
 
+/// Forward declaration.
+class APInt;
+namespace APIntOps {
+  APInt udiv(const APInt& LHS, const APInt& RHS);
+  APInt urem(const APInt& LHS, const APInt& RHS);
+}
+
 //===----------------------------------------------------------------------===//
 //                              APInt Class
 //===----------------------------------------------------------------------===//
@@ -27,26 +35,32 @@ namespace llvm {
 /// APInt - This class represents arbitrary precision constant integral values.
 /// It is a functional replacement for common case unsigned integer type like 
 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width 
-/// integer type and large integer value types such as 3-bits, 15-bits, or more
+/// integer sizes and large integer value types such as 3-bits, 15-bits, or more
 /// than 64-bits of precision. APInt provides a variety of arithmetic operators 
-/// and methods to manipulate integer values of any bit-width. It supports not 
-/// only all the operations of uint64_t but also bitwise manipulation.
+/// and methods to manipulate integer values of any bit-width. It supports both
+/// the typical integer arithmetic and comparison operations as well as bitwise
+/// manipulation.
 ///
-/// @brief Class for arbitrary precision integers.
-///
-/// Note: In this class, all bit/byte/word positions are zero-based.
+/// The class has several invariants worth noting:
+///   * All bit, byte, and word positions are zero-based.
+///   * Once the bit width is set, it doesn't change except by the Truncate, 
+///     SignExtend, or ZeroExtend operations.
+///   * All binary operators must be on APInt instances of the same bit width.
+///     Attempting to use these operators on instances with different bit 
+///     widths will yield an assertion.
+///   * The value is stored canonically as an unsigned value. For operations
+///     where it makes a difference, there are both signed and unsigned variants
+///     of the operation. For example, sdiv and udiv. However, because the bit
+///     widths must be the same, operations such as Mul and Add produce the same
+///     results regardless of whether the values are interpreted as signed or
+///     not.
+///   * In general, the class tries to follow the style of computation that LLVM
+///     uses in its IR. This simplifies its use for LLVM.
 ///
+/// @brief Class for arbitrary precision integers.
 class APInt {
-  /// Friend Functions of APInt declared here. For detailed comments,
-  /// see bottom of this file.
-  friend bool isIntN(unsigned N, const APInt& APIVal);
-  friend APInt ByteSwap(const APInt& APIVal);
-  friend APInt LogBase2(const APInt& APIVal);
-  friend double APIntToDouble(const APInt& APIVal);
-  friend float APIntToFloat(const APInt& APIVal);
-
-  unsigned bitsnum;      ///< The number of bits.
-  bool isSigned;         ///< The sign flag for this APInt.
+public:
+  uint32_t BitWidth;      ///< The number of bits in this APInt.
 
   /// This union is used to store the integer value. When the
   /// integer bit-width <= 64, it uses VAL; 
@@ -58,68 +72,91 @@ class APInt {
 
   /// This enum is just used to hold a constant we needed for APInt.
   enum {
-    APINT_BITS_PER_WORD = sizeof(uint64_t) * 8
+    APINT_BITS_PER_WORD = sizeof(uint64_t) * 8,
+    APINT_WORD_SIZE = sizeof(uint64_t)
   };
 
   /// Here one word's bitwidth equals to that of uint64_t.
   /// @returns the number of words to hold the integer value of this APInt.
   /// @brief Get the number of words.
-  inline unsigned numWords() const {
-    return bitsnum < 1 ? 0 : (bitsnum + APINT_BITS_PER_WORD - 1) /
-                             APINT_BITS_PER_WORD;
+  inline uint32_t getNumWords() const {
+    return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
   }
 
   /// @returns true if the number of bits <= 64, false otherwise.
   /// @brief Determine if this APInt just has one word to store value.
-  inline bool isSingleWord() const
-  { return bitsnum <= APINT_BITS_PER_WORD; }
+  inline bool isSingleWord() const { 
+    return BitWidth <= APINT_BITS_PER_WORD; 
+  }
 
   /// @returns the word position for the specified bit position.
-  static inline unsigned whichWord(unsigned bitPosition)
-  { return bitPosition / APINT_BITS_PER_WORD; }
-
-  /// @returns the byte position for the specified bit position.
-  static inline unsigned whichByte(unsigned bitPosition);
+  static inline uint32_t whichWord(uint32_t bitPosition) { 
+    return bitPosition / APINT_BITS_PER_WORD; 
+  }
 
   /// @returns the bit position in a word for the specified bit position 
   /// in APInt.
-  static inline unsigned whichBit(unsigned bitPosition)
-  { return bitPosition % APINT_BITS_PER_WORD; }
+  static inline uint32_t whichBit(uint32_t bitPosition) { 
+    return bitPosition % APINT_BITS_PER_WORD; 
+  }
 
   /// @returns a uint64_t type integer with just bit position at
   /// "whichBit(bitPosition)" setting, others zero.
-  static inline uint64_t maskBit(unsigned bitPosition)
-  { return (static_cast<uint64_t>(1)) << whichBit(bitPosition); }
+  static inline uint64_t maskBit(uint32_t bitPosition) { 
+    return (static_cast<uint64_t>(1)) << whichBit(bitPosition); 
+  }
 
-  inline void TruncToBits() {
+  /// This method is used internally to clear the to "N" bits that are not used
+  /// by the APInt. This is needed after the most significant word is assigned 
+  /// a value to ensure that those bits are zero'd out.
+  /// @brief Clear high order bits
+  inline void clearUnusedBits() {
     if (isSingleWord())
-      VAL &= ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - bitsnum);
+      VAL &= ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - BitWidth);
     else
-      pVal[numWords() - 1] &= ~uint64_t(0ULL) >> 
-        (APINT_BITS_PER_WORD - (whichBit(bitsnum - 1) + 1));
+      pVal[getNumWords() - 1] &= ~uint64_t(0ULL) >> 
+        (APINT_BITS_PER_WORD - (whichBit(BitWidth - 1) + 1));
   }
 
   /// @returns the corresponding word for the specified bit position.
-  inline uint64_t& getWord(unsigned bitPosition)
-  { return isSingleWord() ? VAL : pVal[whichWord(bitPosition)]; }
+  /// @brief Get the word corresponding to a bit position
+  inline uint64_t getWord(uint32_t bitPosition) const { 
+    return isSingleWord() ? VAL : pVal[whichWord(bitPosition)]; 
+  }
 
-  /// @returns the corresponding word for the specified bit position.
-  /// This is a constant version.
-  inline uint64_t getWord(unsigned bitPosition) const
-  { return isSingleWord() ? VAL : pVal[whichWord(bitPosition)]; }
+  /// This is used by the constructors that take string arguments.
+  /// @brief Converts a char array into an APInt
+  void fromString(uint32_t numBits, const char *StrStart, uint32_t slen, 
+                  uint8_t radix);
+
+  /// This is used by the toString method to divide by the radix. It simply
+  /// provides a more convenient form of divide for internal use.
+  /// @brief An internal division function for dividing APInts.
+  static void divide(const APInt LHS, uint32_t lhsWords, 
+                     const APInt &RHS, uint32_t rhsWords,
+                     APInt *Quotient, APInt *Remainder);
+
+#ifndef NDEBUG
+  /// @brief debug method
+  void dump() const;
+#endif
 
 public:
-  /// @brief Create a new APInt of numBits bit-width, and initialized as val.
-  APInt(uint64_t val = 0, unsigned numBits = APINT_BITS_PER_WORD, 
-        bool sign = false);
+  /// @brief Create a new APInt of numBits width, initialized as val.
+  APInt(uint32_t numBits, uint64_t val);
 
-  /// @brief Create a new APInt of numBits bit-width, and initialized as 
-  /// bigVal[].
-  APInt(unsigned numBits, uint64_t bigVal[], bool sign = false);
+  /// Note that numWords can be smaller or larger than the corresponding bit
+  /// width but any extraneous bits will be dropped.
+  /// @brief Create a new APInt of numBits width, initialized as bigVal[].
+  APInt(uint32_t numBits, uint32_t numWords, uint64_t bigVal[]);
 
   /// @brief Create a new APInt by translating the string represented 
   /// integer value.
-  APInt(std::string& Val, uint8_t radix = 10, bool sign = false);
+  APInt(uint32_t numBits, const std::string& Val, uint8_t radix);
+
+  /// @brief Create a new APInt by translating the char array represented
+  /// integer value.
+  APInt(uint32_t numBits, const char StrStart[], uint32_t slen, uint8_t radix);
 
   /// @brief Copy Constructor.
   APInt(const APInt& API);
@@ -136,7 +173,11 @@ public:
 
   /// Increments the APInt by one.
   /// @brief Postfix increment operator.
-  const APInt operator++(int);
+  inline const APInt operator++(int) {
+    APInt API(*this);
+    ++(*this);
+    return API;
+  }
 
   /// Increments the APInt by one.
   /// @brief Prefix increment operator.
@@ -144,7 +185,11 @@ public:
 
   /// Decrements the APInt by one.
   /// @brief Postfix decrement operator. 
-  const APInt operator--(int);
+  inline const APInt operator--(int) {
+    APInt API(*this);
+    --(*this);
+    return API;
+  }
 
   /// Decrements the APInt by one.
   /// @brief Prefix decrement operator. 
@@ -165,14 +210,6 @@ public:
   /// @brief Bitwise XOR assignment operator. 
   APInt& operator^=(const APInt& RHS);
 
-  /// Left-shift the APInt by shiftAmt and assigns the result to this APInt.
-  /// @brief Left-shift assignment operator. 
-  APInt& operator<<=(unsigned shiftAmt);
-
-  /// Right-shift the APInt by shiftAmt and assigns the result to this APInt.
-  /// @brief Right-shift assignment operator. 
-  APInt& operator>>=(unsigned shiftAmt);
-
   /// Performs a bitwise complement operation on this APInt.
   /// @brief Bitwise complement operator. 
   APInt operator~() const;
@@ -182,11 +219,6 @@ public:
   /// @brief Multiplication assignment operator. 
   APInt& operator*=(const APInt& RHS);
 
-  /// Divides this APInt by the given APInt &RHS and 
-  /// assigns the result to this APInt.
-  /// @brief Division assignment operator. 
-  APInt& operator/=(const APInt& RHS);
-
   /// Adds this APInt by the given APInt& RHS and 
   /// assigns the result to this APInt.
   /// @brief Addition assignment operator. 
@@ -197,11 +229,6 @@ public:
   /// @brief Subtraction assignment operator. 
   APInt& operator-=(const APInt& RHS);
 
-  /// Yields the remainder from the division of this APInt by 
-  /// the given APInt& RHS and assigns the remainder to this APInt.
-  /// @brief Remainder assignment operator. 
-  APInt& operator%=(const APInt& RHS);
-
   /// Performs bitwise AND operation on this APInt and 
   /// the given APInt& RHS.
   /// @brief Bitwise AND operator. 
@@ -215,14 +242,6 @@ public:
   /// @brief Bitwise XOR operator. 
   APInt operator^(const APInt& RHS) const;
 
-  /// Performs logical AND operation on this APInt and the given APInt& RHS.
-  /// @brief Logical AND operator. 
-  bool operator&&(const APInt& RHS) const;
-
-  /// Performs logical OR operation on this APInt and the given APInt& RHS.
-  /// @brief Logical OR operator. 
-  bool operator||(const APInt& RHS) const;
-
   /// Performs logical negation operation on this APInt.
   /// @brief Logical negation operator. 
   bool operator !() const;
@@ -231,15 +250,6 @@ public:
   /// @brief Multiplication operator. 
   APInt operator*(const APInt& RHS) const;
 
-  /// Divides this APInt by the given APInt& RHS.
-  /// @brief Division operator. 
-  APInt operator/(const APInt& RHS) const;
-
-  /// Yields the remainder from the division of 
-  /// this APInt and the given APInt& RHS.
-  /// @brief Remainder operator. 
-  APInt operator%(const APInt& RHS) const;
-
   /// Adds this APInt by the given APInt& RHS.
   /// @brief Addition operator. 
   APInt operator+(const APInt& RHS) const;
@@ -248,90 +258,155 @@ public:
   /// @brief Subtraction operator. 
   APInt operator-(const APInt& RHS) const;
 
-  /// Left-shift the APInt by shiftAmt.
-  /// @brief Left-shift operator. 
-  APInt operator<<(unsigned shiftAmt) const;
-
-  /// Right-shift the APInt by shiftAmt.
-  /// @brief Right-shift operator. 
-  APInt operator>>(unsigned shiftAmt) const;
+  /// @brief Unary negation operator
+  inline APInt operator-() const {
+    return APInt(BitWidth, 0) - (*this);
+  }
 
   /// @brief Array-indexing support.
-  bool operator[](unsigned bitPosition) const;
+  bool operator[](uint32_t bitPosition) const;
 
   /// Compare this APInt with the given APInt& RHS 
   /// for the validity of the equality relationship.
   /// @brief Equality operator. 
   bool operator==(const APInt& RHS) const;
 
+  /// Compare this APInt with the given uint64_t value
+  /// for the validity of the equality relationship.
+  /// @brief Equality operator.
+  bool operator==(uint64_t Val) const;
+
   /// Compare this APInt with the given APInt& RHS 
   /// for the validity of the inequality relationship.
   /// @brief Inequality operator. 
-  bool operator!=(const APInt& RHS) const;
+  inline bool operator!=(const APInt& RHS) const {
+    return !((*this) == RHS);
+  }
+
+  /// Compare this APInt with the given uint64_t value 
+  /// for the validity of the inequality relationship.
+  /// @brief Inequality operator. 
+  inline bool operator!=(uint64_t Val) const {
+    return !((*this) == Val);
+  }
+  
+  /// @brief Equality comparison
+  bool eq(const APInt &RHS) const {
+    return (*this) == RHS; 
+  }
 
-  /// Compare this APInt with the given APInt& RHS for 
-  /// the validity of the less-than relationship.
-  /// @brief Less-than operator. 
-  bool operator <(const APInt& RHS) const;
+  /// @brief Inequality comparison
+  bool ne(const APInt &RHS) const {
+    return !((*this) == RHS);
+  }
 
-  /// Compare this APInt with the given APInt& RHS for the validity 
-  /// of the less-than-or-equal relationship.
-  /// @brief Less-than-or-equal operator. 
-  bool operator<=(const APInt& RHS) const;
+  /// @brief Unsigned less than comparison
+  bool ult(const APInt& RHS) const;
 
-  /// Compare this APInt with the given APInt& RHS for the validity 
-  /// of the greater-than relationship.
-  /// @brief Greater-than operator. 
-  bool operator> (const APInt& RHS) const;
+  /// @brief Signed less than comparison
+  bool slt(const APInt& RHS) const;
 
-  /// @brief Greater-than-or-equal operator. 
-  /// Compare this APInt with the given APInt& RHS for the validity 
-  /// of the greater-than-or-equal relationship.
-  bool operator>=(const APInt& RHS) const;
+  /// @brief Unsigned less or equal comparison
+  bool ule(const APInt& RHS) const {
+    return ult(RHS) || eq(RHS);
+  }
 
-  /// @returns a uint64_t value from this APInt. If this APInt contains a single
-  /// word, just returns VAL, otherwise pVal[0].
-  inline uint64_t getValue() {
-    if (isSingleWord())
-      return isSigned ? ((int64_t(VAL) << (APINT_BITS_PER_WORD - bitsnum)) >> 
-                         (APINT_BITS_PER_WORD - bitsnum)) :
-                        VAL;
-    else
-      return pVal[0];
+  /// @brief Signed less or equal comparison
+  bool sle(const APInt& RHS) const {
+    return slt(RHS) || eq(RHS);
   }
 
-  /// @returns the largest value for an APInt of the specified bit-width and 
-  /// if isSign == true, it should be largest signed value, otherwise largest
-  /// unsigned value.
-  /// @brief Gets max value of the APInt with bitwidth <= 64.
-  static APInt getMaxValue(unsigned numBits, bool isSign);
+  /// @brief Unsigned greather than comparison
+  bool ugt(const APInt& RHS) const {
+    return !ult(RHS) && !eq(RHS);
+  }
 
-  /// @returns the smallest value for an APInt of the given bit-width and
-  /// if isSign == true, it should be smallest signed value, otherwise zero.
-  /// @brief Gets min value of the APInt with bitwidth <= 64.
-  static APInt getMinValue(unsigned numBits, bool isSign);
+  /// @brief Signed greather than comparison
+  bool sgt(const APInt& RHS) const {
+    return !slt(RHS) && !eq(RHS);
+  }
 
-  /// @returns the all-ones value for an APInt of the specified bit-width.
-  /// @brief Get the all-ones value.
-  static APInt getAllOnesValue(unsigned numBits);
+  /// @brief Unsigned greater or equal comparison
+  bool uge(const APInt& RHS) const {
+    return !ult(RHS);
+  }
+
+  /// @brief Signed greather or equal comparison
+  bool sge(const APInt& RHS) const {
+    return !slt(RHS);
+  }
+
+  /// Arithmetic right-shift this APInt by shiftAmt.
+  /// @brief Arithmetic right-shift function.
+  APInt ashr(uint32_t shiftAmt) const;
+
+  /// Logical right-shift this APInt by shiftAmt.
+  /// @brief Logical right-shift function.
+  APInt lshr(uint32_t shiftAmt) const;
+
+  /// Left-shift this APInt by shiftAmt.
+  /// @brief Left-shift function.
+  APInt shl(uint32_t shiftAmt) const;
+
+  /// Signed divide this APInt by APInt RHS.
+  /// @brief Signed division function for APInt.
+  inline APInt sdiv(const APInt& RHS) const {
+    bool isNegativeLHS = (*this)[BitWidth - 1];
+    bool isNegativeRHS = RHS[RHS.BitWidth - 1];
+    APInt Result = APIntOps::udiv(
+        isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
+    return isNegativeLHS != isNegativeRHS ? -Result : Result;
+  }
+
+  /// Unsigned divide this APInt by APInt RHS.
+  /// @brief Unsigned division function for APInt.
+  APInt udiv(const APInt& RHS) const;
+
+  /// Signed remainder operation on APInt.
+  /// @brief Function for signed remainder operation.
+  inline APInt srem(const APInt& RHS) const {
+    bool isNegativeLHS = (*this)[BitWidth - 1];
+    bool isNegativeRHS = RHS[RHS.BitWidth - 1];
+    APInt Result = APIntOps::urem(
+        isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
+    return isNegativeLHS ? -Result : Result;
+  }
+
+  /// Unsigned remainder operation on APInt.
+  /// @brief Function for unsigned remainder operation.
+  APInt urem(const APInt& RHS) const;
+
+  /// Truncate the APInt to a specified width. It is an error to specify a width
+  /// that is greater than or equal to the current width. 
+  /// @brief Truncate to new width.
+  void trunc(uint32_t width);
+
+  /// This operation sign extends the APInt to a new width. If the high order
+  /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
+  /// It is an error to specify a width that is less than or equal to the 
+  /// current width.
+  /// @brief Sign extend to a new width.
+  void sext(uint32_t width);
+
+  /// This operation zero extends the APInt to a new width. Thie high order bits
+  /// are filled with 0 bits.  It is an error to specify a width that is less 
+  /// than or equal to the current width.
+  /// @brief Zero extend to a new width.
+  void zext(uint32_t width);
 
   /// @brief Set every bit to 1.
   APInt& set();
 
   /// Set the given bit to 1 whose position is given as "bitPosition".
   /// @brief Set a given bit to 1.
-  APInt& set(unsigned bitPosition);
-
-  /// @returns the '0' value for an APInt of the specified bit-width.
-  /// @brief Get the '0' value.
-  static APInt getNullValue(unsigned numBits);
+  APInt& set(uint32_t bitPosition);
 
   /// @brief Set every bit to 0.
   APInt& clear();
 
   /// Set the given bit to 0 whose position is given as "bitPosition".
   /// @brief Set a given bit to 0.
-  APInt& clear(unsigned bitPosition);
+  APInt& clear(uint32_t bitPosition);
 
   /// @brief Toggle every bit to its opposite value.
   APInt& flip();
@@ -339,79 +414,247 @@ public:
   /// Toggle a given bit to its opposite value whose position is given 
   /// as "bitPosition".
   /// @brief Toggles a given bit to its opposite value.
-  APInt& flip(unsigned bitPosition);
+  APInt& flip(uint32_t bitPosition);
+
+  /// This function returns the number of active bits which is defined as the
+  /// bit width minus the number of leading zeros. This is used in several
+  /// computations to see how "wide" the value is.
+  /// @brief Compute the number of active bits in the value
+  inline uint32_t getActiveBits() const {
+    return BitWidth - countLeadingZeros();
+  }
+
+  /// @returns a uint64_t value from this APInt. If this APInt contains a single
+  /// word, just returns VAL, otherwise pVal[0].
+  inline uint64_t getValue(bool isSigned = false) const {
+    if (isSingleWord())
+      return isSigned ? int64_t(VAL << (64 - BitWidth)) >> 
+                                       (64 - BitWidth) : VAL;
+    uint32_t n = getActiveBits();
+    if (n <= 64)
+      return pVal[0];
+    assert(0 && "This APInt's bitwidth > 64");
+  }
+
+  /// @returns the largest value for an APInt of the specified bit-width and 
+  /// if isSign == true, it should be largest signed value, otherwise largest
+  /// unsigned value.
+  /// @brief Gets max value of the APInt with bitwidth <= 64.
+  static APInt getMaxValue(uint32_t numBits, bool isSign);
+
+  /// @returns the smallest value for an APInt of the given bit-width and
+  /// if isSign == true, it should be smallest signed value, otherwise zero.
+  /// @brief Gets min value of the APInt with bitwidth <= 64.
+  static APInt getMinValue(uint32_t numBits, bool isSign);
+
+  /// @returns the all-ones value for an APInt of the specified bit-width.
+  /// @brief Get the all-ones value.
+  static APInt getAllOnesValue(uint32_t numBits);
+
+  /// @returns the '0' value for an APInt of the specified bit-width.
+  /// @brief Get the '0' value.
+  static APInt getNullValue(uint32_t numBits);
+
+  /// This converts the APInt to a boolean valy as a test against zero.
+  /// @brief Boolean conversion function. 
+  inline bool getBoolValue() const {
+    return countLeadingZeros() != BitWidth;
+  }
 
   /// @returns a character interpretation of the APInt.
-  std::string to_string(uint8_t radix = 10) const;
+  std::string toString(uint8_t radix = 10, bool wantSigned = true) const;
 
-  /// Get an APInt with the same bitsnum as this APInt, just zero mask
+  /// Get an APInt with the same BitWidth as this APInt, just zero mask
   /// the low bits and right shift to the least significant bit.
   /// @returns the high "numBits" bits of this APInt.
-  APInt HiBits(unsigned numBits) const;
+  APInt getHiBits(uint32_t numBits) const;
 
-  /// Get an APInt with the same bitsnum as this APInt, just zero mask
+  /// Get an APInt with the same BitWidth as this APInt, just zero mask
   /// the high bits.
   /// @returns the low "numBits" bits of this APInt.
-  APInt LoBits(unsigned numBits) const;
+  APInt getLoBits(uint32_t numBits) const;
 
   /// @returns true if the argument APInt value is a power of two > 0.
-  inline const bool isPowerOf2() const {
-    return (!!*this) && !(*this & (*this - 1));
-  }
+  bool isPowerOf2() const; 
 
   /// @returns the number of zeros from the most significant bit to the first
   /// one bits.
-  unsigned CountLeadingZeros() const;
+  uint32_t countLeadingZeros() const;
 
   /// @returns the number of zeros from the least significant bit to the first
   /// one bit.
-  unsigned CountTrailingZeros() const;
+  uint32_t countTrailingZeros() const;
 
   /// @returns the number of set bits.
-  unsigned CountPopulation() const; 
+  uint32_t countPopulation() const; 
 
   /// @returns the total number of bits.
-  inline unsigned getNumBits() const
-  { return bitsnum; }
+  inline uint32_t getBitWidth() const { 
+    return BitWidth; 
+  }
+
+  /// @brief Check if this APInt has a N-bits integer value.
+  inline bool isIntN(uint32_t N) const {
+    assert(N && "N == 0 ???");
+    if (isSingleWord()) {
+      return VAL == (VAL & (~0ULL >> (64 - N)));
+    } else {
+      APInt Tmp(N, getNumWords(), pVal);
+      return Tmp == (*this);
+    }
+  }
+
+  /// @returns a byte-swapped representation of this APInt Value.
+  APInt byteSwap() const;
+
+  /// @returns the floor log base 2 of this APInt.
+  inline uint32_t logBase2() const {
+    return getNumWords() * APINT_BITS_PER_WORD - 1 - countLeadingZeros();
+  }
+
+  /// @brief Converts this APInt to a double value.
+  double roundToDouble(bool isSigned = false) const;
 
 };
 
+namespace APIntOps {
+
 /// @brief Check if the specified APInt has a N-bits integer value.
-inline bool isIntN(unsigned N, const APInt& APIVal) {
-  if (APIVal.isSingleWord()) {
-    APInt Tmp(N, APIVal.VAL);
-    return Tmp == APIVal;
-  } else {
-    APInt Tmp(N, APIVal.pVal);
-    return Tmp == APIVal;
-  }
+inline bool isIntN(uint32_t N, const APInt& APIVal) {
+  return APIVal.isIntN(N);
 }
 
 /// @returns true if the argument APInt value is a sequence of ones
 /// starting at the least significant bit with the remainder zero.
-inline const bool isMask(unsigned numBits, const APInt& APIVal) {
-  return APIVal && ((APIVal + 1) & APIVal) == 0;
+inline const bool isMask(uint32_t numBits, const APInt& APIVal) {
+  return APIVal.getBoolValue() && ((APIVal + APInt(numBits,1)) & APIVal) == 0;
 }
 
 /// @returns true if the argument APInt value contains a sequence of ones
 /// with the remainder zero.
-inline const bool isShiftedMask(unsigned numBits, const APInt& APIVal) {
-  return isMask(numBits, (APIVal - 1) | APIVal);
+inline const bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
+  return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
 }
 
 /// @returns a byte-swapped representation of the specified APInt Value.
-APInt ByteSwap(const APInt& APIVal);
+inline APInt byteSwap(const APInt& APIVal) {
+  return APIVal.byteSwap();
+}
 
 /// @returns the floor log base 2 of the specified APInt value.
-inline APInt LogBase2(const APInt& APIVal) {
-  return APIVal.numWords() * APInt::APINT_BITS_PER_WORD - 
-         APIVal.CountLeadingZeros();
+inline uint32_t logBase2(const APInt& APIVal) {
+  return APIVal.logBase2(); 
 }
 
 /// @returns the greatest common divisor of the two values 
 /// using Euclid's algorithm.
 APInt GreatestCommonDivisor(const APInt& API1, const APInt& API2);
 
+/// @brief Converts the given APInt to a double value.
+inline double RoundAPIntToDouble(const APInt& APIVal, bool isSigned = false) {
+  return APIVal.roundToDouble(isSigned);
+}
+
+/// @brief Converts the given APInt to a float vlalue.
+inline float RoundAPIntToFloat(const APInt& APIVal) {
+  return float(RoundAPIntToDouble(APIVal));
+}
+
+/// @brief Converts the given double value into a APInt.
+APInt RoundDoubleToAPInt(double Double);
+
+/// @brief Converts the given float value into a APInt.
+inline APInt RoundFloatToAPInt(float Float) {
+  return RoundDoubleToAPInt(double(Float));
+}
+
+/// Arithmetic right-shift the APInt by shiftAmt.
+/// @brief Arithmetic right-shift function.
+inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
+  return LHS.ashr(shiftAmt);
+}
+
+/// Logical right-shift the APInt by shiftAmt.
+/// @brief Logical right-shift function.
+inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
+  return LHS.lshr(shiftAmt);
+}
+
+/// Left-shift the APInt by shiftAmt.
+/// @brief Left-shift function.
+inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
+  return LHS.shl(shiftAmt);
+}
+
+/// Signed divide APInt LHS by APInt RHS.
+/// @brief Signed division function for APInt.
+inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
+  return LHS.sdiv(RHS);
+}
+
+/// Unsigned divide APInt LHS by APInt RHS.
+/// @brief Unsigned division function for APInt.
+inline APInt udiv(const APInt& LHS, const APInt& RHS) {
+  return LHS.udiv(RHS);
+}
+
+/// Signed remainder operation on APInt.
+/// @brief Function for signed remainder operation.
+inline APInt srem(const APInt& LHS, const APInt& RHS) {
+  return LHS.srem(RHS);
+}
+
+/// Unsigned remainder operation on APInt.
+/// @brief Function for unsigned remainder operation.
+inline APInt urem(const APInt& LHS, const APInt& RHS) {
+  return LHS.urem(RHS);
+}
+
+/// Performs multiplication on APInt values.
+/// @brief Function for multiplication operation.
+inline APInt mul(const APInt& LHS, const APInt& RHS) {
+  return LHS * RHS;
+}
+
+/// Performs addition on APInt values.
+/// @brief Function for addition operation.
+inline APInt add(const APInt& LHS, const APInt& RHS) {
+  return LHS + RHS;
+}
+
+/// Performs subtraction on APInt values.
+/// @brief Function for subtraction operation.
+inline APInt sub(const APInt& LHS, const APInt& RHS) {
+  return LHS - RHS;
+}
+
+/// Performs bitwise AND operation on APInt LHS and 
+/// APInt RHS.
+/// @brief Bitwise AND function for APInt.
+inline APInt And(const APInt& LHS, const APInt& RHS) {
+  return LHS & RHS;
+}
+
+/// Performs bitwise OR operation on APInt LHS and APInt RHS.
+/// @brief Bitwise OR function for APInt. 
+inline APInt Or(const APInt& LHS, const APInt& RHS) {
+  return LHS | RHS;
+}
+
+/// Performs bitwise XOR operation on APInt.
+/// @brief Bitwise XOR function for APInt.
+inline APInt Xor(const APInt& LHS, const APInt& RHS) {
+  return LHS ^ RHS;
+} 
+
+/// Performs a bitwise complement operation on APInt.
+/// @brief Bitwise complement function. 
+inline APInt Not(const APInt& APIVal) {
+  return ~APIVal;
+}
+
+} // End of APIntOps namespace
+
 } // End of llvm namespace
 
 #endif