APInt.h

Go to the documentation of this file.

//===-- llvm/ADT/APInt.h - For Arbitrary Precision Integer -----*- C++ -*--===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file implements a class to represent arbitrary precision integral
// constant values and operations on them.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_APINT_H
#define LLVM_APINT_H

#include "llvm/ADT/ArrayRef.h"
#include "llvm/Support/MathExtras.h"
#include <cassert>
#include <climits>
#include <cstring>
#include <string>

namespace llvm {
  class Serializer;
  class Deserializer;
  class FoldingSetNodeID;
  class StringRef;

  template<typename T>
  class SmallVectorImpl;

  // An unsigned host type used as a single part of a multi-part
  // bignum.
  typedef uint64_t integerPart;

  const unsigned int host_char_bit = 8;
  const unsigned int integerPartWidth = host_char_bit *
    static_cast<unsigned int>(sizeof(integerPart));

//===----------------------------------------------------------------------===//
//                              APInt Class
//===----------------------------------------------------------------------===//

class APInt {
  unsigned BitWidth;      

  union {
    uint64_t VAL;    
    uint64_t *pVal;  
  };

  enum {
    APINT_BITS_PER_WORD = static_cast<unsigned int>(sizeof(uint64_t)) *
                          CHAR_BIT,
    APINT_WORD_SIZE = static_cast<unsigned int>(sizeof(uint64_t))
  };

  APInt(uint64_t* val, unsigned bits) : BitWidth(bits), pVal(val) { }

  bool isSingleWord() const {
    return BitWidth <= APINT_BITS_PER_WORD;
  }

  static unsigned whichWord(unsigned bitPosition) {
    return bitPosition / APINT_BITS_PER_WORD;
  }

  static unsigned whichBit(unsigned bitPosition) {
    return bitPosition % APINT_BITS_PER_WORD;
  }

  static uint64_t maskBit(unsigned bitPosition) {
    return 1ULL << whichBit(bitPosition);
  }

  APInt& clearUnusedBits() {
    // Compute how many bits are used in the final word
    unsigned wordBits = BitWidth % APINT_BITS_PER_WORD;
    if (wordBits == 0)
      // If all bits are used, we want to leave the value alone. This also
      // avoids the undefined behavior of >> when the shift is the same size as
      // the word size (64).
      return *this;

    // Mask out the high bits.
    uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
    if (isSingleWord())
      VAL &= mask;
    else
      pVal[getNumWords() - 1] &= mask;
    return *this;
  }

  uint64_t getWord(unsigned bitPosition) const {
    return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
  }

  void fromString(unsigned numBits, StringRef str, uint8_t radix);

  static void divide(const APInt LHS, unsigned lhsWords,
                     const APInt &RHS, unsigned rhsWords,
                     APInt *Quotient, APInt *Remainder);

  void initSlowCase(unsigned numBits, uint64_t val, bool isSigned);

  void initFromArray(ArrayRef<uint64_t> array);

  void initSlowCase(const APInt& that);

  APInt shlSlowCase(unsigned shiftAmt) const;

  APInt AndSlowCase(const APInt& RHS) const;

  APInt OrSlowCase(const APInt& RHS) const;

  APInt XorSlowCase(const APInt& RHS) const;

  APInt& AssignSlowCase(const APInt& RHS);

  bool EqualSlowCase(const APInt& RHS) const;

  bool EqualSlowCase(uint64_t Val) const;

  unsigned countLeadingZerosSlowCase() const;

  unsigned countTrailingOnesSlowCase() const;

  unsigned countPopulationSlowCase() const;

public:
  APInt(unsigned numBits, uint64_t val, bool isSigned = false)
    : BitWidth(numBits), VAL(0) {
    assert(BitWidth && "bitwidth too small");
    if (isSingleWord())
      VAL = val;
    else
      initSlowCase(numBits, val, isSigned);
    clearUnusedBits();
  }

  APInt(unsigned numBits, ArrayRef<uint64_t> bigVal);
  APInt(unsigned numBits, unsigned numWords, const uint64_t bigVal[]);

