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 //===----------------------------------------------------------------------===//
11 /// \brief This file implements a class to represent arbitrary precision
12 /// integral constant values and operations on them.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_ADT_APINT_H
17 #define LLVM_ADT_APINT_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/Support/Compiler.h"
21 #include "llvm/Support/MathExtras.h"
28 class FoldingSetNodeID;
33 template <typename T> class SmallVectorImpl;
35 // An unsigned host type used as a single part of a multi-part
37 typedef uint64_t integerPart;
39 const unsigned int host_char_bit = 8;
40 const unsigned int integerPartWidth =
41 host_char_bit * static_cast<unsigned int>(sizeof(integerPart));
43 //===----------------------------------------------------------------------===//
45 //===----------------------------------------------------------------------===//
47 /// \brief Class for arbitrary precision integers.
49 /// APInt is a functional replacement for common case unsigned integer type like
50 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
51 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
52 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
53 /// and methods to manipulate integer values of any bit-width. It supports both
54 /// the typical integer arithmetic and comparison operations as well as bitwise
57 /// The class has several invariants worth noting:
58 /// * All bit, byte, and word positions are zero-based.
59 /// * Once the bit width is set, it doesn't change except by the Truncate,
60 /// SignExtend, or ZeroExtend operations.
61 /// * All binary operators must be on APInt instances of the same bit width.
62 /// Attempting to use these operators on instances with different bit
63 /// widths will yield an assertion.
64 /// * The value is stored canonically as an unsigned value. For operations
65 /// where it makes a difference, there are both signed and unsigned variants
66 /// of the operation. For example, sdiv and udiv. However, because the bit
67 /// widths must be the same, operations such as Mul and Add produce the same
68 /// results regardless of whether the values are interpreted as signed or
70 /// * In general, the class tries to follow the style of computation that LLVM
71 /// uses in its IR. This simplifies its use for LLVM.
74 unsigned BitWidth; ///< The number of bits in this APInt.
76 /// This union is used to store the integer value. When the
77 /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
79 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
80 uint64_t *pVal; ///< Used to store the >64 bits integer value.
83 /// This enum is used to hold the constants we needed for APInt.
87 static_cast<unsigned int>(sizeof(uint64_t)) * CHAR_BIT,
88 /// Byte size of a word
89 APINT_WORD_SIZE = static_cast<unsigned int>(sizeof(uint64_t))
92 friend struct DenseMapAPIntKeyInfo;
94 /// \brief Fast internal constructor
96 /// This constructor is used only internally for speed of construction of
97 /// temporaries. It is unsafe for general use so it is not public.
98 APInt(uint64_t *val, unsigned bits) : BitWidth(bits), pVal(val) {}
100 /// \brief Determine if this APInt just has one word to store value.
102 /// \returns true if the number of bits <= 64, false otherwise.
103 bool isSingleWord() const { return BitWidth <= APINT_BITS_PER_WORD; }
105 /// \brief Determine which word a bit is in.
107 /// \returns the word position for the specified bit position.
108 static unsigned whichWord(unsigned bitPosition) {
109 return bitPosition / APINT_BITS_PER_WORD;
112 /// \brief Determine which bit in a word a bit is in.
114 /// \returns the bit position in a word for the specified bit position
116 static unsigned whichBit(unsigned bitPosition) {
117 return bitPosition % APINT_BITS_PER_WORD;
120 /// \brief Get a single bit mask.
122 /// \returns a uint64_t with only bit at "whichBit(bitPosition)" set
123 /// This method generates and returns a uint64_t (word) mask for a single
124 /// bit at a specific bit position. This is used to mask the bit in the
125 /// corresponding word.
126 static uint64_t maskBit(unsigned bitPosition) {
127 return 1ULL << whichBit(bitPosition);
130 /// \brief Clear unused high order bits
132 /// This method is used internally to clear the top "N" bits in the high order
133 /// word that are not used by the APInt. This is needed after the most
134 /// significant word is assigned a value to ensure that those bits are
136 APInt &clearUnusedBits() {
137 // Compute how many bits are used in the final word
138 unsigned wordBits = BitWidth % APINT_BITS_PER_WORD;
140 // If all bits are used, we want to leave the value alone. This also
141 // avoids the undefined behavior of >> when the shift is the same size as
142 // the word size (64).
145 // Mask out the high bits.
146 uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
150 pVal[getNumWords() - 1] &= mask;
154 /// \brief Get the word corresponding to a bit position
155 /// \returns the corresponding word for the specified bit position.
156 uint64_t getWord(unsigned bitPosition) const {
157 return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
160 /// \brief Convert a char array into an APInt
162 /// \param radix 2, 8, 10, 16, or 36
163 /// Converts a string into a number. The string must be non-empty
164 /// and well-formed as a number of the given base. The bit-width
165 /// must be sufficient to hold the result.
167 /// This is used by the constructors that take string arguments.
169 /// StringRef::getAsInteger is superficially similar but (1) does
170 /// not assume that the string is well-formed and (2) grows the
171 /// result to hold the input.
172 void fromString(unsigned numBits, StringRef str, uint8_t radix);
174 /// \brief An internal division function for dividing APInts.
176 /// This is used by the toString method to divide by the radix. It simply
177 /// provides a more convenient form of divide for internal use since KnuthDiv
178 /// has specific constraints on its inputs. If those constraints are not met
179 /// then it provides a simpler form of divide.
180 static void divide(const APInt LHS, unsigned lhsWords, const APInt &RHS,
181 unsigned rhsWords, APInt *Quotient, APInt *Remainder);
183 /// out-of-line slow case for inline constructor
184 void initSlowCase(unsigned numBits, uint64_t val, bool isSigned);
186 /// shared code between two array constructors
187 void initFromArray(ArrayRef<uint64_t> array);
189 /// out-of-line slow case for inline copy constructor
190 void initSlowCase(const APInt &that);
192 /// out-of-line slow case for shl
193 APInt shlSlowCase(unsigned shiftAmt) const;
195 /// out-of-line slow case for operator&
196 APInt AndSlowCase(const APInt &RHS) const;
198 /// out-of-line slow case for operator|
199 APInt OrSlowCase(const APInt &RHS) const;
201 /// out-of-line slow case for operator^
202 APInt XorSlowCase(const APInt &RHS) const;
204 /// out-of-line slow case for operator=
205 APInt &AssignSlowCase(const APInt &RHS);
207 /// out-of-line slow case for operator==
208 bool EqualSlowCase(const APInt &RHS) const;
210 /// out-of-line slow case for operator==
211 bool EqualSlowCase(uint64_t Val) const;
213 /// out-of-line slow case for countLeadingZeros
214 unsigned countLeadingZerosSlowCase() const;
216 /// out-of-line slow case for countTrailingOnes
217 unsigned countTrailingOnesSlowCase() const;
219 /// out-of-line slow case for countPopulation
220 unsigned countPopulationSlowCase() const;
223 /// \name Constructors
226 /// \brief Create a new APInt of numBits width, initialized as val.
228 /// If isSigned is true then val is treated as if it were a signed value
229 /// (i.e. as an int64_t) and the appropriate sign extension to the bit width
230 /// will be done. Otherwise, no sign extension occurs (high order bits beyond
231 /// the range of val are zero filled).
233 /// \param numBits the bit width of the constructed APInt
234 /// \param val the initial value of the APInt
235 /// \param isSigned how to treat signedness of val
236 APInt(unsigned numBits, uint64_t val, bool isSigned = false)
237 : BitWidth(numBits), VAL(0) {
238 assert(BitWidth && "bitwidth too small");
242 initSlowCase(numBits, val, isSigned);
246 /// \brief Construct an APInt of numBits width, initialized as bigVal[].
248 /// Note that bigVal.size() can be smaller or larger than the corresponding
249 /// bit width but any extraneous bits will be dropped.
251 /// \param numBits the bit width of the constructed APInt
252 /// \param bigVal a sequence of words to form the initial value of the APInt
253 APInt(unsigned numBits, ArrayRef<uint64_t> bigVal);
255 /// Equivalent to APInt(numBits, ArrayRef<uint64_t>(bigVal, numWords)), but
256 /// deprecated because this constructor is prone to ambiguity with the
257 /// APInt(unsigned, uint64_t, bool) constructor.
259 /// If this overload is ever deleted, care should be taken to prevent calls
260 /// from being incorrectly captured by the APInt(unsigned, uint64_t, bool)
262 APInt(unsigned numBits, unsigned numWords, const uint64_t bigVal[]);
264 /// \brief Construct an APInt from a string representation.
266 /// This constructor interprets the string \p str in the given radix. The
267 /// interpretation stops when the first character that is not suitable for the
268 /// radix is encountered, or the end of the string. Acceptable radix values
269 /// are 2, 8, 10, 16, and 36. It is an error for the value implied by the
270 /// string to require more bits than numBits.
272 /// \param numBits the bit width of the constructed APInt
273 /// \param str the string to be interpreted
274 /// \param radix the radix to use for the conversion
275 APInt(unsigned numBits, StringRef str, uint8_t radix);
277 /// Simply makes *this a copy of that.
278 /// @brief Copy Constructor.
279 APInt(const APInt &that) : BitWidth(that.BitWidth), VAL(0) {
286 /// \brief Move Constructor.
287 APInt(APInt &&that) : BitWidth(that.BitWidth), VAL(that.VAL) {
291 /// \brief Destructor.
297 /// \brief Default constructor that creates an uninitialized APInt.
299 /// This is useful for object deserialization (pair this with the static
301 explicit APInt() : BitWidth(1) {}
303 /// \brief Returns whether this instance allocated memory.
304 bool needsCleanup() const { return !isSingleWord(); }
306 /// Used to insert APInt objects, or objects that contain APInt objects, into
308 void Profile(FoldingSetNodeID &id) const;
311 /// \name Value Tests
314 /// \brief Determine sign of this APInt.
316 /// This tests the high bit of this APInt to determine if it is set.
318 /// \returns true if this APInt is negative, false otherwise
319 bool isNegative() const { return (*this)[BitWidth - 1]; }
321 /// \brief Determine if this APInt Value is non-negative (>= 0)
323 /// This tests the high bit of the APInt to determine if it is unset.
324 bool isNonNegative() const { return !isNegative(); }
326 /// \brief Determine if this APInt Value is positive.
328 /// This tests if the value of this APInt is positive (> 0). Note
329 /// that 0 is not a positive value.
331 /// \returns true if this APInt is positive.
332 bool isStrictlyPositive() const { return isNonNegative() && !!*this; }
334 /// \brief Determine if all bits are set
336 /// This checks to see if the value has all bits of the APInt are set or not.
337 bool isAllOnesValue() const {
339 return VAL == ~integerPart(0) >> (APINT_BITS_PER_WORD - BitWidth);
340 return countPopulationSlowCase() == BitWidth;
343 /// \brief Determine if this is the largest unsigned value.
345 /// This checks to see if the value of this APInt is the maximum unsigned
346 /// value for the APInt's bit width.
347 bool isMaxValue() const { return isAllOnesValue(); }
349 /// \brief Determine if this is the largest signed value.
351 /// This checks to see if the value of this APInt is the maximum signed
352 /// value for the APInt's bit width.
353 bool isMaxSignedValue() const {
354 return !isNegative() && countPopulation() == BitWidth - 1;
357 /// \brief Determine if this is the smallest unsigned value.
359 /// This checks to see if the value of this APInt is the minimum unsigned
360 /// value for the APInt's bit width.
361 bool isMinValue() const { return !*this; }
363 /// \brief Determine if this is the smallest signed value.
365 /// This checks to see if the value of this APInt is the minimum signed
366 /// value for the APInt's bit width.
367 bool isMinSignedValue() const {
368 return isNegative() && isPowerOf2();
371 /// \brief Check if this APInt has an N-bits unsigned integer value.
372 bool isIntN(unsigned N) const {
373 assert(N && "N == 0 ???");
374 return getActiveBits() <= N;
377 /// \brief Check if this APInt has an N-bits signed integer value.
378 bool isSignedIntN(unsigned N) const {
379 assert(N && "N == 0 ???");
380 return getMinSignedBits() <= N;
383 /// \brief Check if this APInt's value is a power of two greater than zero.
385 /// \returns true if the argument APInt value is a power of two > 0.
386 bool isPowerOf2() const {
388 return isPowerOf2_64(VAL);
389 return countPopulationSlowCase() == 1;
392 /// \brief Check if the APInt's value is returned by getSignBit.
394 /// \returns true if this is the value returned by getSignBit.
395 bool isSignBit() const { return isMinSignedValue(); }
397 /// \brief Convert APInt to a boolean value.
399 /// This converts the APInt to a boolean value as a test against zero.
400 bool getBoolValue() const { return !!*this; }
402 /// If this value is smaller than the specified limit, return it, otherwise
403 /// return the limit value. This causes the value to saturate to the limit.
404 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
405 return (getActiveBits() > 64 || getZExtValue() > Limit) ? Limit
409 /// \brief Check if the APInt consists of a repeated bit pattern.
411 /// e.g. 0x01010101 satisfies isSplat(8).
412 /// \param SplatSizeInBits The size of the pattern in bits. Must divide bit
413 /// width without remainder.
414 bool isSplat(unsigned SplatSizeInBits) const;
417 /// \name Value Generators
420 /// \brief Gets maximum unsigned value of APInt for specific bit width.
421 static APInt getMaxValue(unsigned numBits) {
422 return getAllOnesValue(numBits);
425 /// \brief Gets maximum signed value of APInt for a specific bit width.
426 static APInt getSignedMaxValue(unsigned numBits) {
427 APInt API = getAllOnesValue(numBits);
428 API.clearBit(numBits - 1);
432 /// \brief Gets minimum unsigned value of APInt for a specific bit width.
433 static APInt getMinValue(unsigned numBits) { return APInt(numBits, 0); }
435 /// \brief Gets minimum signed value of APInt for a specific bit width.
436 static APInt getSignedMinValue(unsigned numBits) {
437 APInt API(numBits, 0);
438 API.setBit(numBits - 1);
442 /// \brief Get the SignBit for a specific bit width.
444 /// This is just a wrapper function of getSignedMinValue(), and it helps code
445 /// readability when we want to get a SignBit.
446 static APInt getSignBit(unsigned BitWidth) {
447 return getSignedMinValue(BitWidth);
450 /// \brief Get the all-ones value.
452 /// \returns the all-ones value for an APInt of the specified bit-width.
453 static APInt getAllOnesValue(unsigned numBits) {
454 return APInt(numBits, UINT64_MAX, true);
457 /// \brief Get the '0' value.
459 /// \returns the '0' value for an APInt of the specified bit-width.
460 static APInt getNullValue(unsigned numBits) { return APInt(numBits, 0); }
462 /// \brief Compute an APInt containing numBits highbits from this APInt.
464 /// Get an APInt with the same BitWidth as this APInt, just zero mask
465 /// the low bits and right shift to the least significant bit.
467 /// \returns the high "numBits" bits of this APInt.
468 APInt getHiBits(unsigned numBits) const;
470 /// \brief Compute an APInt containing numBits lowbits from this APInt.
472 /// Get an APInt with the same BitWidth as this APInt, just zero mask
475 /// \returns the low "numBits" bits of this APInt.
476 APInt getLoBits(unsigned numBits) const;
478 /// \brief Return an APInt with exactly one bit set in the result.
479 static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
480 APInt Res(numBits, 0);
485 /// \brief Get a value with a block of bits set.
487 /// Constructs an APInt value that has a contiguous range of bits set. The
488 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
489 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
490 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
491 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
493 /// \param numBits the intended bit width of the result
494 /// \param loBit the index of the lowest bit set.
495 /// \param hiBit the index of the highest bit set.
497 /// \returns An APInt value with the requested bits set.
498 static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
499 assert(hiBit <= numBits && "hiBit out of range");
500 assert(loBit < numBits && "loBit out of range");
502 return getLowBitsSet(numBits, hiBit) |
503 getHighBitsSet(numBits, numBits - loBit);
504 return getLowBitsSet(numBits, hiBit - loBit).shl(loBit);
507 /// \brief Get a value with high bits set
509 /// Constructs an APInt value that has the top hiBitsSet bits set.
511 /// \param numBits the bitwidth of the result
512 /// \param hiBitsSet the number of high-order bits set in the result.
513 static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
514 assert(hiBitsSet <= numBits && "Too many bits to set!");
515 // Handle a degenerate case, to avoid shifting by word size
517 return APInt(numBits, 0);
518 unsigned shiftAmt = numBits - hiBitsSet;
519 // For small values, return quickly
520 if (numBits <= APINT_BITS_PER_WORD)
521 return APInt(numBits, ~0ULL << shiftAmt);
522 return getAllOnesValue(numBits).shl(shiftAmt);
525 /// \brief Get a value with low bits set
527 /// Constructs an APInt value that has the bottom loBitsSet bits set.
529 /// \param numBits the bitwidth of the result
530 /// \param loBitsSet the number of low-order bits set in the result.
531 static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
532 assert(loBitsSet <= numBits && "Too many bits to set!");
533 // Handle a degenerate case, to avoid shifting by word size
535 return APInt(numBits, 0);
536 if (loBitsSet == APINT_BITS_PER_WORD)
537 return APInt(numBits, UINT64_MAX);
538 // For small values, return quickly.
539 if (loBitsSet <= APINT_BITS_PER_WORD)
540 return APInt(numBits, UINT64_MAX >> (APINT_BITS_PER_WORD - loBitsSet));
541 return getAllOnesValue(numBits).lshr(numBits - loBitsSet);
544 /// \brief Return a value containing V broadcasted over NewLen bits.
545 static APInt getSplat(unsigned NewLen, const APInt &V) {
546 assert(NewLen >= V.getBitWidth() && "Can't splat to smaller bit width!");
548 APInt Val = V.zextOrSelf(NewLen);
549 for (unsigned I = V.getBitWidth(); I < NewLen; I <<= 1)
555 /// \brief Determine if two APInts have the same value, after zero-extending
556 /// one of them (if needed!) to ensure that the bit-widths match.
557 static bool isSameValue(const APInt &I1, const APInt &I2) {
558 if (I1.getBitWidth() == I2.getBitWidth())
561 if (I1.getBitWidth() > I2.getBitWidth())
562 return I1 == I2.zext(I1.getBitWidth());
564 return I1.zext(I2.getBitWidth()) == I2;
567 /// \brief Overload to compute a hash_code for an APInt value.
568 friend hash_code hash_value(const APInt &Arg);
570 /// This function returns a pointer to the internal storage of the APInt.
571 /// This is useful for writing out the APInt in binary form without any
573 const uint64_t *getRawData() const {
580 /// \name Unary Operators
583 /// \brief Postfix increment operator.
585 /// \returns a new APInt value representing *this incremented by one
586 const APInt operator++(int) {
592 /// \brief Prefix increment operator.
594 /// \returns *this incremented by one
597 /// \brief Postfix decrement operator.
599 /// \returns a new APInt representing *this decremented by one.
600 const APInt operator--(int) {
606 /// \brief Prefix decrement operator.
608 /// \returns *this decremented by one.
611 /// \brief Unary bitwise complement operator.
613 /// Performs a bitwise complement operation on this APInt.
615 /// \returns an APInt that is the bitwise complement of *this
616 APInt operator~() const {
618 Result.flipAllBits();
622 /// \brief Unary negation operator
624 /// Negates *this using two's complement logic.
626 /// \returns An APInt value representing the negation of *this.
627 APInt operator-() const { return APInt(BitWidth, 0) - (*this); }
629 /// \brief Logical negation operator.
631 /// Performs logical negation operation on this APInt.
633 /// \returns true if *this is zero, false otherwise.
634 bool operator!() const {
638 for (unsigned i = 0; i != getNumWords(); ++i)
645 /// \name Assignment Operators
648 /// \brief Copy assignment operator.
650 /// \returns *this after assignment of RHS.
651 APInt &operator=(const APInt &RHS) {
652 // If the bitwidths are the same, we can avoid mucking with memory
653 if (isSingleWord() && RHS.isSingleWord()) {
655 BitWidth = RHS.BitWidth;
656 return clearUnusedBits();
659 return AssignSlowCase(RHS);
662 /// @brief Move assignment operator.
663 APInt &operator=(APInt &&that) {
664 if (!isSingleWord()) {
665 // The MSVC STL shipped in 2013 requires that self move assignment be a
666 // no-op. Otherwise algorithms like stable_sort will produce answers
667 // where half of the output is left in a moved-from state.
673 // Use memcpy so that type based alias analysis sees both VAL and pVal
675 memcpy(&VAL, &that.VAL, sizeof(uint64_t));
677 // If 'this == &that', avoid zeroing our own bitwidth by storing to 'that'
679 unsigned ThatBitWidth = that.BitWidth;
681 BitWidth = ThatBitWidth;
686 /// \brief Assignment operator.
688 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
689 /// the bit width, the excess bits are truncated. If the bit width is larger
690 /// than 64, the value is zero filled in the unspecified high order bits.
692 /// \returns *this after assignment of RHS value.
693 APInt &operator=(uint64_t RHS);
695 /// \brief Bitwise AND assignment operator.
697 /// Performs a bitwise AND operation on this APInt and RHS. The result is
698 /// assigned to *this.
700 /// \returns *this after ANDing with RHS.
701 APInt &operator&=(const APInt &RHS);
703 /// \brief Bitwise OR assignment operator.
705 /// Performs a bitwise OR operation on this APInt and RHS. The result is
708 /// \returns *this after ORing with RHS.
709 APInt &operator|=(const APInt &RHS);
711 /// \brief Bitwise OR assignment operator.
713 /// Performs a bitwise OR operation on this APInt and RHS. RHS is
714 /// logically zero-extended or truncated to match the bit-width of
716 APInt &operator|=(uint64_t RHS) {
717 if (isSingleWord()) {
726 /// \brief Bitwise XOR assignment operator.
728 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
729 /// assigned to *this.
731 /// \returns *this after XORing with RHS.
732 APInt &operator^=(const APInt &RHS);
734 /// \brief Multiplication assignment operator.
736 /// Multiplies this APInt by RHS and assigns the result to *this.
739 APInt &operator*=(const APInt &RHS);
741 /// \brief Addition assignment operator.
743 /// Adds RHS to *this and assigns the result to *this.
746 APInt &operator+=(const APInt &RHS);
748 /// \brief Subtraction assignment operator.
750 /// Subtracts RHS from *this and assigns the result to *this.
753 APInt &operator-=(const APInt &RHS);
755 /// \brief Left-shift assignment function.
757 /// Shifts *this left by shiftAmt and assigns the result to *this.
759 /// \returns *this after shifting left by shiftAmt
760 APInt &operator<<=(unsigned shiftAmt) {
761 *this = shl(shiftAmt);
766 /// \name Binary Operators
769 /// \brief Bitwise AND operator.
771 /// Performs a bitwise AND operation on *this and RHS.
773 /// \returns An APInt value representing the bitwise AND of *this and RHS.
774 APInt operator&(const APInt &RHS) const {
775 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
777 return APInt(getBitWidth(), VAL & RHS.VAL);
778 return AndSlowCase(RHS);
780 APInt LLVM_ATTRIBUTE_UNUSED_RESULT And(const APInt &RHS) const {
781 return this->operator&(RHS);
784 /// \brief Bitwise OR operator.
786 /// Performs a bitwise OR operation on *this and RHS.
788 /// \returns An APInt value representing the bitwise OR of *this and RHS.
789 APInt operator|(const APInt &RHS) const {
790 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
792 return APInt(getBitWidth(), VAL | RHS.VAL);
793 return OrSlowCase(RHS);
796 /// \brief Bitwise OR function.
798 /// Performs a bitwise or on *this and RHS. This is implemented by simply
799 /// calling operator|.
801 /// \returns An APInt value representing the bitwise OR of *this and RHS.
802 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Or(const APInt &RHS) const {
803 return this->operator|(RHS);
806 /// \brief Bitwise XOR operator.
808 /// Performs a bitwise XOR operation on *this and RHS.
810 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
811 APInt operator^(const APInt &RHS) const {
812 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
814 return APInt(BitWidth, VAL ^ RHS.VAL);
815 return XorSlowCase(RHS);
818 /// \brief Bitwise XOR function.
820 /// Performs a bitwise XOR operation on *this and RHS. This is implemented
821 /// through the usage of operator^.
823 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
824 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Xor(const APInt &RHS) const {
825 return this->operator^(RHS);
828 /// \brief Multiplication operator.
830 /// Multiplies this APInt by RHS and returns the result.
831 APInt operator*(const APInt &RHS) const;
833 /// \brief Addition operator.
835 /// Adds RHS to this APInt and returns the result.
836 APInt operator+(const APInt &RHS) const;
837 APInt operator+(uint64_t RHS) const { return (*this) + APInt(BitWidth, RHS); }
839 /// \brief Subtraction operator.
841 /// Subtracts RHS from this APInt and returns the result.
842 APInt operator-(const APInt &RHS) const;
843 APInt operator-(uint64_t RHS) const { return (*this) - APInt(BitWidth, RHS); }
845 /// \brief Left logical shift operator.
847 /// Shifts this APInt left by \p Bits and returns the result.
848 APInt operator<<(unsigned Bits) const { return shl(Bits); }
850 /// \brief Left logical shift operator.
852 /// Shifts this APInt left by \p Bits and returns the result.
853 APInt operator<<(const APInt &Bits) const { return shl(Bits); }
855 /// \brief Arithmetic right-shift function.
857 /// Arithmetic right-shift this APInt by shiftAmt.
858 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(unsigned shiftAmt) const;
860 /// \brief Logical right-shift function.
862 /// Logical right-shift this APInt by shiftAmt.
863 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(unsigned shiftAmt) const;
865 /// \brief Left-shift function.
867 /// Left-shift this APInt by shiftAmt.
868 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(unsigned shiftAmt) const {
869 assert(shiftAmt <= BitWidth && "Invalid shift amount");
870 if (isSingleWord()) {
871 if (shiftAmt >= BitWidth)
872 return APInt(BitWidth, 0); // avoid undefined shift results
873 return APInt(BitWidth, VAL << shiftAmt);
875 return shlSlowCase(shiftAmt);
878 /// \brief Rotate left by rotateAmt.
879 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(unsigned rotateAmt) const;
881 /// \brief Rotate right by rotateAmt.
882 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(unsigned rotateAmt) const;
884 /// \brief Arithmetic right-shift function.
886 /// Arithmetic right-shift this APInt by shiftAmt.
887 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(const APInt &shiftAmt) const;
889 /// \brief Logical right-shift function.
891 /// Logical right-shift this APInt by shiftAmt.
892 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(const APInt &shiftAmt) const;
894 /// \brief Left-shift function.
896 /// Left-shift this APInt by shiftAmt.
897 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(const APInt &shiftAmt) const;
899 /// \brief Rotate left by rotateAmt.
900 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(const APInt &rotateAmt) const;
902 /// \brief Rotate right by rotateAmt.
903 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(const APInt &rotateAmt) const;
905 /// \brief Unsigned division operation.
907 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
908 /// RHS are treated as unsigned quantities for purposes of this division.
910 /// \returns a new APInt value containing the division result
911 APInt LLVM_ATTRIBUTE_UNUSED_RESULT udiv(const APInt &RHS) const;
913 /// \brief Signed division function for APInt.
915 /// Signed divide this APInt by APInt RHS.
916 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sdiv(const APInt &RHS) const;
918 /// \brief Unsigned remainder operation.
920 /// Perform an unsigned remainder operation on this APInt with RHS being the
921 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
922 /// of this operation. Note that this is a true remainder operation and not a
923 /// modulo operation because the sign follows the sign of the dividend which
926 /// \returns a new APInt value containing the remainder result
927 APInt LLVM_ATTRIBUTE_UNUSED_RESULT urem(const APInt &RHS) const;
929 /// \brief Function for signed remainder operation.
931 /// Signed remainder operation on APInt.
932 APInt LLVM_ATTRIBUTE_UNUSED_RESULT srem(const APInt &RHS) const;
934 /// \brief Dual division/remainder interface.
936 /// Sometimes it is convenient to divide two APInt values and obtain both the
937 /// quotient and remainder. This function does both operations in the same
938 /// computation making it a little more efficient. The pair of input arguments
939 /// may overlap with the pair of output arguments. It is safe to call
940 /// udivrem(X, Y, X, Y), for example.
941 static void udivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
944 static void sdivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
947 // Operations that return overflow indicators.
948 APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
949 APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
950 APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
951 APInt usub_ov(const APInt &RHS, bool &Overflow) const;
952 APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
953 APInt smul_ov(const APInt &RHS, bool &Overflow) const;
954 APInt umul_ov(const APInt &RHS, bool &Overflow) const;
955 APInt sshl_ov(const APInt &Amt, bool &Overflow) const;
956 APInt ushl_ov(const APInt &Amt, bool &Overflow) const;
958 /// \brief Array-indexing support.
960 /// \returns the bit value at bitPosition
961 bool operator[](unsigned bitPosition) const {
962 assert(bitPosition < getBitWidth() && "Bit position out of bounds!");
963 return (maskBit(bitPosition) &
964 (isSingleWord() ? VAL : pVal[whichWord(bitPosition)])) !=
969 /// \name Comparison Operators
972 /// \brief Equality operator.
974 /// Compares this APInt with RHS for the validity of the equality
976 bool operator==(const APInt &RHS) const {
977 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
979 return VAL == RHS.VAL;
980 return EqualSlowCase(RHS);
983 /// \brief Equality operator.
985 /// Compares this APInt with a uint64_t for the validity of the equality
988 /// \returns true if *this == Val
989 bool operator==(uint64_t Val) const {
992 return EqualSlowCase(Val);
995 /// \brief Equality comparison.
997 /// Compares this APInt with RHS for the validity of the equality
1000 /// \returns true if *this == Val
1001 bool eq(const APInt &RHS) const { return (*this) == RHS; }
1003 /// \brief Inequality operator.
1005 /// Compares this APInt with RHS for the validity of the inequality
1008 /// \returns true if *this != Val
1009 bool operator!=(const APInt &RHS) const { return !((*this) == RHS); }
1011 /// \brief Inequality operator.
1013 /// Compares this APInt with a uint64_t for the validity of the inequality
1016 /// \returns true if *this != Val
1017 bool operator!=(uint64_t Val) const { return !((*this) == Val); }
1019 /// \brief Inequality comparison
1021 /// Compares this APInt with RHS for the validity of the inequality
1024 /// \returns true if *this != Val
1025 bool ne(const APInt &RHS) const { return !((*this) == RHS); }
1027 /// \brief Unsigned less than comparison
1029 /// Regards both *this and RHS as unsigned quantities and compares them for
1030 /// the validity of the less-than relationship.
1032 /// \returns true if *this < RHS when both are considered unsigned.
1033 bool ult(const APInt &RHS) const;
1035 /// \brief Unsigned less than comparison
1037 /// Regards both *this as an unsigned quantity and compares it with RHS for
1038 /// the validity of the less-than relationship.
1040 /// \returns true if *this < RHS when considered unsigned.
1041 bool ult(uint64_t RHS) const { return ult(APInt(getBitWidth(), RHS)); }
1043 /// \brief Signed less than comparison
1045 /// Regards both *this and RHS as signed quantities and compares them for
1046 /// validity of the less-than relationship.
1048 /// \returns true if *this < RHS when both are considered signed.
1049 bool slt(const APInt &RHS) const;
1051 /// \brief Signed less than comparison
1053 /// Regards both *this as a signed quantity and compares it with RHS for
1054 /// the validity of the less-than relationship.
1056 /// \returns true if *this < RHS when considered signed.
1057 bool slt(uint64_t RHS) const { return slt(APInt(getBitWidth(), RHS)); }
1059 /// \brief Unsigned less or equal comparison
1061 /// Regards both *this and RHS as unsigned quantities and compares them for
1062 /// validity of the less-or-equal relationship.
1064 /// \returns true if *this <= RHS when both are considered unsigned.
1065 bool ule(const APInt &RHS) const { return ult(RHS) || eq(RHS); }
1067 /// \brief Unsigned less or equal comparison
1069 /// Regards both *this as an unsigned quantity and compares it with RHS for
1070 /// the validity of the less-or-equal relationship.
1072 /// \returns true if *this <= RHS when considered unsigned.
1073 bool ule(uint64_t RHS) const { return ule(APInt(getBitWidth(), RHS)); }
1075 /// \brief Signed less or equal comparison
1077 /// Regards both *this and RHS as signed quantities and compares them for
1078 /// validity of the less-or-equal relationship.
1080 /// \returns true if *this <= RHS when both are considered signed.
1081 bool sle(const APInt &RHS) const { return slt(RHS) || eq(RHS); }
1083 /// \brief Signed less or equal comparison
1085 /// Regards both *this as a signed quantity and compares it with RHS for the
1086 /// validity of the less-or-equal relationship.
1088 /// \returns true if *this <= RHS when considered signed.
1089 bool sle(uint64_t RHS) const { return sle(APInt(getBitWidth(), RHS)); }
1091 /// \brief Unsigned greather than comparison
1093 /// Regards both *this and RHS as unsigned quantities and compares them for
1094 /// the validity of the greater-than relationship.
1096 /// \returns true if *this > RHS when both are considered unsigned.
1097 bool ugt(const APInt &RHS) const { return !ult(RHS) && !eq(RHS); }
1099 /// \brief Unsigned greater than comparison
1101 /// Regards both *this as an unsigned quantity and compares it with RHS for
1102 /// the validity of the greater-than relationship.
1104 /// \returns true if *this > RHS when considered unsigned.
1105 bool ugt(uint64_t RHS) const { return ugt(APInt(getBitWidth(), RHS)); }
1107 /// \brief Signed greather than comparison
1109 /// Regards both *this and RHS as signed quantities and compares them for the
1110 /// validity of the greater-than relationship.
1112 /// \returns true if *this > RHS when both are considered signed.
1113 bool sgt(const APInt &RHS) const { return !slt(RHS) && !eq(RHS); }
1115 /// \brief Signed greater than comparison
1117 /// Regards both *this as a signed quantity and compares it with RHS for
1118 /// the validity of the greater-than relationship.
1120 /// \returns true if *this > RHS when considered signed.
1121 bool sgt(uint64_t RHS) const { return sgt(APInt(getBitWidth(), RHS)); }
1123 /// \brief Unsigned greater or equal comparison
1125 /// Regards both *this and RHS as unsigned quantities and compares them for
1126 /// validity of the greater-or-equal relationship.
1128 /// \returns true if *this >= RHS when both are considered unsigned.
1129 bool uge(const APInt &RHS) const { return !ult(RHS); }
1131 /// \brief Unsigned greater or equal comparison
1133 /// Regards both *this as an unsigned quantity and compares it with RHS for
1134 /// the validity of the greater-or-equal relationship.
1136 /// \returns true if *this >= RHS when considered unsigned.
1137 bool uge(uint64_t RHS) const { return uge(APInt(getBitWidth(), RHS)); }
1139 /// \brief Signed greather or equal comparison
1141 /// Regards both *this and RHS as signed quantities and compares them for
1142 /// validity of the greater-or-equal relationship.
1144 /// \returns true if *this >= RHS when both are considered signed.
1145 bool sge(const APInt &RHS) const { return !slt(RHS); }
1147 /// \brief Signed greater or equal comparison
1149 /// Regards both *this as a signed quantity and compares it with RHS for
1150 /// the validity of the greater-or-equal relationship.
1152 /// \returns true if *this >= RHS when considered signed.
1153 bool sge(uint64_t RHS) const { return sge(APInt(getBitWidth(), RHS)); }
1155 /// This operation tests if there are any pairs of corresponding bits
1156 /// between this APInt and RHS that are both set.
1157 bool intersects(const APInt &RHS) const { return (*this & RHS) != 0; }
1160 /// \name Resizing Operators
1163 /// \brief Truncate to new width.
1165 /// Truncate the APInt to a specified width. It is an error to specify a width
1166 /// that is greater than or equal to the current width.
1167 APInt LLVM_ATTRIBUTE_UNUSED_RESULT trunc(unsigned width) const;
1169 /// \brief Sign extend to a new width.
1171 /// This operation sign extends the APInt to a new width. If the high order
1172 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
1173 /// It is an error to specify a width that is less than or equal to the
1175 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sext(unsigned width) const;
1177 /// \brief Zero extend to a new width.
1179 /// This operation zero extends the APInt to a new width. The high order bits
1180 /// are filled with 0 bits. It is an error to specify a width that is less
1181 /// than or equal to the current width.
1182 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zext(unsigned width) const;
1184 /// \brief Sign extend or truncate to width
1186 /// Make this APInt have the bit width given by \p width. The value is sign
1187 /// extended, truncated, or left alone to make it that width.
1188 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrTrunc(unsigned width) const;
1190 /// \brief Zero extend or truncate to width
1192 /// Make this APInt have the bit width given by \p width. The value is zero
1193 /// extended, truncated, or left alone to make it that width.
1194 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrTrunc(unsigned width) const;
1196 /// \brief Sign extend or truncate to width
1198 /// Make this APInt have the bit width given by \p width. The value is sign
1199 /// extended, or left alone to make it that width.
1200 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrSelf(unsigned width) const;
1202 /// \brief Zero extend or truncate to width
1204 /// Make this APInt have the bit width given by \p width. The value is zero
1205 /// extended, or left alone to make it that width.
1206 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrSelf(unsigned width) const;
1209 /// \name Bit Manipulation Operators
1212 /// \brief Set every bit to 1.
1217 // Set all the bits in all the words.
1218 for (unsigned i = 0; i < getNumWords(); ++i)
1219 pVal[i] = UINT64_MAX;
1221 // Clear the unused ones
1225 /// \brief Set a given bit to 1.
1227 /// Set the given bit to 1 whose position is given as "bitPosition".
1228 void setBit(unsigned bitPosition);
1230 /// \brief Set every bit to 0.
1231 void clearAllBits() {
1235 memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
1238 /// \brief Set a given bit to 0.
1240 /// Set the given bit to 0 whose position is given as "bitPosition".
1241 void clearBit(unsigned bitPosition);
1243 /// \brief Toggle every bit to its opposite value.
1244 void flipAllBits() {
1248 for (unsigned i = 0; i < getNumWords(); ++i)
1249 pVal[i] ^= UINT64_MAX;
1254 /// \brief Toggles a given bit to its opposite value.
1256 /// Toggle a given bit to its opposite value whose position is given
1257 /// as "bitPosition".
1258 void flipBit(unsigned bitPosition);
1261 /// \name Value Characterization Functions
1264 /// \brief Return the number of bits in the APInt.
1265 unsigned getBitWidth() const { return BitWidth; }
1267 /// \brief Get the number of words.
1269 /// Here one word's bitwidth equals to that of uint64_t.
1271 /// \returns the number of words to hold the integer value of this APInt.
1272 unsigned getNumWords() const { return getNumWords(BitWidth); }
1274 /// \brief Get the number of words.
1276 /// *NOTE* Here one word's bitwidth equals to that of uint64_t.
1278 /// \returns the number of words to hold the integer value with a given bit
1280 static unsigned getNumWords(unsigned BitWidth) {
1281 return ((uint64_t)BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1284 /// \brief Compute the number of active bits in the value
1286 /// This function returns the number of active bits which is defined as the
1287 /// bit width minus the number of leading zeros. This is used in several
1288 /// computations to see how "wide" the value is.
1289 unsigned getActiveBits() const { return BitWidth - countLeadingZeros(); }
1291 /// \brief Compute the number of active words in the value of this APInt.
1293 /// This is used in conjunction with getActiveData to extract the raw value of
1295 unsigned getActiveWords() const {
1296 unsigned numActiveBits = getActiveBits();
1297 return numActiveBits ? whichWord(numActiveBits - 1) + 1 : 1;
1300 /// \brief Get the minimum bit size for this signed APInt
1302 /// Computes the minimum bit width for this APInt while considering it to be a
1303 /// signed (and probably negative) value. If the value is not negative, this
1304 /// function returns the same value as getActiveBits()+1. Otherwise, it
1305 /// returns the smallest bit width that will retain the negative value. For
1306 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1307 /// for -1, this function will always return 1.
1308 unsigned getMinSignedBits() const {
1310 return BitWidth - countLeadingOnes() + 1;
1311 return getActiveBits() + 1;
1314 /// \brief Get zero extended value
1316 /// This method attempts to return the value of this APInt as a zero extended
1317 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1318 /// uint64_t. Otherwise an assertion will result.
1319 uint64_t getZExtValue() const {
1322 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1326 /// \brief Get sign extended value
1328 /// This method attempts to return the value of this APInt as a sign extended
1329 /// int64_t. The bit width must be <= 64 or the value must fit within an
1330 /// int64_t. Otherwise an assertion will result.
1331 int64_t getSExtValue() const {
1333 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1334 (APINT_BITS_PER_WORD - BitWidth);
1335 assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
1336 return int64_t(pVal[0]);
1339 /// \brief Get bits required for string value.
1341 /// This method determines how many bits are required to hold the APInt
1342 /// equivalent of the string given by \p str.
1343 static unsigned getBitsNeeded(StringRef str, uint8_t radix);
1345 /// \brief The APInt version of the countLeadingZeros functions in
1348 /// It counts the number of zeros from the most significant bit to the first
1351 /// \returns BitWidth if the value is zero, otherwise returns the number of
1352 /// zeros from the most significant bit to the first one bits.
1353 unsigned countLeadingZeros() const {
1354 if (isSingleWord()) {
1355 unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
1356 return llvm::countLeadingZeros(VAL) - unusedBits;
1358 return countLeadingZerosSlowCase();
1361 /// \brief Count the number of leading one bits.
1363 /// This function is an APInt version of the countLeadingOnes
1364 /// functions in MathExtras.h. It counts the number of ones from the most
1365 /// significant bit to the first zero bit.
1367 /// \returns 0 if the high order bit is not set, otherwise returns the number
1368 /// of 1 bits from the most significant to the least
1369 unsigned countLeadingOnes() const;
1371 /// Computes the number of leading bits of this APInt that are equal to its
1373 unsigned getNumSignBits() const {
1374 return isNegative() ? countLeadingOnes() : countLeadingZeros();
1377 /// \brief Count the number of trailing zero bits.
1379 /// This function is an APInt version of the countTrailingZeros
1380 /// functions in MathExtras.h. It counts the number of zeros from the least
1381 /// significant bit to the first set bit.
1383 /// \returns BitWidth if the value is zero, otherwise returns the number of
1384 /// zeros from the least significant bit to the first one bit.
1385 unsigned countTrailingZeros() const;
1387 /// \brief Count the number of trailing one bits.
1389 /// This function is an APInt version of the countTrailingOnes
1390 /// functions in MathExtras.h. It counts the number of ones from the least
1391 /// significant bit to the first zero bit.
1393 /// \returns BitWidth if the value is all ones, otherwise returns the number
1394 /// of ones from the least significant bit to the first zero bit.
1395 unsigned countTrailingOnes() const {
1397 return llvm::countTrailingOnes(VAL);
1398 return countTrailingOnesSlowCase();
1401 /// \brief Count the number of bits set.
1403 /// This function is an APInt version of the countPopulation functions
1404 /// in MathExtras.h. It counts the number of 1 bits in the APInt value.
1406 /// \returns 0 if the value is zero, otherwise returns the number of set bits.
1407 unsigned countPopulation() const {
1409 return llvm::countPopulation(VAL);
1410 return countPopulationSlowCase();
1414 /// \name Conversion Functions
1416 void print(raw_ostream &OS, bool isSigned) const;
1418 /// Converts an APInt to a string and append it to Str. Str is commonly a
1420 void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
1421 bool formatAsCLiteral = false) const;
1423 /// Considers the APInt to be unsigned and converts it into a string in the
1424 /// radix given. The radix can be 2, 8, 10 16, or 36.
1425 void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1426 toString(Str, Radix, false, false);
1429 /// Considers the APInt to be signed and converts it into a string in the
1430 /// radix given. The radix can be 2, 8, 10, 16, or 36.
1431 void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1432 toString(Str, Radix, true, false);
1435 /// \brief Return the APInt as a std::string.
1437 /// Note that this is an inefficient method. It is better to pass in a
1438 /// SmallVector/SmallString to the methods above to avoid thrashing the heap
1440 std::string toString(unsigned Radix, bool Signed) const;
1442 /// \returns a byte-swapped representation of this APInt Value.
1443 APInt LLVM_ATTRIBUTE_UNUSED_RESULT byteSwap() const;
1445 /// \brief Converts this APInt to a double value.
1446 double roundToDouble(bool isSigned) const;
1448 /// \brief Converts this unsigned APInt to a double value.
1449 double roundToDouble() const { return roundToDouble(false); }
1451 /// \brief Converts this signed APInt to a double value.
1452 double signedRoundToDouble() const { return roundToDouble(true); }
1454 /// \brief Converts APInt bits to a double
1456 /// The conversion does not do a translation from integer to double, it just
1457 /// re-interprets the bits as a double. Note that it is valid to do this on
1458 /// any bit width. Exactly 64 bits will be translated.
1459 double bitsToDouble() const {
1464 T.I = (isSingleWord() ? VAL : pVal[0]);
1468 /// \brief Converts APInt bits to a double
1470 /// The conversion does not do a translation from integer to float, it just
1471 /// re-interprets the bits as a float. Note that it is valid to do this on
1472 /// any bit width. Exactly 32 bits will be translated.
1473 float bitsToFloat() const {
1478 T.I = unsigned((isSingleWord() ? VAL : pVal[0]));
1482 /// \brief Converts a double to APInt bits.
1484 /// The conversion does not do a translation from double to integer, it just
1485 /// re-interprets the bits of the double.
1486 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT doubleToBits(double V) {
1492 return APInt(sizeof T * CHAR_BIT, T.I);
1495 /// \brief Converts a float to APInt bits.
1497 /// The conversion does not do a translation from float to integer, it just
1498 /// re-interprets the bits of the float.
1499 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT floatToBits(float V) {
1505 return APInt(sizeof T * CHAR_BIT, T.I);
1509 /// \name Mathematics Operations
1512 /// \returns the floor log base 2 of this APInt.
1513 unsigned logBase2() const { return BitWidth - 1 - countLeadingZeros(); }
1515 /// \returns the ceil log base 2 of this APInt.
1516 unsigned ceilLogBase2() const {
1517 return BitWidth - (*this - 1).countLeadingZeros();
1520 /// \returns the nearest log base 2 of this APInt. Ties round up.
1522 /// NOTE: When we have a BitWidth of 1, we define:
1524 /// log2(0) = UINT32_MAX
1527 /// to get around any mathematical concerns resulting from
1528 /// referencing 2 in a space where 2 does no exist.
1529 unsigned nearestLogBase2() const {
1530 // Special case when we have a bitwidth of 1. If VAL is 1, then we
1531 // get 0. If VAL is 0, we get UINT64_MAX which gets truncated to
1536 // Handle the zero case.
1537 if (!getBoolValue())
1540 // The non-zero case is handled by computing:
1542 // nearestLogBase2(x) = logBase2(x) + x[logBase2(x)-1].
1544 // where x[i] is referring to the value of the ith bit of x.
1545 unsigned lg = logBase2();
1546 return lg + unsigned((*this)[lg - 1]);
1549 /// \returns the log base 2 of this APInt if its an exact power of two, -1
1551 int32_t exactLogBase2() const {
1557 /// \brief Compute the square root
1558 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sqrt() const;
1560 /// \brief Get the absolute value;
1562 /// If *this is < 0 then return -(*this), otherwise *this;
1563 APInt LLVM_ATTRIBUTE_UNUSED_RESULT abs() const {
1569 /// \returns the multiplicative inverse for a given modulo.
1570 APInt multiplicativeInverse(const APInt &modulo) const;
1573 /// \name Support for division by constant
1576 /// Calculate the magic number for signed division by a constant.
1580 /// Calculate the magic number for unsigned division by a constant.
1582 mu magicu(unsigned LeadingZeros = 0) const;
1585 /// \name Building-block Operations for APInt and APFloat
1588 // These building block operations operate on a representation of arbitrary
1589 // precision, two's-complement, bignum integer values. They should be
1590 // sufficient to implement APInt and APFloat bignum requirements. Inputs are
1591 // generally a pointer to the base of an array of integer parts, representing
1592 // an unsigned bignum, and a count of how many parts there are.
1594 /// Sets the least significant part of a bignum to the input value, and zeroes
1595 /// out higher parts.
1596 static void tcSet(integerPart *, integerPart, unsigned int);
1598 /// Assign one bignum to another.
1599 static void tcAssign(integerPart *, const integerPart *, unsigned int);
1601 /// Returns true if a bignum is zero, false otherwise.
1602 static bool tcIsZero(const integerPart *, unsigned int);
1604 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1605 static int tcExtractBit(const integerPart *, unsigned int bit);
1607 /// Copy the bit vector of width srcBITS from SRC, starting at bit srcLSB, to
1608 /// DST, of dstCOUNT parts, such that the bit srcLSB becomes the least
1609 /// significant bit of DST. All high bits above srcBITS in DST are
1611 static void tcExtract(integerPart *, unsigned int dstCount,
1612 const integerPart *, unsigned int srcBits,
1613 unsigned int srcLSB);
1615 /// Set the given bit of a bignum. Zero-based.
1616 static void tcSetBit(integerPart *, unsigned int bit);
1618 /// Clear the given bit of a bignum. Zero-based.
1619 static void tcClearBit(integerPart *, unsigned int bit);
1621 /// Returns the bit number of the least or most significant set bit of a
1622 /// number. If the input number has no bits set -1U is returned.
1623 static unsigned int tcLSB(const integerPart *, unsigned int);
1624 static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1626 /// Negate a bignum in-place.
1627 static void tcNegate(integerPart *, unsigned int);
1629 /// DST += RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1630 static integerPart tcAdd(integerPart *, const integerPart *,
1631 integerPart carry, unsigned);
1633 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1634 static integerPart tcSubtract(integerPart *, const integerPart *,
1635 integerPart carry, unsigned);
1637 /// DST += SRC * MULTIPLIER + PART if add is true
1638 /// DST = SRC * MULTIPLIER + PART if add is false
1640 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC they must
1641 /// start at the same point, i.e. DST == SRC.
1643 /// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is returned.
1644 /// Otherwise DST is filled with the least significant DSTPARTS parts of the
1645 /// result, and if all of the omitted higher parts were zero return zero,
1646 /// otherwise overflow occurred and return one.
1647 static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1648 integerPart multiplier, integerPart carry,
1649 unsigned int srcParts, unsigned int dstParts,
1652 /// DST = LHS * RHS, where DST has the same width as the operands and is
1653 /// filled with the least significant parts of the result. Returns one if
1654 /// overflow occurred, otherwise zero. DST must be disjoint from both
1656 static int tcMultiply(integerPart *, const integerPart *, const integerPart *,
1659 /// DST = LHS * RHS, where DST has width the sum of the widths of the
1660 /// operands. No overflow occurs. DST must be disjoint from both
1661 /// operands. Returns the number of parts required to hold the result.
1662 static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1663 const integerPart *, unsigned, unsigned);
1665 /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1666 /// Otherwise set LHS to LHS / RHS with the fractional part discarded, set
1667 /// REMAINDER to the remainder, return zero. i.e.
1669 /// OLD_LHS = RHS * LHS + REMAINDER
1671 /// SCRATCH is a bignum of the same size as the operands and result for use by
1672 /// the routine; its contents need not be initialized and are destroyed. LHS,
1673 /// REMAINDER and SCRATCH must be distinct.
1674 static int tcDivide(integerPart *lhs, const integerPart *rhs,
1675 integerPart *remainder, integerPart *scratch,
1676 unsigned int parts);
1678 /// Shift a bignum left COUNT bits. Shifted in bits are zero. There are no
1679 /// restrictions on COUNT.
1680 static void tcShiftLeft(integerPart *, unsigned int parts,
1681 unsigned int count);
1683 /// Shift a bignum right COUNT bits. Shifted in bits are zero. There are no
1684 /// restrictions on COUNT.
1685 static void tcShiftRight(integerPart *, unsigned int parts,
1686 unsigned int count);
1688 /// The obvious AND, OR and XOR and complement operations.
1689 static void tcAnd(integerPart *, const integerPart *, unsigned int);
1690 static void tcOr(integerPart *, const integerPart *, unsigned int);
1691 static void tcXor(integerPart *, const integerPart *, unsigned int);
1692 static void tcComplement(integerPart *, unsigned int);
1694 /// Comparison (unsigned) of two bignums.
1695 static int tcCompare(const integerPart *, const integerPart *, unsigned int);
1697 /// Increment a bignum in-place. Return the carry flag.
1698 static integerPart tcIncrement(integerPart *, unsigned int);
1700 /// Decrement a bignum in-place. Return the borrow flag.
1701 static integerPart tcDecrement(integerPart *, unsigned int);
1703 /// Set the least significant BITS and clear the rest.
1704 static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1707 /// \brief debug method
1713 /// Magic data for optimising signed division by a constant.
1715 APInt m; ///< magic number
1716 unsigned s; ///< shift amount
1719 /// Magic data for optimising unsigned division by a constant.
1721 APInt m; ///< magic number
1722 bool a; ///< add indicator
1723 unsigned s; ///< shift amount
1726 inline bool operator==(uint64_t V1, const APInt &V2) { return V2 == V1; }
1728 inline bool operator!=(uint64_t V1, const APInt &V2) { return V2 != V1; }
1730 inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
1735 namespace APIntOps {
1737 /// \brief Determine the smaller of two APInts considered to be signed.
1738 inline APInt smin(const APInt &A, const APInt &B) { return A.slt(B) ? A : B; }
1740 /// \brief Determine the larger of two APInts considered to be signed.
1741 inline APInt smax(const APInt &A, const APInt &B) { return A.sgt(B) ? A : B; }
1743 /// \brief Determine the smaller of two APInts considered to be signed.
1744 inline APInt umin(const APInt &A, const APInt &B) { return A.ult(B) ? A : B; }
1746 /// \brief Determine the larger of two APInts considered to be unsigned.
1747 inline APInt umax(const APInt &A, const APInt &B) { return A.ugt(B) ? A : B; }
1749 /// \brief Check if the specified APInt has a N-bits unsigned integer value.
1750 inline bool isIntN(unsigned N, const APInt &APIVal) { return APIVal.isIntN(N); }
1752 /// \brief Check if the specified APInt has a N-bits signed integer value.
1753 inline bool isSignedIntN(unsigned N, const APInt &APIVal) {
1754 return APIVal.isSignedIntN(N);
1757 /// \returns true if the argument APInt value is a sequence of ones starting at
1758 /// the least significant bit with the remainder zero.
1759 inline bool isMask(unsigned numBits, const APInt &APIVal) {
1760 return numBits <= APIVal.getBitWidth() &&
1761 APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
1764 /// \brief Return true if the argument APInt value contains a sequence of ones
1765 /// with the remainder zero.
1766 inline bool isShiftedMask(unsigned numBits, const APInt &APIVal) {
1767 return isMask(numBits, (APIVal - APInt(numBits, 1)) | APIVal);
1770 /// \brief Returns a byte-swapped representation of the specified APInt Value.
1771 inline APInt byteSwap(const APInt &APIVal) { return APIVal.byteSwap(); }
1773 /// \brief Returns the floor log base 2 of the specified APInt value.
1774 inline unsigned logBase2(const APInt &APIVal) { return APIVal.logBase2(); }
1776 /// \brief Compute GCD of two APInt values.
1778 /// This function returns the greatest common divisor of the two APInt values
1779 /// using Euclid's algorithm.
1781 /// \returns the greatest common divisor of Val1 and Val2
1782 APInt GreatestCommonDivisor(const APInt &Val1, const APInt &Val2);
1784 /// \brief Converts the given APInt to a double value.
1786 /// Treats the APInt as an unsigned value for conversion purposes.
1787 inline double RoundAPIntToDouble(const APInt &APIVal) {
1788 return APIVal.roundToDouble();
1791 /// \brief Converts the given APInt to a double value.
1793 /// Treats the APInt as a signed value for conversion purposes.
1794 inline double RoundSignedAPIntToDouble(const APInt &APIVal) {
1795 return APIVal.signedRoundToDouble();
1798 /// \brief Converts the given APInt to a float vlalue.
1799 inline float RoundAPIntToFloat(const APInt &APIVal) {
1800 return float(RoundAPIntToDouble(APIVal));
1803 /// \brief Converts the given APInt to a float value.
1805 /// Treast the APInt as a signed value for conversion purposes.
1806 inline float RoundSignedAPIntToFloat(const APInt &APIVal) {
1807 return float(APIVal.signedRoundToDouble());
1810 /// \brief Converts the given double value into a APInt.
1812 /// This function convert a double value to an APInt value.
1813 APInt RoundDoubleToAPInt(double Double, unsigned width);
1815 /// \brief Converts a float value into a APInt.
1817 /// Converts a float value into an APInt value.
1818 inline APInt RoundFloatToAPInt(float Float, unsigned width) {
1819 return RoundDoubleToAPInt(double(Float), width);
1822 /// \brief Arithmetic right-shift function.
1824 /// Arithmetic right-shift the APInt by shiftAmt.
1825 inline APInt ashr(const APInt &LHS, unsigned shiftAmt) {
1826 return LHS.ashr(shiftAmt);
1829 /// \brief Logical right-shift function.
1831 /// Logical right-shift the APInt by shiftAmt.
1832 inline APInt lshr(const APInt &LHS, unsigned shiftAmt) {
1833 return LHS.lshr(shiftAmt);
1836 /// \brief Left-shift function.
1838 /// Left-shift the APInt by shiftAmt.
1839 inline APInt shl(const APInt &LHS, unsigned shiftAmt) {
1840 return LHS.shl(shiftAmt);
1843 /// \brief Signed division function for APInt.
1845 /// Signed divide APInt LHS by APInt RHS.
1846 inline APInt sdiv(const APInt &LHS, const APInt &RHS) { return LHS.sdiv(RHS); }
1848 /// \brief Unsigned division function for APInt.
1850 /// Unsigned divide APInt LHS by APInt RHS.
1851 inline APInt udiv(const APInt &LHS, const APInt &RHS) { return LHS.udiv(RHS); }
1853 /// \brief Function for signed remainder operation.
1855 /// Signed remainder operation on APInt.
1856 inline APInt srem(const APInt &LHS, const APInt &RHS) { return LHS.srem(RHS); }
1858 /// \brief Function for unsigned remainder operation.
1860 /// Unsigned remainder operation on APInt.
1861 inline APInt urem(const APInt &LHS, const APInt &RHS) { return LHS.urem(RHS); }
1863 /// \brief Function for multiplication operation.
1865 /// Performs multiplication on APInt values.
1866 inline APInt mul(const APInt &LHS, const APInt &RHS) { return LHS * RHS; }
1868 /// \brief Function for addition operation.
1870 /// Performs addition on APInt values.
1871 inline APInt add(const APInt &LHS, const APInt &RHS) { return LHS + RHS; }
1873 /// \brief Function for subtraction operation.
1875 /// Performs subtraction on APInt values.
1876 inline APInt sub(const APInt &LHS, const APInt &RHS) { return LHS - RHS; }
1878 /// \brief Bitwise AND function for APInt.
1880 /// Performs bitwise AND operation on APInt LHS and
1882 inline APInt And(const APInt &LHS, const APInt &RHS) { return LHS & RHS; }
1884 /// \brief Bitwise OR function for APInt.
1886 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1887 inline APInt Or(const APInt &LHS, const APInt &RHS) { return LHS | RHS; }
1889 /// \brief Bitwise XOR function for APInt.
1891 /// Performs bitwise XOR operation on APInt.
1892 inline APInt Xor(const APInt &LHS, const APInt &RHS) { return LHS ^ RHS; }
1894 /// \brief Bitwise complement function.
1896 /// Performs a bitwise complement operation on APInt.
1897 inline APInt Not(const APInt &APIVal) { return ~APIVal; }
1899 } // End of APIntOps namespace
1901 // See friend declaration above. This additional declaration is required in
1902 // order to compile LLVM with IBM xlC compiler.
1903 hash_code hash_value(const APInt &Arg);
1904 } // End of llvm namespace