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"
29 class FoldingSetNodeID;
35 template <typename T> class SmallVectorImpl;
37 // An unsigned host type used as a single part of a multi-part
39 typedef uint64_t integerPart;
41 const unsigned int host_char_bit = 8;
42 const unsigned int integerPartWidth =
43 host_char_bit * static_cast<unsigned int>(sizeof(integerPart));
45 //===----------------------------------------------------------------------===//
47 //===----------------------------------------------------------------------===//
49 /// \brief Class for arbitrary precision integers.
51 /// APInt is a functional replacement for common case unsigned integer type like
52 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
53 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
54 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
55 /// and methods to manipulate integer values of any bit-width. It supports both
56 /// the typical integer arithmetic and comparison operations as well as bitwise
59 /// The class has several invariants worth noting:
60 /// * All bit, byte, and word positions are zero-based.
61 /// * Once the bit width is set, it doesn't change except by the Truncate,
62 /// SignExtend, or ZeroExtend operations.
63 /// * All binary operators must be on APInt instances of the same bit width.
64 /// Attempting to use these operators on instances with different bit
65 /// widths will yield an assertion.
66 /// * The value is stored canonically as an unsigned value. For operations
67 /// where it makes a difference, there are both signed and unsigned variants
68 /// of the operation. For example, sdiv and udiv. However, because the bit
69 /// widths must be the same, operations such as Mul and Add produce the same
70 /// results regardless of whether the values are interpreted as signed or
72 /// * In general, the class tries to follow the style of computation that LLVM
73 /// uses in its IR. This simplifies its use for LLVM.
76 unsigned BitWidth; ///< The number of bits in this APInt.
78 /// This union is used to store the integer value. When the
79 /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
81 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
82 uint64_t *pVal; ///< Used to store the >64 bits integer value.
85 /// This enum is used to hold the constants we needed for APInt.
89 static_cast<unsigned int>(sizeof(uint64_t)) * CHAR_BIT,
90 /// Byte size of a word
91 APINT_WORD_SIZE = static_cast<unsigned int>(sizeof(uint64_t))
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 to "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) {
280 assert(BitWidth && "bitwidth too small");
287 /// \brief Move Constructor.
288 APInt(APInt &&that) : BitWidth(that.BitWidth), VAL(that.VAL) {
292 /// \brief Destructor.
298 /// \brief Default constructor that creates an uninitialized APInt.
300 /// This is useful for object deserialization (pair this with the static
302 explicit APInt() : BitWidth(1) {}
304 /// \brief Returns whether this instance allocated memory.
305 bool needsCleanup() const { return !isSingleWord(); }
307 /// Used to insert APInt objects, or objects that contain APInt objects, into
309 void Profile(FoldingSetNodeID &id) const;
312 /// \name Value Tests
315 /// \brief Determine sign of this APInt.
317 /// This tests the high bit of this APInt to determine if it is set.
319 /// \returns true if this APInt is negative, false otherwise
320 bool isNegative() const { return (*this)[BitWidth - 1]; }
322 /// \brief Determine if this APInt Value is non-negative (>= 0)
324 /// This tests the high bit of the APInt to determine if it is unset.
325 bool isNonNegative() const { return !isNegative(); }
327 /// \brief Determine if this APInt Value is positive.
329 /// This tests if the value of this APInt is positive (> 0). Note
330 /// that 0 is not a positive value.
332 /// \returns true if this APInt is positive.
333 bool isStrictlyPositive() const { return isNonNegative() && !!*this; }
335 /// \brief Determine if all bits are set
337 /// This checks to see if the value has all bits of the APInt are set or not.
338 bool isAllOnesValue() const {
340 return VAL == ~integerPart(0) >> (APINT_BITS_PER_WORD - BitWidth);
341 return countPopulationSlowCase() == BitWidth;
344 /// \brief Determine if this is the largest unsigned value.
346 /// This checks to see if the value of this APInt is the maximum unsigned
347 /// value for the APInt's bit width.
348 bool isMaxValue() const { return isAllOnesValue(); }
350 /// \brief Determine if this is the largest signed value.
352 /// This checks to see if the value of this APInt is the maximum signed
353 /// value for the APInt's bit width.
354 bool isMaxSignedValue() const {
355 return BitWidth == 1 ? VAL == 0
356 : !isNegative() && countPopulation() == BitWidth - 1;
359 /// \brief Determine if this is the smallest unsigned value.
361 /// This checks to see if the value of this APInt is the minimum unsigned
362 /// value for the APInt's bit width.
363 bool isMinValue() const { return !*this; }
365 /// \brief Determine if this is the smallest signed value.
367 /// This checks to see if the value of this APInt is the minimum signed
368 /// value for the APInt's bit width.
369 bool isMinSignedValue() const {
370 return BitWidth == 1 ? VAL == 1 : isNegative() && isPowerOf2();
373 /// \brief Check if this APInt has an N-bits unsigned integer value.
374 bool isIntN(unsigned N) const {
375 assert(N && "N == 0 ???");
376 return getActiveBits() <= N;
379 /// \brief Check if this APInt has an N-bits signed integer value.
380 bool isSignedIntN(unsigned N) const {
381 assert(N && "N == 0 ???");
382 return getMinSignedBits() <= N;
385 /// \brief Check if this APInt's value is a power of two greater than zero.
387 /// \returns true if the argument APInt value is a power of two > 0.
388 bool isPowerOf2() const {
390 return isPowerOf2_64(VAL);
391 return countPopulationSlowCase() == 1;
394 /// \brief Check if the APInt's value is returned by getSignBit.
396 /// \returns true if this is the value returned by getSignBit.
397 bool isSignBit() const { return isMinSignedValue(); }
399 /// \brief Convert APInt to a boolean value.
401 /// This converts the APInt to a boolean value as a test against zero.
402 bool getBoolValue() const { return !!*this; }
404 /// If this value is smaller than the specified limit, return it, otherwise
405 /// return the limit value. This causes the value to saturate to the limit.
406 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
407 return (getActiveBits() > 64 || getZExtValue() > Limit) ? Limit
412 /// \name Value Generators
415 /// \brief Gets maximum unsigned value of APInt for specific bit width.
416 static APInt getMaxValue(unsigned numBits) {
417 return getAllOnesValue(numBits);
420 /// \brief Gets maximum signed value of APInt for a specific bit width.
421 static APInt getSignedMaxValue(unsigned numBits) {
422 APInt API = getAllOnesValue(numBits);
423 API.clearBit(numBits - 1);
427 /// \brief Gets minimum unsigned value of APInt for a specific bit width.
428 static APInt getMinValue(unsigned numBits) { return APInt(numBits, 0); }
430 /// \brief Gets minimum signed value of APInt for a specific bit width.
431 static APInt getSignedMinValue(unsigned numBits) {
432 APInt API(numBits, 0);
433 API.setBit(numBits - 1);
437 /// \brief Get the SignBit for a specific bit width.
439 /// This is just a wrapper function of getSignedMinValue(), and it helps code
440 /// readability when we want to get a SignBit.
441 static APInt getSignBit(unsigned BitWidth) {
442 return getSignedMinValue(BitWidth);
445 /// \brief Get the all-ones value.
447 /// \returns the all-ones value for an APInt of the specified bit-width.
448 static APInt getAllOnesValue(unsigned numBits) {
449 return APInt(numBits, UINT64_MAX, true);
452 /// \brief Get the '0' value.
454 /// \returns the '0' value for an APInt of the specified bit-width.
455 static APInt getNullValue(unsigned numBits) { return APInt(numBits, 0); }
457 /// \brief Compute an APInt containing numBits highbits from this APInt.
459 /// Get an APInt with the same BitWidth as this APInt, just zero mask
460 /// the low bits and right shift to the least significant bit.
462 /// \returns the high "numBits" bits of this APInt.
463 APInt getHiBits(unsigned numBits) const;
465 /// \brief Compute an APInt containing numBits lowbits from this APInt.
467 /// Get an APInt with the same BitWidth as this APInt, just zero mask
470 /// \returns the low "numBits" bits of this APInt.
471 APInt getLoBits(unsigned numBits) const;
473 /// \brief Return an APInt with exactly one bit set in the result.
474 static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
475 APInt Res(numBits, 0);
480 /// \brief Get a value with a block of bits set.
482 /// Constructs an APInt value that has a contiguous range of bits set. The
483 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
484 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
485 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
486 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
488 /// \param numBits the intended bit width of the result
489 /// \param loBit the index of the lowest bit set.
490 /// \param hiBit the index of the highest bit set.
492 /// \returns An APInt value with the requested bits set.
493 static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
494 assert(hiBit <= numBits && "hiBit out of range");
495 assert(loBit < numBits && "loBit out of range");
497 return getLowBitsSet(numBits, hiBit) |
498 getHighBitsSet(numBits, numBits - loBit);
499 return getLowBitsSet(numBits, hiBit - loBit).shl(loBit);
502 /// \brief Get a value with high bits set
504 /// Constructs an APInt value that has the top hiBitsSet bits set.
506 /// \param numBits the bitwidth of the result
507 /// \param hiBitsSet the number of high-order bits set in the result.
508 static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
509 assert(hiBitsSet <= numBits && "Too many bits to set!");
510 // Handle a degenerate case, to avoid shifting by word size
512 return APInt(numBits, 0);
513 unsigned shiftAmt = numBits - hiBitsSet;
514 // For small values, return quickly
515 if (numBits <= APINT_BITS_PER_WORD)
516 return APInt(numBits, ~0ULL << shiftAmt);
517 return getAllOnesValue(numBits).shl(shiftAmt);
520 /// \brief Get a value with low bits set
522 /// Constructs an APInt value that has the bottom loBitsSet bits set.
524 /// \param numBits the bitwidth of the result
525 /// \param loBitsSet the number of low-order bits set in the result.
526 static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
527 assert(loBitsSet <= numBits && "Too many bits to set!");
528 // Handle a degenerate case, to avoid shifting by word size
530 return APInt(numBits, 0);
531 if (loBitsSet == APINT_BITS_PER_WORD)
532 return APInt(numBits, UINT64_MAX);
533 // For small values, return quickly.
534 if (loBitsSet <= APINT_BITS_PER_WORD)
535 return APInt(numBits, UINT64_MAX >> (APINT_BITS_PER_WORD - loBitsSet));
536 return getAllOnesValue(numBits).lshr(numBits - loBitsSet);
539 /// \brief Return a value containing V broadcasted over NewLen bits.
540 static APInt getSplat(unsigned NewLen, const APInt &V) {
541 assert(NewLen >= V.getBitWidth() && "Can't splat to smaller bit width!");
543 APInt Val = V.zextOrSelf(NewLen);
544 for (unsigned I = V.getBitWidth(); I < NewLen; I <<= 1)
550 /// \brief Determine if two APInts have the same value, after zero-extending
551 /// one of them (if needed!) to ensure that the bit-widths match.
552 static bool isSameValue(const APInt &I1, const APInt &I2) {
553 if (I1.getBitWidth() == I2.getBitWidth())
556 if (I1.getBitWidth() > I2.getBitWidth())
557 return I1 == I2.zext(I1.getBitWidth());
559 return I1.zext(I2.getBitWidth()) == I2;
562 /// \brief Overload to compute a hash_code for an APInt value.
563 friend hash_code hash_value(const APInt &Arg);
565 /// This function returns a pointer to the internal storage of the APInt.
566 /// This is useful for writing out the APInt in binary form without any
568 const uint64_t *getRawData() const {
575 /// \name Unary Operators
578 /// \brief Postfix increment operator.
580 /// \returns a new APInt value representing *this incremented by one
581 const APInt operator++(int) {
587 /// \brief Prefix increment operator.
589 /// \returns *this incremented by one
592 /// \brief Postfix decrement operator.
594 /// \returns a new APInt representing *this decremented by one.
595 const APInt operator--(int) {
601 /// \brief Prefix decrement operator.
603 /// \returns *this decremented by one.
606 /// \brief Unary bitwise complement operator.
608 /// Performs a bitwise complement operation on this APInt.
610 /// \returns an APInt that is the bitwise complement of *this
611 APInt operator~() const {
613 Result.flipAllBits();
617 /// \brief Unary negation operator
619 /// Negates *this using two's complement logic.
621 /// \returns An APInt value representing the negation of *this.
622 APInt operator-() const { return APInt(BitWidth, 0) - (*this); }
624 /// \brief Logical negation operator.
626 /// Performs logical negation operation on this APInt.
628 /// \returns true if *this is zero, false otherwise.
629 bool operator!() const {
633 for (unsigned i = 0; i != getNumWords(); ++i)
640 /// \name Assignment Operators
643 /// \brief Copy assignment operator.
645 /// \returns *this after assignment of RHS.
646 APInt &operator=(const APInt &RHS) {
647 // If the bitwidths are the same, we can avoid mucking with memory
648 if (isSingleWord() && RHS.isSingleWord()) {
650 BitWidth = RHS.BitWidth;
651 return clearUnusedBits();
654 return AssignSlowCase(RHS);
657 /// @brief Move assignment operator.
658 APInt &operator=(APInt &&that) {
659 if (!isSingleWord()) {
660 // The MSVC STL shipped in 2013 requires that self move assignment be a
661 // no-op. Otherwise algorithms like stable_sort will produce answers
662 // where half of the output is left in a moved-from state.
668 // Use memcpy so that type based alias analysis sees both VAL and pVal
670 memcpy(&VAL, &that.VAL, sizeof(uint64_t));
672 // If 'this == &that', avoid zeroing our own bitwidth by storing to 'that'
674 unsigned ThatBitWidth = that.BitWidth;
676 BitWidth = ThatBitWidth;
681 /// \brief Assignment operator.
683 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
684 /// the bit width, the excess bits are truncated. If the bit width is larger
685 /// than 64, the value is zero filled in the unspecified high order bits.
687 /// \returns *this after assignment of RHS value.
688 APInt &operator=(uint64_t RHS);
690 /// \brief Bitwise AND assignment operator.
692 /// Performs a bitwise AND operation on this APInt and RHS. The result is
693 /// assigned to *this.
695 /// \returns *this after ANDing with RHS.
696 APInt &operator&=(const APInt &RHS);
698 /// \brief Bitwise OR assignment operator.
700 /// Performs a bitwise OR operation on this APInt and RHS. The result is
703 /// \returns *this after ORing with RHS.
704 APInt &operator|=(const APInt &RHS);
706 /// \brief Bitwise OR assignment operator.
708 /// Performs a bitwise OR operation on this APInt and RHS. RHS is
709 /// logically zero-extended or truncated to match the bit-width of
711 APInt &operator|=(uint64_t RHS) {
712 if (isSingleWord()) {
721 /// \brief Bitwise XOR assignment operator.
723 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
724 /// assigned to *this.
726 /// \returns *this after XORing with RHS.
727 APInt &operator^=(const APInt &RHS);
729 /// \brief Multiplication assignment operator.
731 /// Multiplies this APInt by RHS and assigns the result to *this.
734 APInt &operator*=(const APInt &RHS);
736 /// \brief Addition assignment operator.
738 /// Adds RHS to *this and assigns the result to *this.
741 APInt &operator+=(const APInt &RHS);
743 /// \brief Subtraction assignment operator.
745 /// Subtracts RHS from *this and assigns the result to *this.
748 APInt &operator-=(const APInt &RHS);
750 /// \brief Left-shift assignment function.
752 /// Shifts *this left by shiftAmt and assigns the result to *this.
754 /// \returns *this after shifting left by shiftAmt
755 APInt &operator<<=(unsigned shiftAmt) {
756 *this = shl(shiftAmt);
761 /// \name Binary Operators
764 /// \brief Bitwise AND operator.
766 /// Performs a bitwise AND operation on *this and RHS.
768 /// \returns An APInt value representing the bitwise AND of *this and RHS.
769 APInt operator&(const APInt &RHS) const {
770 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
772 return APInt(getBitWidth(), VAL & RHS.VAL);
773 return AndSlowCase(RHS);
775 APInt LLVM_ATTRIBUTE_UNUSED_RESULT And(const APInt &RHS) const {
776 return this->operator&(RHS);
779 /// \brief Bitwise OR operator.
781 /// Performs a bitwise OR operation on *this and RHS.
783 /// \returns An APInt value representing the bitwise OR of *this and RHS.
784 APInt operator|(const APInt &RHS) const {
785 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
787 return APInt(getBitWidth(), VAL | RHS.VAL);
788 return OrSlowCase(RHS);
791 /// \brief Bitwise OR function.
793 /// Performs a bitwise or on *this and RHS. This is implemented bny simply
794 /// calling operator|.
796 /// \returns An APInt value representing the bitwise OR of *this and RHS.
797 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Or(const APInt &RHS) const {
798 return this->operator|(RHS);
801 /// \brief Bitwise XOR operator.
803 /// Performs a bitwise XOR operation on *this and RHS.
805 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
806 APInt operator^(const APInt &RHS) const {
807 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
809 return APInt(BitWidth, VAL ^ RHS.VAL);
810 return XorSlowCase(RHS);
813 /// \brief Bitwise XOR function.
815 /// Performs a bitwise XOR operation on *this and RHS. This is implemented
816 /// through the usage of operator^.
818 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
819 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Xor(const APInt &RHS) const {
820 return this->operator^(RHS);
823 /// \brief Multiplication operator.
825 /// Multiplies this APInt by RHS and returns the result.
826 APInt operator*(const APInt &RHS) const;
828 /// \brief Addition operator.
830 /// Adds RHS to this APInt and returns the result.
831 APInt operator+(const APInt &RHS) const;
832 APInt operator+(uint64_t RHS) const { return (*this) + APInt(BitWidth, RHS); }
834 /// \brief Subtraction operator.
836 /// Subtracts RHS from this APInt and returns the result.
837 APInt operator-(const APInt &RHS) const;
838 APInt operator-(uint64_t RHS) const { return (*this) - APInt(BitWidth, RHS); }
840 /// \brief Left logical shift operator.
842 /// Shifts this APInt left by \p Bits and returns the result.
843 APInt operator<<(unsigned Bits) const { return shl(Bits); }
845 /// \brief Left logical shift operator.
847 /// Shifts this APInt left by \p Bits and returns the result.
848 APInt operator<<(const APInt &Bits) const { return shl(Bits); }
850 /// \brief Arithmetic right-shift function.
852 /// Arithmetic right-shift this APInt by shiftAmt.
853 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(unsigned shiftAmt) const;
855 /// \brief Logical right-shift function.
857 /// Logical right-shift this APInt by shiftAmt.
858 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(unsigned shiftAmt) const;
860 /// \brief Left-shift function.
862 /// Left-shift this APInt by shiftAmt.
863 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(unsigned shiftAmt) const {
864 assert(shiftAmt <= BitWidth && "Invalid shift amount");
865 if (isSingleWord()) {
866 if (shiftAmt >= BitWidth)
867 return APInt(BitWidth, 0); // avoid undefined shift results
868 return APInt(BitWidth, VAL << shiftAmt);
870 return shlSlowCase(shiftAmt);
873 /// \brief Rotate left by rotateAmt.
874 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(unsigned rotateAmt) const;
876 /// \brief Rotate right by rotateAmt.
877 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(unsigned rotateAmt) const;
879 /// \brief Arithmetic right-shift function.
881 /// Arithmetic right-shift this APInt by shiftAmt.
882 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(const APInt &shiftAmt) const;
884 /// \brief Logical right-shift function.
886 /// Logical right-shift this APInt by shiftAmt.
887 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(const APInt &shiftAmt) const;
889 /// \brief Left-shift function.
891 /// Left-shift this APInt by shiftAmt.
892 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(const APInt &shiftAmt) const;
894 /// \brief Rotate left by rotateAmt.
895 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(const APInt &rotateAmt) const;
897 /// \brief Rotate right by rotateAmt.
898 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(const APInt &rotateAmt) const;
900 /// \brief Unsigned division operation.
902 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
903 /// RHS are treated as unsigned quantities for purposes of this division.
905 /// \returns a new APInt value containing the division result
906 APInt LLVM_ATTRIBUTE_UNUSED_RESULT udiv(const APInt &RHS) const;
908 /// \brief Signed division function for APInt.
910 /// Signed divide this APInt by APInt RHS.
911 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sdiv(const APInt &RHS) const;
913 /// \brief Unsigned remainder operation.
915 /// Perform an unsigned remainder operation on this APInt with RHS being the
916 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
917 /// of this operation. Note that this is a true remainder operation and not a
918 /// modulo operation because the sign follows the sign of the dividend which
921 /// \returns a new APInt value containing the remainder result
922 APInt LLVM_ATTRIBUTE_UNUSED_RESULT urem(const APInt &RHS) const;
924 /// \brief Function for signed remainder operation.
926 /// Signed remainder operation on APInt.
927 APInt LLVM_ATTRIBUTE_UNUSED_RESULT srem(const APInt &RHS) const;
929 /// \brief Dual division/remainder interface.
931 /// Sometimes it is convenient to divide two APInt values and obtain both the
932 /// quotient and remainder. This function does both operations in the same
933 /// computation making it a little more efficient. The pair of input arguments
934 /// may overlap with the pair of output arguments. It is safe to call
935 /// udivrem(X, Y, X, Y), for example.
936 static void udivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
939 static void sdivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
942 // Operations that return overflow indicators.
943 APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
944 APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
945 APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
946 APInt usub_ov(const APInt &RHS, bool &Overflow) const;
947 APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
948 APInt smul_ov(const APInt &RHS, bool &Overflow) const;
949 APInt umul_ov(const APInt &RHS, bool &Overflow) const;
950 APInt sshl_ov(const APInt &Amt, bool &Overflow) const;
951 APInt ushl_ov(const APInt &Amt, bool &Overflow) const;
953 /// \brief Array-indexing support.
955 /// \returns the bit value at bitPosition
956 bool operator[](unsigned bitPosition) const {
957 assert(bitPosition < getBitWidth() && "Bit position out of bounds!");
958 return (maskBit(bitPosition) &
959 (isSingleWord() ? VAL : pVal[whichWord(bitPosition)])) !=
964 /// \name Comparison Operators
967 /// \brief Equality operator.
969 /// Compares this APInt with RHS for the validity of the equality
971 bool operator==(const APInt &RHS) const {
972 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
974 return VAL == RHS.VAL;
975 return EqualSlowCase(RHS);
978 /// \brief Equality operator.
980 /// Compares this APInt with a uint64_t for the validity of the equality
983 /// \returns true if *this == Val
984 bool operator==(uint64_t Val) const {
987 return EqualSlowCase(Val);
990 /// \brief Equality comparison.
992 /// Compares this APInt with RHS for the validity of the equality
995 /// \returns true if *this == Val
996 bool eq(const APInt &RHS) const { return (*this) == RHS; }
998 /// \brief Inequality operator.
1000 /// Compares this APInt with RHS for the validity of the inequality
1003 /// \returns true if *this != Val
1004 bool operator!=(const APInt &RHS) const { return !((*this) == RHS); }
1006 /// \brief Inequality operator.
1008 /// Compares this APInt with a uint64_t for the validity of the inequality
1011 /// \returns true if *this != Val
1012 bool operator!=(uint64_t Val) const { return !((*this) == Val); }
1014 /// \brief Inequality comparison
1016 /// Compares this APInt with RHS for the validity of the inequality
1019 /// \returns true if *this != Val
1020 bool ne(const APInt &RHS) const { return !((*this) == RHS); }
1022 /// \brief Unsigned less than comparison
1024 /// Regards both *this and RHS as unsigned quantities and compares them for
1025 /// the validity of the less-than relationship.
1027 /// \returns true if *this < RHS when both are considered unsigned.
1028 bool ult(const APInt &RHS) const;
1030 /// \brief Unsigned less than comparison
1032 /// Regards both *this as an unsigned quantity and compares it with RHS for
1033 /// the validity of the less-than relationship.
1035 /// \returns true if *this < RHS when considered unsigned.
1036 bool ult(uint64_t RHS) const { return ult(APInt(getBitWidth(), RHS)); }
1038 /// \brief Signed less than comparison
1040 /// Regards both *this and RHS as signed quantities and compares them for
1041 /// validity of the less-than relationship.
1043 /// \returns true if *this < RHS when both are considered signed.
1044 bool slt(const APInt &RHS) const;
1046 /// \brief Signed less than comparison
1048 /// Regards both *this as a signed quantity and compares it with RHS for
1049 /// the validity of the less-than relationship.
1051 /// \returns true if *this < RHS when considered signed.
1052 bool slt(uint64_t RHS) const { return slt(APInt(getBitWidth(), RHS)); }
1054 /// \brief Unsigned less or equal comparison
1056 /// Regards both *this and RHS as unsigned quantities and compares them for
1057 /// validity of the less-or-equal relationship.
1059 /// \returns true if *this <= RHS when both are considered unsigned.
1060 bool ule(const APInt &RHS) const { return ult(RHS) || eq(RHS); }
1062 /// \brief Unsigned less or equal comparison
1064 /// Regards both *this as an unsigned quantity and compares it with RHS for
1065 /// the validity of the less-or-equal relationship.
1067 /// \returns true if *this <= RHS when considered unsigned.
1068 bool ule(uint64_t RHS) const { return ule(APInt(getBitWidth(), RHS)); }
1070 /// \brief Signed less or equal comparison
1072 /// Regards both *this and RHS as signed quantities and compares them for
1073 /// validity of the less-or-equal relationship.
1075 /// \returns true if *this <= RHS when both are considered signed.
1076 bool sle(const APInt &RHS) const { return slt(RHS) || eq(RHS); }
1078 /// \brief Signed less or equal comparison
1080 /// Regards both *this as a signed quantity and compares it with RHS for the
1081 /// validity of the less-or-equal relationship.
1083 /// \returns true if *this <= RHS when considered signed.
1084 bool sle(uint64_t RHS) const { return sle(APInt(getBitWidth(), RHS)); }
1086 /// \brief Unsigned greather than comparison
1088 /// Regards both *this and RHS as unsigned quantities and compares them for
1089 /// the validity of the greater-than relationship.
1091 /// \returns true if *this > RHS when both are considered unsigned.
1092 bool ugt(const APInt &RHS) const { return !ult(RHS) && !eq(RHS); }
1094 /// \brief Unsigned greater than comparison
1096 /// Regards both *this as an unsigned quantity and compares it with RHS for
1097 /// the validity of the greater-than relationship.
1099 /// \returns true if *this > RHS when considered unsigned.
1100 bool ugt(uint64_t RHS) const { return ugt(APInt(getBitWidth(), RHS)); }
1102 /// \brief Signed greather than comparison
1104 /// Regards both *this and RHS as signed quantities and compares them for the
1105 /// validity of the greater-than relationship.
1107 /// \returns true if *this > RHS when both are considered signed.
1108 bool sgt(const APInt &RHS) const { return !slt(RHS) && !eq(RHS); }
1110 /// \brief Signed greater than comparison
1112 /// Regards both *this as a signed quantity and compares it with RHS for
1113 /// the validity of the greater-than relationship.
1115 /// \returns true if *this > RHS when considered signed.
1116 bool sgt(uint64_t RHS) const { return sgt(APInt(getBitWidth(), RHS)); }
1118 /// \brief Unsigned greater or equal comparison
1120 /// Regards both *this and RHS as unsigned quantities and compares them for
1121 /// validity of the greater-or-equal relationship.
1123 /// \returns true if *this >= RHS when both are considered unsigned.
1124 bool uge(const APInt &RHS) const { return !ult(RHS); }
1126 /// \brief Unsigned greater or equal comparison
1128 /// Regards both *this as an unsigned quantity and compares it with RHS for
1129 /// the validity of the greater-or-equal relationship.
1131 /// \returns true if *this >= RHS when considered unsigned.
1132 bool uge(uint64_t RHS) const { return uge(APInt(getBitWidth(), RHS)); }
1134 /// \brief Signed greather or equal comparison
1136 /// Regards both *this and RHS as signed quantities and compares them for
1137 /// validity of the greater-or-equal relationship.
1139 /// \returns true if *this >= RHS when both are considered signed.
1140 bool sge(const APInt &RHS) const { return !slt(RHS); }
1142 /// \brief Signed greater or equal comparison
1144 /// Regards both *this as a signed quantity and compares it with RHS for
1145 /// the validity of the greater-or-equal relationship.
1147 /// \returns true if *this >= RHS when considered signed.
1148 bool sge(uint64_t RHS) const { return sge(APInt(getBitWidth(), RHS)); }
1150 /// This operation tests if there are any pairs of corresponding bits
1151 /// between this APInt and RHS that are both set.
1152 bool intersects(const APInt &RHS) const { return (*this & RHS) != 0; }
1155 /// \name Resizing Operators
1158 /// \brief Truncate to new width.
1160 /// Truncate the APInt to a specified width. It is an error to specify a width
1161 /// that is greater than or equal to the current width.
1162 APInt LLVM_ATTRIBUTE_UNUSED_RESULT trunc(unsigned width) const;
1164 /// \brief Sign extend to a new width.
1166 /// This operation sign extends the APInt to a new width. If the high order
1167 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
1168 /// It is an error to specify a width that is less than or equal to the
1170 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sext(unsigned width) const;
1172 /// \brief Zero extend to a new width.
1174 /// This operation zero extends the APInt to a new width. The high order bits
1175 /// are filled with 0 bits. It is an error to specify a width that is less
1176 /// than or equal to the current width.
1177 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zext(unsigned width) const;
1179 /// \brief Sign extend or truncate to width
1181 /// Make this APInt have the bit width given by \p width. The value is sign
1182 /// extended, truncated, or left alone to make it that width.
1183 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrTrunc(unsigned width) const;
1185 /// \brief Zero extend or truncate to width
1187 /// Make this APInt have the bit width given by \p width. The value is zero
1188 /// extended, truncated, or left alone to make it that width.
1189 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrTrunc(unsigned width) const;
1191 /// \brief Sign extend or truncate to width
1193 /// Make this APInt have the bit width given by \p width. The value is sign
1194 /// extended, or left alone to make it that width.
1195 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrSelf(unsigned width) const;
1197 /// \brief Zero extend or truncate to width
1199 /// Make this APInt have the bit width given by \p width. The value is zero
1200 /// extended, or left alone to make it that width.
1201 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrSelf(unsigned width) const;
1204 /// \name Bit Manipulation Operators
1207 /// \brief Set every bit to 1.
1212 // Set all the bits in all the words.
1213 for (unsigned i = 0; i < getNumWords(); ++i)
1214 pVal[i] = UINT64_MAX;
1216 // Clear the unused ones
1220 /// \brief Set a given bit to 1.
1222 /// Set the given bit to 1 whose position is given as "bitPosition".
1223 void setBit(unsigned bitPosition);
1225 /// \brief Set every bit to 0.
1226 void clearAllBits() {
1230 memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
1233 /// \brief Set a given bit to 0.
1235 /// Set the given bit to 0 whose position is given as "bitPosition".
1236 void clearBit(unsigned bitPosition);
1238 /// \brief Toggle every bit to its opposite value.
1239 void flipAllBits() {
1243 for (unsigned i = 0; i < getNumWords(); ++i)
1244 pVal[i] ^= UINT64_MAX;
1249 /// \brief Toggles a given bit to its opposite value.
1251 /// Toggle a given bit to its opposite value whose position is given
1252 /// as "bitPosition".
1253 void flipBit(unsigned bitPosition);
1256 /// \name Value Characterization Functions
1259 /// \brief Return the number of bits in the APInt.
1260 unsigned getBitWidth() const { return BitWidth; }
1262 /// \brief Get the number of words.
1264 /// Here one word's bitwidth equals to that of uint64_t.
1266 /// \returns the number of words to hold the integer value of this APInt.
1267 unsigned getNumWords() const { return getNumWords(BitWidth); }
1269 /// \brief Get the number of words.
1271 /// *NOTE* Here one word's bitwidth equals to that of uint64_t.
1273 /// \returns the number of words to hold the integer value with a given bit
1275 static unsigned getNumWords(unsigned BitWidth) {
1276 return ((uint64_t)BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1279 /// \brief Compute the number of active bits in the value
1281 /// This function returns the number of active bits which is defined as the
1282 /// bit width minus the number of leading zeros. This is used in several
1283 /// computations to see how "wide" the value is.
1284 unsigned getActiveBits() const { return BitWidth - countLeadingZeros(); }
1286 /// \brief Compute the number of active words in the value of this APInt.
1288 /// This is used in conjunction with getActiveData to extract the raw value of
1290 unsigned getActiveWords() const {
1291 unsigned numActiveBits = getActiveBits();
1292 return numActiveBits ? whichWord(numActiveBits - 1) + 1 : 1;
1295 /// \brief Get the minimum bit size for this signed APInt
1297 /// Computes the minimum bit width for this APInt while considering it to be a
1298 /// signed (and probably negative) value. If the value is not negative, this
1299 /// function returns the same value as getActiveBits()+1. Otherwise, it
1300 /// returns the smallest bit width that will retain the negative value. For
1301 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1302 /// for -1, this function will always return 1.
1303 unsigned getMinSignedBits() const {
1305 return BitWidth - countLeadingOnes() + 1;
1306 return getActiveBits() + 1;
1309 /// \brief Get zero extended value
1311 /// This method attempts to return the value of this APInt as a zero extended
1312 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1313 /// uint64_t. Otherwise an assertion will result.
1314 uint64_t getZExtValue() const {
1317 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1321 /// \brief Get sign extended value
1323 /// This method attempts to return the value of this APInt as a sign extended
1324 /// int64_t. The bit width must be <= 64 or the value must fit within an
1325 /// int64_t. Otherwise an assertion will result.
1326 int64_t getSExtValue() const {
1328 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1329 (APINT_BITS_PER_WORD - BitWidth);
1330 assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
1331 return int64_t(pVal[0]);
1334 /// \brief Get bits required for string value.
1336 /// This method determines how many bits are required to hold the APInt
1337 /// equivalent of the string given by \p str.
1338 static unsigned getBitsNeeded(StringRef str, uint8_t radix);
1340 /// \brief The APInt version of the countLeadingZeros functions in
1343 /// It counts the number of zeros from the most significant bit to the first
1346 /// \returns BitWidth if the value is zero, otherwise returns the number of
1347 /// zeros from the most significant bit to the first one bits.
1348 unsigned countLeadingZeros() const {
1349 if (isSingleWord()) {
1350 unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
1351 return llvm::countLeadingZeros(VAL) - unusedBits;
1353 return countLeadingZerosSlowCase();
1356 /// \brief Count the number of leading one bits.
1358 /// This function is an APInt version of the countLeadingOnes_{32,64}
1359 /// functions in MathExtras.h. It counts the number of ones from the most
1360 /// significant bit to the first zero bit.
1362 /// \returns 0 if the high order bit is not set, otherwise returns the number
1363 /// of 1 bits from the most significant to the least
1364 unsigned countLeadingOnes() const;
1366 /// Computes the number of leading bits of this APInt that are equal to its
1368 unsigned getNumSignBits() const {
1369 return isNegative() ? countLeadingOnes() : countLeadingZeros();
1372 /// \brief Count the number of trailing zero bits.
1374 /// This function is an APInt version of the countTrailingZeros_{32,64}
1375 /// functions in MathExtras.h. It counts the number of zeros from the least
1376 /// significant bit to the first set bit.
1378 /// \returns BitWidth if the value is zero, otherwise returns the number of
1379 /// zeros from the least significant bit to the first one bit.
1380 unsigned countTrailingZeros() const;
1382 /// \brief Count the number of trailing one bits.
1384 /// This function is an APInt version of the countTrailingOnes_{32,64}
1385 /// functions in MathExtras.h. It counts the number of ones from the least
1386 /// significant bit to the first zero bit.
1388 /// \returns BitWidth if the value is all ones, otherwise returns the number
1389 /// of ones from the least significant bit to the first zero bit.
1390 unsigned countTrailingOnes() const {
1392 return CountTrailingOnes_64(VAL);
1393 return countTrailingOnesSlowCase();
1396 /// \brief Count the number of bits set.
1398 /// This function is an APInt version of the countPopulation_{32,64} functions
1399 /// in MathExtras.h. It counts the number of 1 bits in the APInt value.
1401 /// \returns 0 if the value is zero, otherwise returns the number of set bits.
1402 unsigned countPopulation() const {
1404 return CountPopulation_64(VAL);
1405 return countPopulationSlowCase();
1409 /// \name Conversion Functions
1411 void print(raw_ostream &OS, bool isSigned) const;
1413 /// Converts an APInt to a string and append it to Str. Str is commonly a
1415 void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
1416 bool formatAsCLiteral = false) const;
1418 /// Considers the APInt to be unsigned and converts it into a string in the
1419 /// radix given. The radix can be 2, 8, 10 16, or 36.
1420 void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1421 toString(Str, Radix, false, false);
1424 /// Considers the APInt to be signed and converts it into a string in the
1425 /// radix given. The radix can be 2, 8, 10, 16, or 36.
1426 void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1427 toString(Str, Radix, true, false);
1430 /// \brief Return the APInt as a std::string.
1432 /// Note that this is an inefficient method. It is better to pass in a
1433 /// SmallVector/SmallString to the methods above to avoid thrashing the heap
1435 std::string toString(unsigned Radix, bool Signed) const;
1437 /// \returns a byte-swapped representation of this APInt Value.
1438 APInt LLVM_ATTRIBUTE_UNUSED_RESULT byteSwap() const;
1440 /// \brief Converts this APInt to a double value.
1441 double roundToDouble(bool isSigned) const;
1443 /// \brief Converts this unsigned APInt to a double value.
1444 double roundToDouble() const { return roundToDouble(false); }
1446 /// \brief Converts this signed APInt to a double value.
1447 double signedRoundToDouble() const { return roundToDouble(true); }
1449 /// \brief Converts APInt bits to a double
1451 /// The conversion does not do a translation from integer to double, it just
1452 /// re-interprets the bits as a double. Note that it is valid to do this on
1453 /// any bit width. Exactly 64 bits will be translated.
1454 double bitsToDouble() const {
1459 T.I = (isSingleWord() ? VAL : pVal[0]);
1463 /// \brief Converts APInt bits to a double
1465 /// The conversion does not do a translation from integer to float, it just
1466 /// re-interprets the bits as a float. Note that it is valid to do this on
1467 /// any bit width. Exactly 32 bits will be translated.
1468 float bitsToFloat() const {
1473 T.I = unsigned((isSingleWord() ? VAL : pVal[0]));
1477 /// \brief Converts a double to APInt bits.
1479 /// The conversion does not do a translation from double to integer, it just
1480 /// re-interprets the bits of the double.
1481 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT doubleToBits(double V) {
1487 return APInt(sizeof T * CHAR_BIT, T.I);
1490 /// \brief Converts a float to APInt bits.
1492 /// The conversion does not do a translation from float to integer, it just
1493 /// re-interprets the bits of the float.
1494 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT floatToBits(float V) {
1500 return APInt(sizeof T * CHAR_BIT, T.I);
1504 /// \name Mathematics Operations
1507 /// \returns the floor log base 2 of this APInt.
1508 unsigned logBase2() const { return BitWidth - 1 - countLeadingZeros(); }
1510 /// \returns the ceil log base 2 of this APInt.
1511 unsigned ceilLogBase2() const {
1512 return BitWidth - (*this - 1).countLeadingZeros();
1515 /// \returns the nearest log base 2 of this APInt. Ties round up.
1517 /// NOTE: When we have a BitWidth of 1, we define:
1519 /// log2(0) = UINT32_MAX
1522 /// to get around any mathematical concerns resulting from
1523 /// referencing 2 in a space where 2 does no exist.
1524 unsigned nearestLogBase2() const {
1525 // Special case when we have a bitwidth of 1. If VAL is 1, then we
1526 // get 0. If VAL is 0, we get UINT64_MAX which gets truncated to
1531 // Handle the zero case.
1532 if (!getBoolValue())
1535 // The non-zero case is handled by computing:
1537 // nearestLogBase2(x) = logBase2(x) + x[logBase2(x)-1].
1539 // where x[i] is referring to the value of the ith bit of x.
1540 unsigned lg = logBase2();
1541 return lg + unsigned((*this)[lg - 1]);
1544 /// \returns the log base 2 of this APInt if its an exact power of two, -1
1546 int32_t exactLogBase2() const {
1552 /// \brief Compute the square root
1553 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sqrt() const;
1555 /// \brief Get the absolute value;
1557 /// If *this is < 0 then return -(*this), otherwise *this;
1558 APInt LLVM_ATTRIBUTE_UNUSED_RESULT abs() const {
1564 /// \returns the multiplicative inverse for a given modulo.
1565 APInt multiplicativeInverse(const APInt &modulo) const;
1568 /// \name Support for division by constant
1571 /// Calculate the magic number for signed division by a constant.
1575 /// Calculate the magic number for unsigned division by a constant.
1577 mu magicu(unsigned LeadingZeros = 0) const;
1580 /// \name Building-block Operations for APInt and APFloat
1583 // These building block operations operate on a representation of arbitrary
1584 // precision, two's-complement, bignum integer values. They should be
1585 // sufficient to implement APInt and APFloat bignum requirements. Inputs are
1586 // generally a pointer to the base of an array of integer parts, representing
1587 // an unsigned bignum, and a count of how many parts there are.
1589 /// Sets the least significant part of a bignum to the input value, and zeroes
1590 /// out higher parts.
1591 static void tcSet(integerPart *, integerPart, unsigned int);
1593 /// Assign one bignum to another.
1594 static void tcAssign(integerPart *, const integerPart *, unsigned int);
1596 /// Returns true if a bignum is zero, false otherwise.
1597 static bool tcIsZero(const integerPart *, unsigned int);
1599 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1600 static int tcExtractBit(const integerPart *, unsigned int bit);
1602 /// Copy the bit vector of width srcBITS from SRC, starting at bit srcLSB, to
1603 /// DST, of dstCOUNT parts, such that the bit srcLSB becomes the least
1604 /// significant bit of DST. All high bits above srcBITS in DST are
1606 static void tcExtract(integerPart *, unsigned int dstCount,
1607 const integerPart *, unsigned int srcBits,
1608 unsigned int srcLSB);
1610 /// Set the given bit of a bignum. Zero-based.
1611 static void tcSetBit(integerPart *, unsigned int bit);
1613 /// Clear the given bit of a bignum. Zero-based.
1614 static void tcClearBit(integerPart *, unsigned int bit);
1616 /// Returns the bit number of the least or most significant set bit of a
1617 /// number. If the input number has no bits set -1U is returned.
1618 static unsigned int tcLSB(const integerPart *, unsigned int);
1619 static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1621 /// Negate a bignum in-place.
1622 static void tcNegate(integerPart *, unsigned int);
1624 /// DST += RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1625 static integerPart tcAdd(integerPart *, const integerPart *,
1626 integerPart carry, unsigned);
1628 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1629 static integerPart tcSubtract(integerPart *, const integerPart *,
1630 integerPart carry, unsigned);
1632 /// DST += SRC * MULTIPLIER + PART if add is true
1633 /// DST = SRC * MULTIPLIER + PART if add is false
1635 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC they must
1636 /// start at the same point, i.e. DST == SRC.
1638 /// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is returned.
1639 /// Otherwise DST is filled with the least significant DSTPARTS parts of the
1640 /// result, and if all of the omitted higher parts were zero return zero,
1641 /// otherwise overflow occurred and return one.
1642 static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1643 integerPart multiplier, integerPart carry,
1644 unsigned int srcParts, unsigned int dstParts,
1647 /// DST = LHS * RHS, where DST has the same width as the operands and is
1648 /// filled with the least significant parts of the result. Returns one if
1649 /// overflow occurred, otherwise zero. DST must be disjoint from both
1651 static int tcMultiply(integerPart *, const integerPart *, const integerPart *,
1654 /// DST = LHS * RHS, where DST has width the sum of the widths of the
1655 /// operands. No overflow occurs. DST must be disjoint from both
1656 /// operands. Returns the number of parts required to hold the result.
1657 static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1658 const integerPart *, unsigned, unsigned);
1660 /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1661 /// Otherwise set LHS to LHS / RHS with the fractional part discarded, set
1662 /// REMAINDER to the remainder, return zero. i.e.
1664 /// OLD_LHS = RHS * LHS + REMAINDER
1666 /// SCRATCH is a bignum of the same size as the operands and result for use by
1667 /// the routine; its contents need not be initialized and are destroyed. LHS,
1668 /// REMAINDER and SCRATCH must be distinct.
1669 static int tcDivide(integerPart *lhs, const integerPart *rhs,
1670 integerPart *remainder, integerPart *scratch,
1671 unsigned int parts);
1673 /// Shift a bignum left COUNT bits. Shifted in bits are zero. There are no
1674 /// restrictions on COUNT.
1675 static void tcShiftLeft(integerPart *, unsigned int parts,
1676 unsigned int count);
1678 /// Shift a bignum right COUNT bits. Shifted in bits are zero. There are no
1679 /// restrictions on COUNT.
1680 static void tcShiftRight(integerPart *, unsigned int parts,
1681 unsigned int count);
1683 /// The obvious AND, OR and XOR and complement operations.
1684 static void tcAnd(integerPart *, const integerPart *, unsigned int);
1685 static void tcOr(integerPart *, const integerPart *, unsigned int);
1686 static void tcXor(integerPart *, const integerPart *, unsigned int);
1687 static void tcComplement(integerPart *, unsigned int);
1689 /// Comparison (unsigned) of two bignums.
1690 static int tcCompare(const integerPart *, const integerPart *, unsigned int);
1692 /// Increment a bignum in-place. Return the carry flag.
1693 static integerPart tcIncrement(integerPart *, unsigned int);
1695 /// Decrement a bignum in-place. Return the borrow flag.
1696 static integerPart tcDecrement(integerPart *, unsigned int);
1698 /// Set the least significant BITS and clear the rest.
1699 static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1702 /// \brief debug method
1708 /// Magic data for optimising signed division by a constant.
1710 APInt m; ///< magic number
1711 unsigned s; ///< shift amount
1714 /// Magic data for optimising unsigned division by a constant.
1716 APInt m; ///< magic number
1717 bool a; ///< add indicator
1718 unsigned s; ///< shift amount
1721 inline bool operator==(uint64_t V1, const APInt &V2) { return V2 == V1; }
1723 inline bool operator!=(uint64_t V1, const APInt &V2) { return V2 != V1; }
1725 inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
1730 namespace APIntOps {
1732 /// \brief Determine the smaller of two APInts considered to be signed.
1733 inline APInt smin(const APInt &A, const APInt &B) { return A.slt(B) ? A : B; }
1735 /// \brief Determine the larger of two APInts considered to be signed.
1736 inline APInt smax(const APInt &A, const APInt &B) { return A.sgt(B) ? A : B; }
1738 /// \brief Determine the smaller of two APInts considered to be signed.
1739 inline APInt umin(const APInt &A, const APInt &B) { return A.ult(B) ? A : B; }
1741 /// \brief Determine the larger of two APInts considered to be unsigned.
1742 inline APInt umax(const APInt &A, const APInt &B) { return A.ugt(B) ? A : B; }
1744 /// \brief Check if the specified APInt has a N-bits unsigned integer value.
1745 inline bool isIntN(unsigned N, const APInt &APIVal) { return APIVal.isIntN(N); }
1747 /// \brief Check if the specified APInt has a N-bits signed integer value.
1748 inline bool isSignedIntN(unsigned N, const APInt &APIVal) {
1749 return APIVal.isSignedIntN(N);
1752 /// \returns true if the argument APInt value is a sequence of ones starting at
1753 /// the least significant bit with the remainder zero.
1754 inline bool isMask(unsigned numBits, const APInt &APIVal) {
1755 return numBits <= APIVal.getBitWidth() &&
1756 APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
1759 /// \brief Return true if the argument APInt value contains a sequence of ones
1760 /// with the remainder zero.
1761 inline bool isShiftedMask(unsigned numBits, const APInt &APIVal) {
1762 return isMask(numBits, (APIVal - APInt(numBits, 1)) | APIVal);
1765 /// \brief Returns a byte-swapped representation of the specified APInt Value.
1766 inline APInt byteSwap(const APInt &APIVal) { return APIVal.byteSwap(); }
1768 /// \brief Returns the floor log base 2 of the specified APInt value.
1769 inline unsigned logBase2(const APInt &APIVal) { return APIVal.logBase2(); }
1771 /// \brief Compute GCD of two APInt values.
1773 /// This function returns the greatest common divisor of the two APInt values
1774 /// using Euclid's algorithm.
1776 /// \returns the greatest common divisor of Val1 and Val2
1777 APInt GreatestCommonDivisor(const APInt &Val1, const APInt &Val2);
1779 /// \brief Converts the given APInt to a double value.
1781 /// Treats the APInt as an unsigned value for conversion purposes.
1782 inline double RoundAPIntToDouble(const APInt &APIVal) {
1783 return APIVal.roundToDouble();
1786 /// \brief Converts the given APInt to a double value.
1788 /// Treats the APInt as a signed value for conversion purposes.
1789 inline double RoundSignedAPIntToDouble(const APInt &APIVal) {
1790 return APIVal.signedRoundToDouble();
1793 /// \brief Converts the given APInt to a float vlalue.
1794 inline float RoundAPIntToFloat(const APInt &APIVal) {
1795 return float(RoundAPIntToDouble(APIVal));
1798 /// \brief Converts the given APInt to a float value.
1800 /// Treast the APInt as a signed value for conversion purposes.
1801 inline float RoundSignedAPIntToFloat(const APInt &APIVal) {
1802 return float(APIVal.signedRoundToDouble());
1805 /// \brief Converts the given double value into a APInt.
1807 /// This function convert a double value to an APInt value.
1808 APInt RoundDoubleToAPInt(double Double, unsigned width);
1810 /// \brief Converts a float value into a APInt.
1812 /// Converts a float value into an APInt value.
1813 inline APInt RoundFloatToAPInt(float Float, unsigned width) {
1814 return RoundDoubleToAPInt(double(Float), width);
1817 /// \brief Arithmetic right-shift function.
1819 /// Arithmetic right-shift the APInt by shiftAmt.
1820 inline APInt ashr(const APInt &LHS, unsigned shiftAmt) {
1821 return LHS.ashr(shiftAmt);
1824 /// \brief Logical right-shift function.
1826 /// Logical right-shift the APInt by shiftAmt.
1827 inline APInt lshr(const APInt &LHS, unsigned shiftAmt) {
1828 return LHS.lshr(shiftAmt);
1831 /// \brief Left-shift function.
1833 /// Left-shift the APInt by shiftAmt.
1834 inline APInt shl(const APInt &LHS, unsigned shiftAmt) {
1835 return LHS.shl(shiftAmt);
1838 /// \brief Signed division function for APInt.
1840 /// Signed divide APInt LHS by APInt RHS.
1841 inline APInt sdiv(const APInt &LHS, const APInt &RHS) { return LHS.sdiv(RHS); }
1843 /// \brief Unsigned division function for APInt.
1845 /// Unsigned divide APInt LHS by APInt RHS.
1846 inline APInt udiv(const APInt &LHS, const APInt &RHS) { return LHS.udiv(RHS); }
1848 /// \brief Function for signed remainder operation.
1850 /// Signed remainder operation on APInt.
1851 inline APInt srem(const APInt &LHS, const APInt &RHS) { return LHS.srem(RHS); }
1853 /// \brief Function for unsigned remainder operation.
1855 /// Unsigned remainder operation on APInt.
1856 inline APInt urem(const APInt &LHS, const APInt &RHS) { return LHS.urem(RHS); }
1858 /// \brief Function for multiplication operation.
1860 /// Performs multiplication on APInt values.
1861 inline APInt mul(const APInt &LHS, const APInt &RHS) { return LHS * RHS; }
1863 /// \brief Function for addition operation.
1865 /// Performs addition on APInt values.
1866 inline APInt add(const APInt &LHS, const APInt &RHS) { return LHS + RHS; }
1868 /// \brief Function for subtraction operation.
1870 /// Performs subtraction on APInt values.
1871 inline APInt sub(const APInt &LHS, const APInt &RHS) { return LHS - RHS; }
1873 /// \brief Bitwise AND function for APInt.
1875 /// Performs bitwise AND operation on APInt LHS and
1877 inline APInt And(const APInt &LHS, const APInt &RHS) { return LHS & RHS; }
1879 /// \brief Bitwise OR function for APInt.
1881 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1882 inline APInt Or(const APInt &LHS, const APInt &RHS) { return LHS | RHS; }
1884 /// \brief Bitwise XOR function for APInt.
1886 /// Performs bitwise XOR operation on APInt.
1887 inline APInt Xor(const APInt &LHS, const APInt &RHS) { return LHS ^ RHS; }
1889 /// \brief Bitwise complement function.
1891 /// Performs a bitwise complement operation on APInt.
1892 inline APInt Not(const APInt &APIVal) { return ~APIVal; }
1894 } // End of APIntOps namespace
1896 // See friend declaration above. This additional declaration is required in
1897 // order to compile LLVM with IBM xlC compiler.
1898 hash_code hash_value(const APInt &Arg);
1899 } // End of llvm namespace