  APInt(unsigned numBits, StringRef str, uint8_t radix);

  APInt(const APInt& that)
    : BitWidth(that.BitWidth), VAL(0) {
    assert(BitWidth && "bitwidth too small");
    if (isSingleWord())
      VAL = that.VAL;
    else
      initSlowCase(that);
  }

  ~APInt() {
    if (!isSingleWord())
      delete [] pVal;
  }

  explicit APInt() : BitWidth(1) {}

  void Profile(FoldingSetNodeID& id) const;

  bool isNegative() const {
    return (*this)[BitWidth - 1];
  }

  bool isNonNegative() const {
    return !isNegative();
  }

  bool isStrictlyPositive() const {
    return isNonNegative() && !!*this;
  }

  bool isAllOnesValue() const {
    return countPopulation() == BitWidth;
  }

  bool isMaxValue() const {
    return countPopulation() == BitWidth;
  }

  bool isMaxSignedValue() const {
    return BitWidth == 1 ? VAL == 0 :
                          !isNegative() && countPopulation() == BitWidth - 1;
  }

  bool isMinValue() const {
    return !*this;
  }

  bool isMinSignedValue() const {
    return BitWidth == 1 ? VAL == 1 : isNegative() && isPowerOf2();
  }

  bool isIntN(unsigned N) const {
    assert(N && "N == 0 ???");
    if (N >= getBitWidth())
      return true;

    if (isSingleWord())
      return isUIntN(N, VAL);
    return APInt(N, makeArrayRef(pVal, getNumWords())).zext(getBitWidth())
      == (*this);
  }

  bool isSignedIntN(unsigned N) const {
    assert(N && "N == 0 ???");
    return getMinSignedBits() <= N;
  }

  bool isPowerOf2() const {
    if (isSingleWord())
      return isPowerOf2_64(VAL);
    return countPopulationSlowCase() == 1;
  }

  bool isSignBit() const { return isMinSignedValue(); }

  bool getBoolValue() const {
    return !!*this;
  }

  uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
    return (getActiveBits() > 64 || getZExtValue() > Limit) ?
      Limit :  getZExtValue();
  }

  static APInt getMaxValue(unsigned numBits) {
    return getAllOnesValue(numBits);
  }

  static APInt getSignedMaxValue(unsigned numBits) {
    APInt API = getAllOnesValue(numBits);
    API.clearBit(numBits - 1);
    return API;
  }

  static APInt getMinValue(unsigned numBits) {
    return APInt(numBits, 0);
  }

  static APInt getSignedMinValue(unsigned numBits) {
    APInt API(numBits, 0);
    API.setBit(numBits - 1);
    return API;
  }

  static APInt getSignBit(unsigned BitWidth) {
    return getSignedMinValue(BitWidth);
  }

  static APInt getAllOnesValue(unsigned numBits) {
    return APInt(numBits, -1ULL, true);
  }

  static APInt getNullValue(unsigned numBits) {
    return APInt(numBits, 0);
  }

  APInt getHiBits(unsigned numBits) const;

  APInt getLoBits(unsigned numBits) const;

