1 //===-- llvm/ADT/APInt.h - For Arbitrary Precision Integer -----*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a class to represent arbitrary precision integral
11 // constant values and operations on them.
13 //===----------------------------------------------------------------------===//
18 #include "llvm/Support/DataTypes.h"
19 #include "llvm/Support/MathExtras.h"
27 class FoldingSetNodeID;
31 class SmallVectorImpl;
33 /* An unsigned host type used as a single part of a multi-part
35 typedef uint64_t integerPart;
37 const unsigned int host_char_bit = 8;
38 const unsigned int integerPartWidth = host_char_bit *
39 static_cast<unsigned int>(sizeof(integerPart));
41 //===----------------------------------------------------------------------===//
43 //===----------------------------------------------------------------------===//
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
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
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.
70 /// @brief Class for arbitrary precision integers.
72 uint32_t BitWidth; ///< The number of bits in this APInt.
74 /// This union is used to store the integer value. When the
75 /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
77 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
78 uint64_t *pVal; ///< Used to store the >64 bits integer value.
81 /// This enum is used to hold the constants we needed for APInt.
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))
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) { }
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;
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;
106 /// @returns the bit position in a word for the specified bit position
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;
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);
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
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;
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).
136 // Mask out the high bits.
137 uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
141 pVal[getNumWords() - 1] &= mask;
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)];
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,
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);
165 /// out-of-line slow case for inline constructor
166 void initSlowCase(uint32_t numBits, uint64_t val, bool isSigned);
168 /// out-of-line slow case for inline copy constructor
169 void initSlowCase(const APInt& that);
171 /// out-of-line slow case for shl
172 APInt shlSlowCase(uint32_t shiftAmt) const;
174 /// out-of-line slow case for operator&
175 APInt AndSlowCase(const APInt& RHS) const;
177 /// out-of-line slow case for operator|
178 APInt OrSlowCase(const APInt& RHS) const;
180 /// out-of-line slow case for operator^
181 APInt XorSlowCase(const APInt& RHS) const;
183 /// out-of-line slow case for operator=
184 APInt& AssignSlowCase(const APInt& RHS);
186 /// out-of-line slow case for operator==
187 bool EqualSlowCase(const APInt& RHS) const;
189 /// out-of-line slow case for operator==
190 bool EqualSlowCase(uint64_t Val) const;
192 /// out-of-line slow case for countLeadingZeros
193 uint32_t countLeadingZerosSlowCase() const;
195 /// out-of-line slow case for countTrailingOnes
196 uint32_t countTrailingOnesSlowCase() const;
198 /// out-of-line slow case for countPopulation
199 uint32_t countPopulationSlowCase() const;
202 /// @name Constructors
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");
218 initSlowCase(numBits, val, isSigned);
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[]);
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);
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");
253 /// @brief Destructor.
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) {}
263 /// Profile - Used to insert APInt objects, or objects that contain APInt
264 /// objects, into FoldingSets.
265 void Profile(FoldingSetNodeID& id) const;
267 /// @brief Used by the Bitcode serializer to emit APInts to Bitcode.
268 void Emit(Serializer& S) const;
270 /// @brief Used by the Bitcode deserializer to deserialize APInts.
271 void Read(Deserializer& D);
274 /// @name Value Tests
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];
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();
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;
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;
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;
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;
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;
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;
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 (N >= getBitWidth())
340 return VAL == (VAL & (~0ULL >> (64 - N)));
341 APInt Tmp(N, getNumWords(), pVal);
342 Tmp.zext(getBitWidth());
343 return Tmp == (*this);
346 /// @brief Check if this APInt has an N-bits signed integer value.
347 bool isSignedIntN(uint32_t N) const {
348 assert(N && "N == 0 ???");
349 return getMinSignedBits() <= N;
352 /// @returns true if the argument APInt value is a power of two > 0.
353 bool isPowerOf2() const;
355 /// isSignBit - Return true if this is the value returned by getSignBit.
356 bool isSignBit() const { return isMinSignedValue(); }
358 /// This converts the APInt to a boolean value as a test against zero.
359 /// @brief Boolean conversion function.
360 bool getBoolValue() const {
364 /// getLimitedValue - If this value is smaller than the specified limit,
365 /// return it, otherwise return the limit value. This causes the value
366 /// to saturate to the limit.
367 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
368 return (getActiveBits() > 64 || getZExtValue() > Limit) ?
369 Limit : getZExtValue();
373 /// @name Value Generators
375 /// @brief Gets maximum unsigned value of APInt for specific bit width.
376 static APInt getMaxValue(uint32_t numBits) {
377 return APInt(numBits, 0).set();
380 /// @brief Gets maximum signed value of APInt for a specific bit width.
381 static APInt getSignedMaxValue(uint32_t numBits) {
382 return APInt(numBits, 0).set().clear(numBits - 1);
385 /// @brief Gets minimum unsigned value of APInt for a specific bit width.
386 static APInt getMinValue(uint32_t numBits) {
387 return APInt(numBits, 0);
390 /// @brief Gets minimum signed value of APInt for a specific bit width.
391 static APInt getSignedMinValue(uint32_t numBits) {
392 return APInt(numBits, 0).set(numBits - 1);
395 /// getSignBit - This is just a wrapper function of getSignedMinValue(), and
396 /// it helps code readability when we want to get a SignBit.
397 /// @brief Get the SignBit for a specific bit width.
398 static APInt getSignBit(uint32_t BitWidth) {
399 return getSignedMinValue(BitWidth);
402 /// @returns the all-ones value for an APInt of the specified bit-width.
403 /// @brief Get the all-ones value.
404 static APInt getAllOnesValue(uint32_t numBits) {
405 return APInt(numBits, 0).set();
408 /// @returns the '0' value for an APInt of the specified bit-width.
409 /// @brief Get the '0' value.
410 static APInt getNullValue(uint32_t numBits) {
411 return APInt(numBits, 0);
414 /// Get an APInt with the same BitWidth as this APInt, just zero mask
415 /// the low bits and right shift to the least significant bit.
416 /// @returns the high "numBits" bits of this APInt.
417 APInt getHiBits(uint32_t numBits) const;
419 /// Get an APInt with the same BitWidth as this APInt, just zero mask
421 /// @returns the low "numBits" bits of this APInt.
422 APInt getLoBits(uint32_t numBits) const;
424 /// Constructs an APInt value that has a contiguous range of bits set. The
425 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
426 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
427 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
428 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
429 /// @param numBits the intended bit width of the result
430 /// @param loBit the index of the lowest bit set.
431 /// @param hiBit the index of the highest bit set.
432 /// @returns An APInt value with the requested bits set.
433 /// @brief Get a value with a block of bits set.
434 static APInt getBitsSet(uint32_t numBits, uint32_t loBit, uint32_t hiBit) {
435 assert(hiBit <= numBits && "hiBit out of range");
436 assert(loBit < numBits && "loBit out of range");
438 return getLowBitsSet(numBits, hiBit) |
439 getHighBitsSet(numBits, numBits-loBit);
440 return getLowBitsSet(numBits, hiBit-loBit).shl(loBit);
443 /// Constructs an APInt value that has the top hiBitsSet bits set.
444 /// @param numBits the bitwidth of the result
445 /// @param hiBitsSet the number of high-order bits set in the result.
446 /// @brief Get a value with high bits set
447 static APInt getHighBitsSet(uint32_t numBits, uint32_t hiBitsSet) {
448 assert(hiBitsSet <= numBits && "Too many bits to set!");
449 // Handle a degenerate case, to avoid shifting by word size
451 return APInt(numBits, 0);
452 uint32_t shiftAmt = numBits - hiBitsSet;
453 // For small values, return quickly
454 if (numBits <= APINT_BITS_PER_WORD)
455 return APInt(numBits, ~0ULL << shiftAmt);
456 return (~APInt(numBits, 0)).shl(shiftAmt);
459 /// Constructs an APInt value that has the bottom loBitsSet bits set.
460 /// @param numBits the bitwidth of the result
461 /// @param loBitsSet the number of low-order bits set in the result.
462 /// @brief Get a value with low bits set
463 static APInt getLowBitsSet(uint32_t numBits, uint32_t loBitsSet) {
464 assert(loBitsSet <= numBits && "Too many bits to set!");
465 // Handle a degenerate case, to avoid shifting by word size
467 return APInt(numBits, 0);
468 if (loBitsSet == APINT_BITS_PER_WORD)
469 return APInt(numBits, -1ULL);
470 // For small values, return quickly.
471 if (numBits < APINT_BITS_PER_WORD)
472 return APInt(numBits, (1ULL << loBitsSet) - 1);
473 return (~APInt(numBits, 0)).lshr(numBits - loBitsSet);
476 /// The hash value is computed as the sum of the words and the bit width.
477 /// @returns A hash value computed from the sum of the APInt words.
478 /// @brief Get a hash value based on this APInt
479 uint64_t getHashValue() const;
481 /// This function returns a pointer to the internal storage of the APInt.
482 /// This is useful for writing out the APInt in binary form without any
484 const uint64_t* getRawData() const {
491 /// @name Unary Operators
493 /// @returns a new APInt value representing *this incremented by one
494 /// @brief Postfix increment operator.
495 const APInt operator++(int) {
501 /// @returns *this incremented by one
502 /// @brief Prefix increment operator.
505 /// @returns a new APInt representing *this decremented by one.
506 /// @brief Postfix decrement operator.
507 const APInt operator--(int) {
513 /// @returns *this decremented by one.
514 /// @brief Prefix decrement operator.
517 /// Performs a bitwise complement operation on this APInt.
518 /// @returns an APInt that is the bitwise complement of *this
519 /// @brief Unary bitwise complement operator.
520 APInt operator~() const {
526 /// Negates *this using two's complement logic.
527 /// @returns An APInt value representing the negation of *this.
528 /// @brief Unary negation operator
529 APInt operator-() const {
530 return APInt(BitWidth, 0) - (*this);
533 /// Performs logical negation operation on this APInt.
534 /// @returns true if *this is zero, false otherwise.
535 /// @brief Logical negation operator.
536 bool operator!() const;
539 /// @name Assignment Operators
541 /// @returns *this after assignment of RHS.
542 /// @brief Copy assignment operator.
543 APInt& operator=(const APInt& RHS) {
544 // If the bitwidths are the same, we can avoid mucking with memory
545 if (isSingleWord() && RHS.isSingleWord()) {
547 BitWidth = RHS.BitWidth;
548 return clearUnusedBits();
551 return AssignSlowCase(RHS);
554 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
555 /// the bit width, the excess bits are truncated. If the bit width is larger
556 /// than 64, the value is zero filled in the unspecified high order bits.
557 /// @returns *this after assignment of RHS value.
558 /// @brief Assignment operator.
559 APInt& operator=(uint64_t RHS);
561 /// Performs a bitwise AND operation on this APInt and RHS. The result is
562 /// assigned to *this.
563 /// @returns *this after ANDing with RHS.
564 /// @brief Bitwise AND assignment operator.
565 APInt& operator&=(const APInt& RHS);
567 /// Performs a bitwise OR operation on this APInt and RHS. The result is
569 /// @returns *this after ORing with RHS.
570 /// @brief Bitwise OR assignment operator.
571 APInt& operator|=(const APInt& RHS);
573 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
574 /// assigned to *this.
575 /// @returns *this after XORing with RHS.
576 /// @brief Bitwise XOR assignment operator.
577 APInt& operator^=(const APInt& RHS);
579 /// Multiplies this APInt by RHS and assigns the result to *this.
581 /// @brief Multiplication assignment operator.
582 APInt& operator*=(const APInt& RHS);
584 /// Adds RHS to *this and assigns the result to *this.
586 /// @brief Addition assignment operator.
587 APInt& operator+=(const APInt& RHS);
589 /// Subtracts RHS from *this and assigns the result to *this.
591 /// @brief Subtraction assignment operator.
592 APInt& operator-=(const APInt& RHS);
594 /// Shifts *this left by shiftAmt and assigns the result to *this.
595 /// @returns *this after shifting left by shiftAmt
596 /// @brief Left-shift assignment function.
597 APInt& operator<<=(uint32_t shiftAmt) {
598 *this = shl(shiftAmt);
603 /// @name Binary Operators
605 /// Performs a bitwise AND operation on *this and RHS.
606 /// @returns An APInt value representing the bitwise AND of *this and RHS.
607 /// @brief Bitwise AND operator.
608 APInt operator&(const APInt& RHS) const {
609 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
611 return APInt(getBitWidth(), VAL & RHS.VAL);
612 return AndSlowCase(RHS);
614 APInt And(const APInt& RHS) const {
615 return this->operator&(RHS);
618 /// Performs a bitwise OR operation on *this and RHS.
619 /// @returns An APInt value representing the bitwise OR of *this and RHS.
620 /// @brief Bitwise OR operator.
621 APInt operator|(const APInt& RHS) const {
622 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
624 return APInt(getBitWidth(), VAL | RHS.VAL);
625 return OrSlowCase(RHS);
627 APInt Or(const APInt& RHS) const {
628 return this->operator|(RHS);
631 /// Performs a bitwise XOR operation on *this and RHS.
632 /// @returns An APInt value representing the bitwise XOR of *this and RHS.
633 /// @brief Bitwise XOR operator.
634 APInt operator^(const APInt& RHS) const {
635 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
637 return APInt(BitWidth, VAL ^ RHS.VAL);
638 return XorSlowCase(RHS);
640 APInt Xor(const APInt& RHS) const {
641 return this->operator^(RHS);
644 /// Multiplies this APInt by RHS and returns the result.
645 /// @brief Multiplication operator.
646 APInt operator*(const APInt& RHS) const;
648 /// Adds RHS to this APInt and returns the result.
649 /// @brief Addition operator.
650 APInt operator+(const APInt& RHS) const;
651 APInt operator+(uint64_t RHS) const {
652 return (*this) + APInt(BitWidth, RHS);
655 /// Subtracts RHS from this APInt and returns the result.
656 /// @brief Subtraction operator.
657 APInt operator-(const APInt& RHS) const;
658 APInt operator-(uint64_t RHS) const {
659 return (*this) - APInt(BitWidth, RHS);
662 APInt operator<<(unsigned Bits) const {
666 APInt operator<<(const APInt &Bits) const {
670 /// Arithmetic right-shift this APInt by shiftAmt.
671 /// @brief Arithmetic right-shift function.
672 APInt ashr(uint32_t shiftAmt) const;
674 /// Logical right-shift this APInt by shiftAmt.
675 /// @brief Logical right-shift function.
676 APInt lshr(uint32_t shiftAmt) const;
678 /// Left-shift this APInt by shiftAmt.
679 /// @brief Left-shift function.
680 APInt shl(uint32_t shiftAmt) const {
681 assert(shiftAmt <= BitWidth && "Invalid shift amount");
682 if (isSingleWord()) {
683 if (shiftAmt == BitWidth)
684 return APInt(BitWidth, 0); // avoid undefined shift results
685 return APInt(BitWidth, VAL << shiftAmt);
687 return shlSlowCase(shiftAmt);
690 /// @brief Rotate left by rotateAmt.
691 APInt rotl(uint32_t rotateAmt) const;
693 /// @brief Rotate right by rotateAmt.
694 APInt rotr(uint32_t rotateAmt) const;
696 /// Arithmetic right-shift this APInt by shiftAmt.
697 /// @brief Arithmetic right-shift function.
698 APInt ashr(const APInt &shiftAmt) const;
700 /// Logical right-shift this APInt by shiftAmt.
701 /// @brief Logical right-shift function.
702 APInt lshr(const APInt &shiftAmt) const;
704 /// Left-shift this APInt by shiftAmt.
705 /// @brief Left-shift function.
706 APInt shl(const APInt &shiftAmt) const;
708 /// @brief Rotate left by rotateAmt.
709 APInt rotl(const APInt &rotateAmt) const;
711 /// @brief Rotate right by rotateAmt.
712 APInt rotr(const APInt &rotateAmt) const;
714 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
715 /// RHS are treated as unsigned quantities for purposes of this division.
716 /// @returns a new APInt value containing the division result
717 /// @brief Unsigned division operation.
718 APInt udiv(const APInt& RHS) const;
720 /// Signed divide this APInt by APInt RHS.
721 /// @brief Signed division function for APInt.
722 APInt sdiv(const APInt& RHS) const {
724 if (RHS.isNegative())
725 return (-(*this)).udiv(-RHS);
727 return -((-(*this)).udiv(RHS));
728 else if (RHS.isNegative())
729 return -(this->udiv(-RHS));
730 return this->udiv(RHS);
733 /// Perform an unsigned remainder operation on this APInt with RHS being the
734 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
735 /// of this operation. Note that this is a true remainder operation and not
736 /// a modulo operation because the sign follows the sign of the dividend
738 /// @returns a new APInt value containing the remainder result
739 /// @brief Unsigned remainder operation.
740 APInt urem(const APInt& RHS) const;
742 /// Signed remainder operation on APInt.
743 /// @brief Function for signed remainder operation.
744 APInt srem(const APInt& RHS) const {
746 if (RHS.isNegative())
747 return -((-(*this)).urem(-RHS));
749 return -((-(*this)).urem(RHS));
750 else if (RHS.isNegative())
751 return this->urem(-RHS);
752 return this->urem(RHS);
755 /// Sometimes it is convenient to divide two APInt values and obtain both the
756 /// quotient and remainder. This function does both operations in the same
757 /// computation making it a little more efficient. The pair of input arguments
758 /// may overlap with the pair of output arguments. It is safe to call
759 /// udivrem(X, Y, X, Y), for example.
760 /// @brief Dual division/remainder interface.
761 static void udivrem(const APInt &LHS, const APInt &RHS,
762 APInt &Quotient, APInt &Remainder);
764 static void sdivrem(const APInt &LHS, const APInt &RHS,
765 APInt &Quotient, APInt &Remainder)
767 if (LHS.isNegative()) {
768 if (RHS.isNegative())
769 APInt::udivrem(-LHS, -RHS, Quotient, Remainder);
771 APInt::udivrem(-LHS, RHS, Quotient, Remainder);
772 Quotient = -Quotient;
773 Remainder = -Remainder;
774 } else if (RHS.isNegative()) {
775 APInt::udivrem(LHS, -RHS, Quotient, Remainder);
776 Quotient = -Quotient;
778 APInt::udivrem(LHS, RHS, Quotient, Remainder);
782 /// @returns the bit value at bitPosition
783 /// @brief Array-indexing support.
784 bool operator[](uint32_t bitPosition) const;
787 /// @name Comparison Operators
789 /// Compares this APInt with RHS for the validity of the equality
791 /// @brief Equality operator.
792 bool operator==(const APInt& RHS) const {
793 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
795 return VAL == RHS.VAL;
796 return EqualSlowCase(RHS);
799 /// Compares this APInt with a uint64_t for the validity of the equality
801 /// @returns true if *this == Val
802 /// @brief Equality operator.
803 bool operator==(uint64_t Val) const {
806 return EqualSlowCase(Val);
809 /// Compares this APInt with RHS for the validity of the equality
811 /// @returns true if *this == Val
812 /// @brief Equality comparison.
813 bool eq(const APInt &RHS) const {
814 return (*this) == RHS;
817 /// Compares this APInt with RHS for the validity of the inequality
819 /// @returns true if *this != Val
820 /// @brief Inequality operator.
821 bool operator!=(const APInt& RHS) const {
822 return !((*this) == RHS);
825 /// Compares this APInt with a uint64_t for the validity of the inequality
827 /// @returns true if *this != Val
828 /// @brief Inequality operator.
829 bool operator!=(uint64_t Val) const {
830 return !((*this) == Val);
833 /// Compares this APInt with RHS for the validity of the inequality
835 /// @returns true if *this != Val
836 /// @brief Inequality comparison
837 bool ne(const APInt &RHS) const {
838 return !((*this) == RHS);
841 /// Regards both *this and RHS as unsigned quantities and compares them for
842 /// the validity of the less-than relationship.
843 /// @returns true if *this < RHS when both are considered unsigned.
844 /// @brief Unsigned less than comparison
845 bool ult(const APInt& RHS) const;
847 /// Regards both *this and RHS as signed quantities and compares them for
848 /// validity of the less-than relationship.
849 /// @returns true if *this < RHS when both are considered signed.
850 /// @brief Signed less than comparison
851 bool slt(const APInt& RHS) const;
853 /// Regards both *this and RHS as unsigned quantities and compares them for
854 /// validity of the less-or-equal relationship.
855 /// @returns true if *this <= RHS when both are considered unsigned.
856 /// @brief Unsigned less or equal comparison
857 bool ule(const APInt& RHS) const {
858 return ult(RHS) || eq(RHS);
861 /// Regards both *this and RHS as signed quantities and compares them for
862 /// validity of the less-or-equal relationship.
863 /// @returns true if *this <= RHS when both are considered signed.
864 /// @brief Signed less or equal comparison
865 bool sle(const APInt& RHS) const {
866 return slt(RHS) || eq(RHS);
869 /// Regards both *this and RHS as unsigned quantities and compares them for
870 /// the validity of the greater-than relationship.
871 /// @returns true if *this > RHS when both are considered unsigned.
872 /// @brief Unsigned greather than comparison
873 bool ugt(const APInt& RHS) const {
874 return !ult(RHS) && !eq(RHS);
877 /// Regards both *this and RHS as signed quantities and compares them for
878 /// the validity of the greater-than relationship.
879 /// @returns true if *this > RHS when both are considered signed.
880 /// @brief Signed greather than comparison
881 bool sgt(const APInt& RHS) const {
882 return !slt(RHS) && !eq(RHS);
885 /// Regards both *this and RHS as unsigned quantities and compares them for
886 /// validity of the greater-or-equal relationship.
887 /// @returns true if *this >= RHS when both are considered unsigned.
888 /// @brief Unsigned greater or equal comparison
889 bool uge(const APInt& RHS) const {
893 /// Regards both *this and RHS as signed quantities and compares them for
894 /// validity of the greater-or-equal relationship.
895 /// @returns true if *this >= RHS when both are considered signed.
896 /// @brief Signed greather or equal comparison
897 bool sge(const APInt& RHS) const {
901 /// This operation tests if there are any pairs of corresponding bits
902 /// between this APInt and RHS that are both set.
903 bool intersects(const APInt &RHS) const {
904 return (*this & RHS) != 0;
908 /// @name Resizing Operators
910 /// Truncate the APInt to a specified width. It is an error to specify a width
911 /// that is greater than or equal to the current width.
912 /// @brief Truncate to new width.
913 APInt &trunc(uint32_t width);
915 /// This operation sign extends the APInt to a new width. If the high order
916 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
917 /// It is an error to specify a width that is less than or equal to the
919 /// @brief Sign extend to a new width.
920 APInt &sext(uint32_t width);
922 /// This operation zero extends the APInt to a new width. The high order bits
923 /// are filled with 0 bits. It is an error to specify a width that is less
924 /// than or equal to the current width.
925 /// @brief Zero extend to a new width.
926 APInt &zext(uint32_t width);
928 /// Make this APInt have the bit width given by \p width. The value is sign
929 /// extended, truncated, or left alone to make it that width.
930 /// @brief Sign extend or truncate to width
931 APInt &sextOrTrunc(uint32_t width);
933 /// Make this APInt have the bit width given by \p width. The value is zero
934 /// extended, truncated, or left alone to make it that width.
935 /// @brief Zero extend or truncate to width
936 APInt &zextOrTrunc(uint32_t width);
939 /// @name Bit Manipulation Operators
941 /// @brief Set every bit to 1.
943 if (isSingleWord()) {
945 return clearUnusedBits();
948 // Set all the bits in all the words.
949 for (uint32_t i = 0; i < getNumWords(); ++i)
951 // Clear the unused ones
952 return clearUnusedBits();
955 /// Set the given bit to 1 whose position is given as "bitPosition".
956 /// @brief Set a given bit to 1.
957 APInt& set(uint32_t bitPosition);
959 /// @brief Set every bit to 0.
964 memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
968 /// Set the given bit to 0 whose position is given as "bitPosition".
969 /// @brief Set a given bit to 0.
970 APInt& clear(uint32_t bitPosition);
972 /// @brief Toggle every bit to its opposite value.
974 if (isSingleWord()) {
976 return clearUnusedBits();
978 for (uint32_t i = 0; i < getNumWords(); ++i)
980 return clearUnusedBits();
983 /// Toggle a given bit to its opposite value whose position is given
984 /// as "bitPosition".
985 /// @brief Toggles a given bit to its opposite value.
986 APInt& flip(uint32_t bitPosition);
989 /// @name Value Characterization Functions
992 /// @returns the total number of bits.
993 uint32_t getBitWidth() const {
997 /// Here one word's bitwidth equals to that of uint64_t.
998 /// @returns the number of words to hold the integer value of this APInt.
999 /// @brief Get the number of words.
1000 uint32_t getNumWords() const {
1001 return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1004 /// This function returns the number of active bits which is defined as the
1005 /// bit width minus the number of leading zeros. This is used in several
1006 /// computations to see how "wide" the value is.
1007 /// @brief Compute the number of active bits in the value
1008 uint32_t getActiveBits() const {
1009 return BitWidth - countLeadingZeros();
1012 /// This function returns the number of active words in the value of this
1013 /// APInt. This is used in conjunction with getActiveData to extract the raw
1014 /// value of the APInt.
1015 uint32_t getActiveWords() const {
1016 return whichWord(getActiveBits()-1) + 1;
1019 /// Computes the minimum bit width for this APInt while considering it to be
1020 /// a signed (and probably negative) value. If the value is not negative,
1021 /// this function returns the same value as getActiveBits()+1. Otherwise, it
1022 /// returns the smallest bit width that will retain the negative value. For
1023 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1024 /// for -1, this function will always return 1.
1025 /// @brief Get the minimum bit size for this signed APInt
1026 uint32_t getMinSignedBits() const {
1028 return BitWidth - countLeadingOnes() + 1;
1029 return getActiveBits()+1;
1032 /// This method attempts to return the value of this APInt as a zero extended
1033 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1034 /// uint64_t. Otherwise an assertion will result.
1035 /// @brief Get zero extended value
1036 uint64_t getZExtValue() const {
1039 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1043 /// This method attempts to return the value of this APInt as a sign extended
1044 /// int64_t. The bit width must be <= 64 or the value must fit within an
1045 /// int64_t. Otherwise an assertion will result.
1046 /// @brief Get sign extended value
1047 int64_t getSExtValue() const {
1049 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1050 (APINT_BITS_PER_WORD - BitWidth);
1051 assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
1052 return int64_t(pVal[0]);
1055 /// This method determines how many bits are required to hold the APInt
1056 /// equivalent of the string given by \p str of length \p slen.
1057 /// @brief Get bits required for string value.
1058 static uint32_t getBitsNeeded(const char* str, uint32_t slen, uint8_t radix);
1060 /// countLeadingZeros - This function is an APInt version of the
1061 /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
1062 /// of zeros from the most significant bit to the first one bit.
1063 /// @returns BitWidth if the value is zero.
1064 /// @returns the number of zeros from the most significant bit to the first
1066 uint32_t countLeadingZeros() const {
1067 if (isSingleWord()) {
1068 uint32_t unusedBits = APINT_BITS_PER_WORD - BitWidth;
1069 return CountLeadingZeros_64(VAL) - unusedBits;
1071 return countLeadingZerosSlowCase();
1074 /// countLeadingOnes - This function is an APInt version of the
1075 /// countLeadingOnes_{32,64} functions in MathExtras.h. It counts the number
1076 /// of ones from the most significant bit to the first zero bit.
1077 /// @returns 0 if the high order bit is not set
1078 /// @returns the number of 1 bits from the most significant to the least
1079 /// @brief Count the number of leading one bits.
1080 uint32_t countLeadingOnes() const;
1082 /// countTrailingZeros - This function is an APInt version of the
1083 /// countTrailingZeros_{32,64} functions in MathExtras.h. It counts
1084 /// the number of zeros from the least significant bit to the first set bit.
1085 /// @returns BitWidth if the value is zero.
1086 /// @returns the number of zeros from the least significant bit to the first
1088 /// @brief Count the number of trailing zero bits.
1089 uint32_t countTrailingZeros() const;
1091 /// countTrailingOnes - This function is an APInt version of the
1092 /// countTrailingOnes_{32,64} functions in MathExtras.h. It counts
1093 /// the number of ones from the least significant bit to the first zero bit.
1094 /// @returns BitWidth if the value is all ones.
1095 /// @returns the number of ones from the least significant bit to the first
1097 /// @brief Count the number of trailing one bits.
1098 uint32_t countTrailingOnes() const {
1100 return CountTrailingOnes_64(VAL);
1101 return countTrailingOnesSlowCase();
1104 /// countPopulation - This function is an APInt version of the
1105 /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
1106 /// of 1 bits in the APInt value.
1107 /// @returns 0 if the value is zero.
1108 /// @returns the number of set bits.
1109 /// @brief Count the number of bits set.
1110 uint32_t countPopulation() const {
1112 return CountPopulation_64(VAL);
1113 return countPopulationSlowCase();
1117 /// @name Conversion Functions
1119 void print(raw_ostream &OS, bool isSigned) const;
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;
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);
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);
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;
1143 /// @returns a byte-swapped representation of this APInt Value.
1144 APInt byteSwap() const;
1146 /// @brief Converts this APInt to a double value.
1147 double roundToDouble(bool isSigned) const;
1149 /// @brief Converts this unsigned APInt to a double value.
1150 double roundToDouble() const {
1151 return roundToDouble(false);
1154 /// @brief Converts this signed APInt to a double value.
1155 double signedRoundToDouble() const {
1156 return roundToDouble(true);
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 {
1168 T.I = (isSingleWord() ? VAL : pVal[0]);
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 {
1181 T.I = uint32_t((isSingleWord() ? VAL : pVal[0]));
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) {
1199 return clearUnusedBits();
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) {
1216 return clearUnusedBits();
1220 /// @name Mathematics Operations
1223 /// @returns the floor log base 2 of this APInt.
1224 uint32_t logBase2() const {
1225 return BitWidth - 1 - countLeadingZeros();
1228 /// @returns the log base 2 of this APInt if its an exact power of two, -1
1230 int32_t exactLogBase2() const {
1236 /// @brief Compute the square root
1239 /// If *this is < 0 then return -(*this), otherwise *this;
1240 /// @brief Get the absolute value;
1247 /// @returns the multiplicative inverse for a given modulo.
1248 APInt multiplicativeInverse(const APInt& modulo) const;
1251 /// @name Building-block Operations for APInt and APFloat
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.
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);
1265 /// Assign one bignum to another.
1266 static void tcAssign(integerPart *, const integerPart *, unsigned int);
1268 /// Returns true if a bignum is zero, false otherwise.
1269 static bool tcIsZero(const integerPart *, unsigned int);
1271 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1272 static int tcExtractBit(const integerPart *, unsigned int bit);
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);
1281 /// Set the given bit of a bignum. Zero-based.
1282 static void tcSetBit(integerPart *, unsigned int bit);
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
1287 static unsigned int tcLSB(const integerPart *, unsigned int);
1288 static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1290 /// Negate a bignum in-place.
1291 static void tcNegate(integerPart *, unsigned int);
1293 /// DST += RHS + CARRY where CARRY is zero or one. Returns the
1295 static integerPart tcAdd(integerPart *, const integerPart *,
1296 integerPart carry, unsigned);
1298 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the
1300 static integerPart tcSubtract(integerPart *, const integerPart *,
1301 integerPart carry, unsigned);
1303 /// DST += SRC * MULTIPLIER + PART if add is true
1304 /// DST = SRC * MULTIPLIER + PART if add is false
1306 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC
1307 /// they must start at the same point, i.e. DST == SRC.
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
1314 static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1315 integerPart multiplier, integerPart carry,
1316 unsigned int srcParts, unsigned int dstParts,
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);
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
1330 static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1331 const integerPart *, unsigned, unsigned);
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.
1337 /// OLD_LHS = RHS * LHS + REMAINDER
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
1343 static int tcDivide(integerPart *lhs, const integerPart *rhs,
1344 integerPart *remainder, integerPart *scratch,
1345 unsigned int parts);
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);
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);
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);
1363 /// Comparison (unsigned) of two bignums.
1364 static int tcCompare(const integerPart *, const integerPart *,
1367 /// Increment a bignum in-place. Return the carry flag.
1368 static integerPart tcIncrement(integerPart *, unsigned int);
1370 /// Set the least significant BITS and clear the rest.
1371 static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1374 /// @brief debug method
1380 inline bool operator==(uint64_t V1, const APInt& V2) {
1384 inline bool operator!=(uint64_t V1, const APInt& V2) {
1388 inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
1393 namespace APIntOps {
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;
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;
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;
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;
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);
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);
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);
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);
1438 /// @returns a byte-swapped representation of the specified APInt Value.
1439 inline APInt byteSwap(const APInt& APIVal) {
1440 return APIVal.byteSwap();
1443 /// @returns the floor log base 2 of the specified APInt value.
1444 inline uint32_t logBase2(const APInt& APIVal) {
1445 return APIVal.logBase2();
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);
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();
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();
1466 /// @brief Converts the given APInt to a float vlalue.
1467 inline float RoundAPIntToFloat(const APInt& APIVal) {
1468 return float(RoundAPIntToDouble(APIVal));
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());
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);
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);
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);
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);
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);
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);
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);
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);
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);
1529 /// Performs multiplication on APInt values.
1530 /// @brief Function for multiplication operation.
1531 inline APInt mul(const APInt& LHS, const APInt& RHS) {
1535 /// Performs addition on APInt values.
1536 /// @brief Function for addition operation.
1537 inline APInt add(const APInt& LHS, const APInt& RHS) {
1541 /// Performs subtraction on APInt values.
1542 /// @brief Function for subtraction operation.
1543 inline APInt sub(const APInt& LHS, const APInt& RHS) {
1547 /// Performs bitwise AND operation on APInt LHS and
1549 /// @brief Bitwise AND function for APInt.
1550 inline APInt And(const APInt& LHS, const APInt& RHS) {
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) {
1560 /// Performs bitwise XOR operation on APInt.
1561 /// @brief Bitwise XOR function for APInt.
1562 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
1566 /// Performs a bitwise complement operation on APInt.
1567 /// @brief Bitwise complement function.
1568 inline APInt Not(const APInt& APIVal) {
1572 } // End of APIntOps namespace
1574 } // End of llvm namespace