  static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
    APInt Res(numBits, 0);
    Res.setBit(BitNo);
    return Res;
  }
  
  static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
    assert(hiBit <= numBits && "hiBit out of range");
    assert(loBit < numBits && "loBit out of range");
    if (hiBit < loBit)
      return getLowBitsSet(numBits, hiBit) |
             getHighBitsSet(numBits, numBits-loBit);
    return getLowBitsSet(numBits, hiBit-loBit).shl(loBit);
  }

  static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
    assert(hiBitsSet <= numBits && "Too many bits to set!");
    // Handle a degenerate case, to avoid shifting by word size
    if (hiBitsSet == 0)
      return APInt(numBits, 0);
    unsigned shiftAmt = numBits - hiBitsSet;
    // For small values, return quickly
    if (numBits <= APINT_BITS_PER_WORD)
      return APInt(numBits, ~0ULL << shiftAmt);
    return getAllOnesValue(numBits).shl(shiftAmt);
  }

  static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
    assert(loBitsSet <= numBits && "Too many bits to set!");
    // Handle a degenerate case, to avoid shifting by word size
    if (loBitsSet == 0)
      return APInt(numBits, 0);
    if (loBitsSet == APINT_BITS_PER_WORD)
      return APInt(numBits, -1ULL);
    // For small values, return quickly.
    if (numBits < APINT_BITS_PER_WORD)
      return APInt(numBits, (1ULL << loBitsSet) - 1);
    return getAllOnesValue(numBits).lshr(numBits - loBitsSet);
  }

  uint64_t getHashValue() const;

  const uint64_t* getRawData() const {
    if (isSingleWord())
      return &VAL;
    return &pVal[0];
  }

  const APInt operator++(int) {
    APInt API(*this);
    ++(*this);
    return API;
  }

  APInt& operator++();

  const APInt operator--(int) {
    APInt API(*this);
    --(*this);
    return API;
  }

  APInt& operator--();

  APInt operator~() const {
    APInt Result(*this);
    Result.flipAllBits();
    return Result;
  }

  APInt operator-() const {
    return APInt(BitWidth, 0) - (*this);
  }

  bool operator!() const;

  APInt& operator=(const APInt& RHS) {
    // If the bitwidths are the same, we can avoid mucking with memory
    if (isSingleWord() && RHS.isSingleWord()) {
      VAL = RHS.VAL;
      BitWidth = RHS.BitWidth;
      return clearUnusedBits();
    }

    return AssignSlowCase(RHS);
  }

  APInt& operator=(uint64_t RHS);

  APInt& operator&=(const APInt& RHS);

  APInt& operator|=(const APInt& RHS);

  APInt& operator|=(uint64_t RHS) {
    if (isSingleWord()) {
      VAL |= RHS;
      clearUnusedBits();
    } else {
      pVal[0] |= RHS;
    }
    return *this;
  }

  APInt& operator^=(const APInt& RHS);

  APInt& operator*=(const APInt& RHS);

  APInt& operator+=(const APInt& RHS);

  APInt& operator-=(const APInt& RHS);

  APInt& operator<<=(unsigned shiftAmt) {
    *this = shl(shiftAmt);
    return *this;
  }

  APInt operator&(const APInt& RHS) const {
    assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
    if (isSingleWord())
      return APInt(getBitWidth(), VAL & RHS.VAL);
    return AndSlowCase(RHS);
  }
  APInt And(const APInt& RHS) const {
    return this->operator&(RHS);
  }

  APInt operator|(const APInt& RHS) const {
    assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
    if (isSingleWord())
      return APInt(getBitWidth(), VAL | RHS.VAL);
    return OrSlowCase(RHS);
  }
  APInt Or(const APInt& RHS) const {
    return this->operator|(RHS);
  }

  APInt operator^(const APInt& RHS) const {
    assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
    if (isSingleWord())
      return APInt(BitWidth, VAL ^ RHS.VAL);
    return XorSlowCase(RHS);
  }
  APInt Xor(const APInt& RHS) const {
    return this->operator^(RHS);
  }

  APInt operator*(const APInt& RHS) const;

  APInt operator+(const APInt& RHS) const;
  APInt operator+(uint64_t RHS) const {
    return (*this) + APInt(BitWidth, RHS);
  }

  APInt operator-(const APInt& RHS) const;
  APInt operator-(uint64_t RHS) const {
    return (*this) - APInt(BitWidth, RHS);
  }

  APInt operator<<(unsigned Bits) const {
    return shl(Bits);
  }

  APInt operator<<(const APInt &Bits) const {
    return shl(Bits);
  }

  APInt ashr(unsigned shiftAmt) const;

  APInt lshr(unsigned shiftAmt) const;

  APInt shl(unsigned shiftAmt) const {
    assert(shiftAmt <= BitWidth && "Invalid shift amount");
    if (isSingleWord()) {
      if (shiftAmt == BitWidth)
        return APInt(BitWidth, 0); // avoid undefined shift results
      return APInt(BitWidth, VAL << shiftAmt);
    }
    return shlSlowCase(shiftAmt);
  }

  APInt rotl(unsigned rotateAmt) const;

  APInt rotr(unsigned rotateAmt) const;

  APInt ashr(const APInt &shiftAmt) const;

  APInt lshr(const APInt &shiftAmt) const;

  APInt shl(const APInt &shiftAmt) const;

  APInt rotl(const APInt &rotateAmt) const;

  APInt rotr(const APInt &rotateAmt) const;

  APInt udiv(const APInt &RHS) const;

  APInt sdiv(const APInt &RHS) const {
    if (isNegative())
      if (RHS.isNegative())
        return (-(*this)).udiv(-RHS);
      else
        return -((-(*this)).udiv(RHS));
    else if (RHS.isNegative())
      return -(this->udiv(-RHS));
    return this->udiv(RHS);
  }

  APInt urem(const APInt &RHS) const;

  APInt srem(const APInt &RHS) const {
    if (isNegative())
      if (RHS.isNegative())
        return -((-(*this)).urem(-RHS));
      else
        return -((-(*this)).urem(RHS));
    else if (RHS.isNegative())
      return this->urem(-RHS);
    return this->urem(RHS);
  }

  static void udivrem(const APInt &LHS, const APInt &RHS,
                      APInt &Quotient, APInt &Remainder);

  static void sdivrem(const APInt &LHS, const APInt &RHS,
                      APInt &Quotient, APInt &Remainder) {
    if (LHS.isNegative()) {
      if (RHS.isNegative())
        APInt::udivrem(-LHS, -RHS, Quotient, Remainder);
      else
        APInt::udivrem(-LHS, RHS, Quotient, Remainder);
      Quotient = -Quotient;
      Remainder = -Remainder;
    } else if (RHS.isNegative()) {
      APInt::udivrem(LHS, -RHS, Quotient, Remainder);
      Quotient = -Quotient;
    } else {
      APInt::udivrem(LHS, RHS, Quotient, Remainder);
    }
  }
  
  
  // Operations that return overflow indicators.
  APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
  APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
  APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
  APInt usub_ov(const APInt &RHS, bool &Overflow) const;
  APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
  APInt smul_ov(const APInt &RHS, bool &Overflow) const;
  APInt umul_ov(const APInt &RHS, bool &Overflow) const;
  APInt sshl_ov(unsigned Amt, bool &Overflow) const;

  bool operator[](unsigned bitPosition) const;

  bool operator==(const APInt& RHS) const {
    assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
    if (isSingleWord())
      return VAL == RHS.VAL;
    return EqualSlowCase(RHS);
  }

  bool operator==(uint64_t Val) const {
    if (isSingleWord())
      return VAL == Val;
    return EqualSlowCase(Val);
  }

  bool eq(const APInt &RHS) const {
    return (*this) == RHS;
  }

  bool operator!=(const APInt& RHS) const {
    return !((*this) == RHS);
  }

  bool operator!=(uint64_t Val) const {
    return !((*this) == Val);
  }

  bool ne(const APInt &RHS) const {
    return !((*this) == RHS);
  }

  bool ult(const APInt &RHS) const;

  bool ult(uint64_t RHS) const {
    return ult(APInt(getBitWidth(), RHS));
  }

  bool slt(const APInt& RHS) const;

  bool slt(uint64_t RHS) const {
    return slt(APInt(getBitWidth(), RHS));
  }

  bool ule(const APInt& RHS) const {
    return ult(RHS) || eq(RHS);
  }

  bool ule(uint64_t RHS) const {
    return ule(APInt(getBitWidth(), RHS));
  }

  bool sle(const APInt& RHS) const {
    return slt(RHS) || eq(RHS);
  }

  bool sle(uint64_t RHS) const {
    return sle(APInt(getBitWidth(), RHS));
  }

  bool ugt(const APInt& RHS) const {
    return !ult(RHS) && !eq(RHS);
  }

  bool ugt(uint64_t RHS) const {
    return ugt(APInt(getBitWidth(), RHS));
  }

  bool sgt(const APInt& RHS) const {
    return !slt(RHS) && !eq(RHS);
  }

  bool sgt(uint64_t RHS) const {
    return sgt(APInt(getBitWidth(), RHS));
  }

  bool uge(const APInt& RHS) const {
    return !ult(RHS);
  }

  bool uge(uint64_t RHS) const {
    return uge(APInt(getBitWidth(), RHS));
  }

  bool sge(const APInt& RHS) const {
    return !slt(RHS);
  }

  bool sge(uint64_t RHS) const {
    return sge(APInt(getBitWidth(), RHS));
  }

  
  
  
  bool intersects(const APInt &RHS) const {
    return (*this & RHS) != 0;
  }

  APInt trunc(unsigned width) const;

  APInt sext(unsigned width) const;

  APInt zext(unsigned width) const;

  APInt sextOrTrunc(unsigned width) const;

  APInt zextOrTrunc(unsigned width) const;

  void setAllBits() {
    if (isSingleWord())
      VAL = -1ULL;
    else {
      // Set all the bits in all the words.
      for (unsigned i = 0; i < getNumWords(); ++i)
        pVal[i] = -1ULL;
    }
    // Clear the unused ones
    clearUnusedBits();
  }

  void setBit(unsigned bitPosition);

  void clearAllBits() {
    if (isSingleWord())
      VAL = 0;
    else
      memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
  }

  void clearBit(unsigned bitPosition);

  void flipAllBits() {
    if (isSingleWord())
      VAL ^= -1ULL;
    else {
      for (unsigned i = 0; i < getNumWords(); ++i)
        pVal[i] ^= -1ULL;
    }
    clearUnusedBits();
  }

  void flipBit(unsigned bitPosition);


  unsigned getBitWidth() const {
    return BitWidth;
  }

  unsigned getNumWords() const {
    return getNumWords(BitWidth);
  }

  static unsigned getNumWords(unsigned BitWidth) {
    return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
  }

  unsigned getActiveBits() const {
    return BitWidth - countLeadingZeros();
  }

  unsigned getActiveWords() const {
    return whichWord(getActiveBits()-1) + 1;
  }

  unsigned getMinSignedBits() const {
    if (isNegative())
      return BitWidth - countLeadingOnes() + 1;
    return getActiveBits()+1;
  }

  uint64_t getZExtValue() const {
    if (isSingleWord())
      return VAL;
    assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
    return pVal[0];
  }

  int64_t getSExtValue() const {
    if (isSingleWord())
      return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
                     (APINT_BITS_PER_WORD - BitWidth);
    assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
    return int64_t(pVal[0]);
  }

  static unsigned getBitsNeeded(StringRef str, uint8_t radix);

  unsigned countLeadingZeros() const {
    if (isSingleWord()) {
      unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
      return CountLeadingZeros_64(VAL) - unusedBits;
    }
    return countLeadingZerosSlowCase();
  }

  unsigned countLeadingOnes() const;

  unsigned getNumSignBits() const {
    return isNegative() ? countLeadingOnes() : countLeadingZeros();
  }

  unsigned countTrailingZeros() const;

  unsigned countTrailingOnes() const {
    if (isSingleWord())
      return CountTrailingOnes_64(VAL);
    return countTrailingOnesSlowCase();
  }

  unsigned countPopulation() const {
    if (isSingleWord())
      return CountPopulation_64(VAL);
    return countPopulationSlowCase();
  }

  void print(std::ostream &OS, bool isSigned) const;

  void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
                bool formatAsCLiteral = false) const;

  void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
    toString(Str, Radix, false, false);
  }

  void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
    toString(Str, Radix, true, false);
  }

  std::string toString(unsigned Radix, bool Signed) const;


  APInt byteSwap() const;

  double roundToDouble(bool isSigned) const;

  double roundToDouble() const {
    return roundToDouble(false);
  }

  double signedRoundToDouble() const {
    return roundToDouble(true);
  }

  double bitsToDouble() const {
    union {
      uint64_t I;
      double D;
    } T;
    T.I = (isSingleWord() ? VAL : pVal[0]);
    return T.D;
  }

  float bitsToFloat() const {
    union {
      unsigned I;
      float F;
    } T;
    T.I = unsigned((isSingleWord() ? VAL : pVal[0]));
    return T.F;
  }

  static APInt doubleToBits(double V) {
    union {
      uint64_t I;
      double D;
    } T;
    T.D = V;
    return APInt(sizeof T * CHAR_BIT, T.I);
  }

  static APInt floatToBits(float V) {
    union {
      unsigned I;
      float F;
    } T;
    T.F = V;
    return APInt(sizeof T * CHAR_BIT, T.I);
  }


  unsigned logBase2() const {
    return BitWidth - 1 - countLeadingZeros();
  }

  unsigned ceilLogBase2() const {
    return BitWidth - (*this - 1).countLeadingZeros();
  }

  int32_t exactLogBase2() const {
    if (!isPowerOf2())
      return -1;
    return logBase2();
  }

  APInt sqrt() const;

  APInt abs() const {
    if (isNegative())
      return -(*this);
    return *this;
  }

  APInt multiplicativeInverse(const APInt& modulo) const;


  struct ms;
  ms magic() const;

  struct mu;
  mu magicu(unsigned LeadingZeros = 0) const;


  // These building block operations operate on a representation of
  // arbitrary precision, two's-complement, bignum integer values.
  // They should be sufficient to implement APInt and APFloat bignum
  // requirements.  Inputs are generally a pointer to the base of an
  // array of integer parts, representing an unsigned bignum, and a
  // count of how many parts there are.

  static void tcSet(integerPart *, integerPart, unsigned int);

  static void tcAssign(integerPart *, const integerPart *, unsigned int);

  static bool tcIsZero(const integerPart *, unsigned int);

  static int tcExtractBit(const integerPart *, unsigned int bit);

  static void tcExtract(integerPart *, unsigned int dstCount,
                        const integerPart *,
                        unsigned int srcBits, unsigned int srcLSB);

  static void tcSetBit(integerPart *, unsigned int bit);

  static void tcClearBit(integerPart *, unsigned int bit);

  static unsigned int tcLSB(const integerPart *, unsigned int);
  static unsigned int tcMSB(const integerPart *parts, unsigned int n);

  static void tcNegate(integerPart *, unsigned int);

  static integerPart tcAdd(integerPart *, const integerPart *,
                           integerPart carry, unsigned);

  static integerPart tcSubtract(integerPart *, const integerPart *,
                                integerPart carry, unsigned);

  static int tcMultiplyPart(integerPart *dst, const integerPart *src,
                            integerPart multiplier, integerPart carry,
                            unsigned int srcParts, unsigned int dstParts,
                            bool add);

  static int tcMultiply(integerPart *, const integerPart *,
                        const integerPart *, unsigned);

  static unsigned int tcFullMultiply(integerPart *, const integerPart *,
                                     const integerPart *, unsigned, unsigned);

  static int tcDivide(integerPart *lhs, const integerPart *rhs,
                      integerPart *remainder, integerPart *scratch,
                      unsigned int parts);

  static void tcShiftLeft(integerPart *, unsigned int parts,
                          unsigned int count);

  static void tcShiftRight(integerPart *, unsigned int parts,
                           unsigned int count);

  static void tcAnd(integerPart *, const integerPart *, unsigned int);
  static void tcOr(integerPart *, const integerPart *, unsigned int);
  static void tcXor(integerPart *, const integerPart *, unsigned int);
  static void tcComplement(integerPart *, unsigned int);

  static int tcCompare(const integerPart *, const integerPart *,
                       unsigned int);

  static integerPart tcIncrement(integerPart *, unsigned int);

  static void tcSetLeastSignificantBits(integerPart *, unsigned int,
                                        unsigned int bits);

  void dump() const;

};

struct APInt::ms {
  APInt m;  
  unsigned s;  
};

struct APInt::mu {
  APInt m;     
  bool a;      
  unsigned s;  
};

inline bool operator==(uint64_t V1, const APInt& V2) {
  return V2 == V1;
}

inline bool operator!=(uint64_t V1, const APInt& V2) {
  return V2 != V1;
}

inline std::ostream &operator<<(std::ostream &OS, const APInt &I) {
  I.print(OS, true);
  return OS;
}

namespace APIntOps {

inline APInt smin(const APInt &A, const APInt &B) {
  return A.slt(B) ? A : B;
}

inline APInt smax(const APInt &A, const APInt &B) {
  return A.sgt(B) ? A : B;
}

inline APInt umin(const APInt &A, const APInt &B) {
  return A.ult(B) ? A : B;
}

inline APInt umax(const APInt &A, const APInt &B) {
  return A.ugt(B) ? A : B;
}

inline bool isIntN(unsigned N, const APInt& APIVal) {
  return APIVal.isIntN(N);
}

inline bool isSignedIntN(unsigned N, const APInt& APIVal) {
  return APIVal.isSignedIntN(N);
}

inline bool isMask(unsigned numBits, const APInt& APIVal) {
  return numBits <= APIVal.getBitWidth() &&
    APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
}

inline bool isShiftedMask(unsigned numBits, const APInt& APIVal) {
  return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
}

inline APInt byteSwap(const APInt& APIVal) {
  return APIVal.byteSwap();
}

inline unsigned logBase2(const APInt& APIVal) {
  return APIVal.logBase2();
}

APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);

inline double RoundAPIntToDouble(const APInt& APIVal) {
  return APIVal.roundToDouble();
}

inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
  return APIVal.signedRoundToDouble();
}

inline float RoundAPIntToFloat(const APInt& APIVal) {
  return float(RoundAPIntToDouble(APIVal));
}

inline float RoundSignedAPIntToFloat(const APInt& APIVal) {
  return float(APIVal.signedRoundToDouble());
}

APInt RoundDoubleToAPInt(double Double, unsigned width);

inline APInt RoundFloatToAPInt(float Float, unsigned width) {
  return RoundDoubleToAPInt(double(Float), width);
}

inline APInt ashr(const APInt& LHS, unsigned shiftAmt) {
  return LHS.ashr(shiftAmt);
}

inline APInt lshr(const APInt& LHS, unsigned shiftAmt) {
  return LHS.lshr(shiftAmt);
}

inline APInt shl(const APInt& LHS, unsigned shiftAmt) {
  return LHS.shl(shiftAmt);
}

inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
  return LHS.sdiv(RHS);
}

inline APInt udiv(const APInt& LHS, const APInt& RHS) {
  return LHS.udiv(RHS);
}

inline APInt srem(const APInt& LHS, const APInt& RHS) {
  return LHS.srem(RHS);
}

inline APInt urem(const APInt& LHS, const APInt& RHS) {
  return LHS.urem(RHS);
}

inline APInt mul(const APInt& LHS, const APInt& RHS) {
  return LHS * RHS;
}

inline APInt add(const APInt& LHS, const APInt& RHS) {
  return LHS + RHS;
}

inline APInt sub(const APInt& LHS, const APInt& RHS) {
  return LHS - RHS;
}

inline APInt And(const APInt& LHS, const APInt& RHS) {
  return LHS & RHS;
}

inline APInt Or(const APInt& LHS, const APInt& RHS) {
  return LHS | RHS;
}

inline APInt Xor(const APInt& LHS, const APInt& RHS) {
  return LHS ^ RHS;
}

inline APInt Not(const APInt& APIVal) {
  return ~APIVal;
}

} // End of APIntOps namespace

} // End of llvm namespace

#endif

---