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 #if LLVM_HAS_RVALUE_REFERENCES
288 /// \brief Move Constructor.
289 APInt(APInt &&that) : BitWidth(that.BitWidth), VAL(that.VAL) {
294 /// \brief Destructor.
300 /// \brief Default constructor that creates an uninitialized APInt.
302 /// This is useful for object deserialization (pair this with the static
304 explicit APInt() : BitWidth(1) {}
306 /// \brief Returns whether this instance allocated memory.
307 bool needsCleanup() const { return !isSingleWord(); }
309 /// Used to insert APInt objects, or objects that contain APInt objects, into
311 void Profile(FoldingSetNodeID &id) const;
314 /// \name Value Tests
317 /// \brief Determine sign of this APInt.
319 /// This tests the high bit of this APInt to determine if it is set.
321 /// \returns true if this APInt is negative, false otherwise
322 bool isNegative() const { return (*this)[BitWidth - 1]; }
324 /// \brief Determine if this APInt Value is non-negative (>= 0)
326 /// This tests the high bit of the APInt to determine if it is unset.
327 bool isNonNegative() const { return !isNegative(); }
329 /// \brief Determine if this APInt Value is positive.
331 /// This tests if the value of this APInt is positive (> 0). Note
332 /// that 0 is not a positive value.
334 /// \returns true if this APInt is positive.
335 bool isStrictlyPositive() const { return isNonNegative() && !!*this; }
337 /// \brief Determine if all bits are set
339 /// This checks to see if the value has all bits of the APInt are set or not.
340 bool isAllOnesValue() const {
342 return VAL == ~integerPart(0) >> (APINT_BITS_PER_WORD - BitWidth);
343 return countPopulationSlowCase() == BitWidth;
346 /// \brief Determine if this is the largest unsigned value.
348 /// This checks to see if the value of this APInt is the maximum unsigned
349 /// value for the APInt's bit width.
350 bool isMaxValue() const { return isAllOnesValue(); }
352 /// \brief Determine if this is the largest signed value.
354 /// This checks to see if the value of this APInt is the maximum signed
355 /// value for the APInt's bit width.
356 bool isMaxSignedValue() const {
357 return BitWidth == 1 ? VAL == 0
358 : !isNegative() && countPopulation() == BitWidth - 1;
361 /// \brief Determine if this is the smallest unsigned value.
363 /// This checks to see if the value of this APInt is the minimum unsigned
364 /// value for the APInt's bit width.
365 bool isMinValue() const { return !*this; }
367 /// \brief Determine if this is the smallest signed value.
369 /// This checks to see if the value of this APInt is the minimum signed
370 /// value for the APInt's bit width.
371 bool isMinSignedValue() const {
372 return BitWidth == 1 ? VAL == 1 : isNegative() && isPowerOf2();
375 /// \brief Check if this APInt has an N-bits unsigned integer value.
376 bool isIntN(unsigned N) const {
377 assert(N && "N == 0 ???");
378 return getActiveBits() <= N;
381 /// \brief Check if this APInt has an N-bits signed integer value.
382 bool isSignedIntN(unsigned N) const {
383 assert(N && "N == 0 ???");
384 return getMinSignedBits() <= N;
387 /// \brief Check if this APInt's value is a power of two greater than zero.
389 /// \returns true if the argument APInt value is a power of two > 0.
390 bool isPowerOf2() const {
392 return isPowerOf2_64(VAL);
393 return countPopulationSlowCase() == 1;
396 /// \brief Check if the APInt's value is returned by getSignBit.
398 /// \returns true if this is the value returned by getSignBit.
399 bool isSignBit() const { return isMinSignedValue(); }
401 /// \brief Convert APInt to a boolean value.
403 /// This converts the APInt to a boolean value as a test against zero.
404 bool getBoolValue() const { return !!*this; }
406 /// If this value is smaller than the specified limit, return it, otherwise
407 /// return the limit value. This causes the value to saturate to the limit.
408 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
409 return (getActiveBits() > 64 || getZExtValue() > Limit) ? Limit
414 /// \name Value Generators
417 /// \brief Gets maximum unsigned value of APInt for specific bit width.
418 static APInt getMaxValue(unsigned numBits) {
419 return getAllOnesValue(numBits);
422 /// \brief Gets maximum signed value of APInt for a specific bit width.
423 static APInt getSignedMaxValue(unsigned numBits) {
424 APInt API = getAllOnesValue(numBits);
425 API.clearBit(numBits - 1);
429 /// \brief Gets minimum unsigned value of APInt for a specific bit width.
430 static APInt getMinValue(unsigned numBits) { return APInt(numBits, 0); }
432 /// \brief Gets minimum signed value of APInt for a specific bit width.
433 static APInt getSignedMinValue(unsigned numBits) {
434 APInt API(numBits, 0);
435 API.setBit(numBits - 1);
439 /// \brief Get the SignBit for a specific bit width.
441 /// This is just a wrapper function of getSignedMinValue(), and it helps code
442 /// readability when we want to get a SignBit.
443 static APInt getSignBit(unsigned BitWidth) {
444 return getSignedMinValue(BitWidth);
447 /// \brief Get the all-ones value.
449 /// \returns the all-ones value for an APInt of the specified bit-width.
450 static APInt getAllOnesValue(unsigned numBits) {
451 return APInt(numBits, UINT64_MAX, true);
454 /// \brief Get the '0' value.
456 /// \returns the '0' value for an APInt of the specified bit-width.
457 static APInt getNullValue(unsigned numBits) { return APInt(numBits, 0); }
459 /// \brief Compute an APInt containing numBits highbits from this APInt.
461 /// Get an APInt with the same BitWidth as this APInt, just zero mask
462 /// the low bits and right shift to the least significant bit.
464 /// \returns the high "numBits" bits of this APInt.
465 APInt getHiBits(unsigned numBits) const;
467 /// \brief Compute an APInt containing numBits lowbits from this APInt.
469 /// Get an APInt with the same BitWidth as this APInt, just zero mask
472 /// \returns the low "numBits" bits of this APInt.
473 APInt getLoBits(unsigned numBits) const;
475 /// \brief Return an APInt with exactly one bit set in the result.
476 static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
477 APInt Res(numBits, 0);
482 /// \brief Get a value with a block of bits set.
484 /// Constructs an APInt value that has a contiguous range of bits set. The
485 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
486 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
487 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
488 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
490 /// \param numBits the intended bit width of the result
491 /// \param loBit the index of the lowest bit set.
492 /// \param hiBit the index of the highest bit set.
494 /// \returns An APInt value with the requested bits set.
495 static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
496 assert(hiBit <= numBits && "hiBit out of range");
497 assert(loBit < numBits && "loBit out of range");
499 return getLowBitsSet(numBits, hiBit) |
500 getHighBitsSet(numBits, numBits - loBit);
501 return getLowBitsSet(numBits, hiBit - loBit).shl(loBit);
504 /// \brief Get a value with high bits set
506 /// Constructs an APInt value that has the top hiBitsSet bits set.
508 /// \param numBits the bitwidth of the result
509 /// \param hiBitsSet the number of high-order bits set in the result.
510 static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
511 assert(hiBitsSet <= numBits && "Too many bits to set!");
512 // Handle a degenerate case, to avoid shifting by word size
514 return APInt(numBits, 0);
515 unsigned shiftAmt = numBits - hiBitsSet;
516 // For small values, return quickly
517 if (numBits <= APINT_BITS_PER_WORD)
518 return APInt(numBits, ~0ULL << shiftAmt);
519 return getAllOnesValue(numBits).shl(shiftAmt);
522 /// \brief Get a value with low bits set
524 /// Constructs an APInt value that has the bottom loBitsSet bits set.
526 /// \param numBits the bitwidth of the result
527 /// \param loBitsSet the number of low-order bits set in the result.
528 static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
529 assert(loBitsSet <= numBits && "Too many bits to set!");
530 // Handle a degenerate case, to avoid shifting by word size
532 return APInt(numBits, 0);
533 if (loBitsSet == APINT_BITS_PER_WORD)
534 return APInt(numBits, UINT64_MAX);
535 // For small values, return quickly.
536 if (loBitsSet <= APINT_BITS_PER_WORD)
537 return APInt(numBits, UINT64_MAX >> (APINT_BITS_PER_WORD - loBitsSet));
538 return getAllOnesValue(numBits).lshr(numBits - loBitsSet);
541 /// \brief Return a value containing V broadcasted over NewLen bits.
542 static APInt getSplat(unsigned NewLen, const APInt &V) {
543 assert(NewLen >= V.getBitWidth() && "Can't splat to smaller bit width!");
545 APInt Val = V.zextOrSelf(NewLen);
546 for (unsigned I = V.getBitWidth(); I < NewLen; I <<= 1)
552 /// \brief Determine if two APInts have the same value, after zero-extending
553 /// one of them (if needed!) to ensure that the bit-widths match.
554 static bool isSameValue(const APInt &I1, const APInt &I2) {
555 if (I1.getBitWidth() == I2.getBitWidth())
558 if (I1.getBitWidth() > I2.getBitWidth())
559 return I1 == I2.zext(I1.getBitWidth());
561 return I1.zext(I2.getBitWidth()) == I2;
564 /// \brief Overload to compute a hash_code for an APInt value.
565 friend hash_code hash_value(const APInt &Arg);
567 /// This function returns a pointer to the internal storage of the APInt.
568 /// This is useful for writing out the APInt in binary form without any
570 const uint64_t *getRawData() const {
577 /// \name Unary Operators
580 /// \brief Postfix increment operator.
582 /// \returns a new APInt value representing *this incremented by one
583 const APInt operator++(int) {
589 /// \brief Prefix increment operator.
591 /// \returns *this incremented by one
594 /// \brief Postfix decrement operator.
596 /// \returns a new APInt representing *this decremented by one.
597 const APInt operator--(int) {
603 /// \brief Prefix decrement operator.
605 /// \returns *this decremented by one.
608 /// \brief Unary bitwise complement operator.
610 /// Performs a bitwise complement operation on this APInt.
612 /// \returns an APInt that is the bitwise complement of *this
613 APInt operator~() const {
615 Result.flipAllBits();
619 /// \brief Unary negation operator
621 /// Negates *this using two's complement logic.
623 /// \returns An APInt value representing the negation of *this.
624 APInt operator-() const { return APInt(BitWidth, 0) - (*this); }
626 /// \brief Logical negation operator.
628 /// Performs logical negation operation on this APInt.
630 /// \returns true if *this is zero, false otherwise.
631 bool operator!() const {
635 for (unsigned i = 0; i != getNumWords(); ++i)
642 /// \name Assignment Operators
645 /// \brief Copy assignment operator.
647 /// \returns *this after assignment of RHS.
648 APInt &operator=(const APInt &RHS) {
649 // If the bitwidths are the same, we can avoid mucking with memory
650 if (isSingleWord() && RHS.isSingleWord()) {
652 BitWidth = RHS.BitWidth;
653 return clearUnusedBits();
656 return AssignSlowCase(RHS);
659 #if LLVM_HAS_RVALUE_REFERENCES
660 /// @brief Move assignment operator.
661 APInt &operator=(APInt &&that) {
665 BitWidth = that.BitWidth;
674 /// \brief Assignment operator.
676 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
677 /// the bit width, the excess bits are truncated. If the bit width is larger
678 /// than 64, the value is zero filled in the unspecified high order bits.
680 /// \returns *this after assignment of RHS value.
681 APInt &operator=(uint64_t RHS);
683 /// \brief Bitwise AND assignment operator.
685 /// Performs a bitwise AND operation on this APInt and RHS. The result is
686 /// assigned to *this.
688 /// \returns *this after ANDing with RHS.
689 APInt &operator&=(const APInt &RHS);
691 /// \brief Bitwise OR assignment operator.
693 /// Performs a bitwise OR operation on this APInt and RHS. The result is
696 /// \returns *this after ORing with RHS.
697 APInt &operator|=(const APInt &RHS);
699 /// \brief Bitwise OR assignment operator.
701 /// Performs a bitwise OR operation on this APInt and RHS. RHS is
702 /// logically zero-extended or truncated to match the bit-width of
704 APInt &operator|=(uint64_t RHS) {
705 if (isSingleWord()) {
714 /// \brief Bitwise XOR assignment operator.
716 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
717 /// assigned to *this.
719 /// \returns *this after XORing with RHS.
720 APInt &operator^=(const APInt &RHS);
722 /// \brief Multiplication assignment operator.
724 /// Multiplies this APInt by RHS and assigns the result to *this.
727 APInt &operator*=(const APInt &RHS);
729 /// \brief Addition assignment operator.
731 /// Adds RHS to *this and assigns the result to *this.
734 APInt &operator+=(const APInt &RHS);
736 /// \brief Subtraction assignment operator.
738 /// Subtracts RHS from *this and assigns the result to *this.
741 APInt &operator-=(const APInt &RHS);
743 /// \brief Left-shift assignment function.
745 /// Shifts *this left by shiftAmt and assigns the result to *this.
747 /// \returns *this after shifting left by shiftAmt
748 APInt &operator<<=(unsigned shiftAmt) {
749 *this = shl(shiftAmt);
754 /// \name Binary Operators
757 /// \brief Bitwise AND operator.
759 /// Performs a bitwise AND operation on *this and RHS.
761 /// \returns An APInt value representing the bitwise AND of *this and RHS.
762 APInt operator&(const APInt &RHS) const {
763 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
765 return APInt(getBitWidth(), VAL & RHS.VAL);
766 return AndSlowCase(RHS);
768 APInt LLVM_ATTRIBUTE_UNUSED_RESULT And(const APInt &RHS) const {
769 return this->operator&(RHS);
772 /// \brief Bitwise OR operator.
774 /// Performs a bitwise OR operation on *this and RHS.
776 /// \returns An APInt value representing the bitwise OR of *this and RHS.
777 APInt operator|(const APInt &RHS) const {
778 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
780 return APInt(getBitWidth(), VAL | RHS.VAL);
781 return OrSlowCase(RHS);
784 /// \brief Bitwise OR function.
786 /// Performs a bitwise or on *this and RHS. This is implemented bny simply
787 /// calling operator|.
789 /// \returns An APInt value representing the bitwise OR of *this and RHS.
790 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Or(const APInt &RHS) const {
791 return this->operator|(RHS);
794 /// \brief Bitwise XOR operator.
796 /// Performs a bitwise XOR operation on *this and RHS.
798 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
799 APInt operator^(const APInt &RHS) const {
800 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
802 return APInt(BitWidth, VAL ^ RHS.VAL);
803 return XorSlowCase(RHS);
806 /// \brief Bitwise XOR function.
808 /// Performs a bitwise XOR operation on *this and RHS. This is implemented
809 /// through the usage of operator^.
811 /// \returns An APInt value representing the bitwise XOR of *this and RHS.
812 APInt LLVM_ATTRIBUTE_UNUSED_RESULT Xor(const APInt &RHS) const {
813 return this->operator^(RHS);
816 /// \brief Multiplication operator.
818 /// Multiplies this APInt by RHS and returns the result.
819 APInt operator*(const APInt &RHS) const;
821 /// \brief Addition operator.
823 /// Adds RHS to this APInt and returns the result.
824 APInt operator+(const APInt &RHS) const;
825 APInt operator+(uint64_t RHS) const { return (*this) + APInt(BitWidth, RHS); }
827 /// \brief Subtraction operator.
829 /// Subtracts RHS from this APInt and returns the result.
830 APInt operator-(const APInt &RHS) const;
831 APInt operator-(uint64_t RHS) const { return (*this) - APInt(BitWidth, RHS); }
833 /// \brief Left logical shift operator.
835 /// Shifts this APInt left by \p Bits and returns the result.
836 APInt operator<<(unsigned Bits) const { return shl(Bits); }
838 /// \brief Left logical shift operator.
840 /// Shifts this APInt left by \p Bits and returns the result.
841 APInt operator<<(const APInt &Bits) const { return shl(Bits); }
843 /// \brief Arithmetic right-shift function.
845 /// Arithmetic right-shift this APInt by shiftAmt.
846 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(unsigned shiftAmt) const;
848 /// \brief Logical right-shift function.
850 /// Logical right-shift this APInt by shiftAmt.
851 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(unsigned shiftAmt) const;
853 /// \brief Left-shift function.
855 /// Left-shift this APInt by shiftAmt.
856 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(unsigned shiftAmt) const {
857 assert(shiftAmt <= BitWidth && "Invalid shift amount");
858 if (isSingleWord()) {
859 if (shiftAmt >= BitWidth)
860 return APInt(BitWidth, 0); // avoid undefined shift results
861 return APInt(BitWidth, VAL << shiftAmt);
863 return shlSlowCase(shiftAmt);
866 /// \brief Rotate left by rotateAmt.
867 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(unsigned rotateAmt) const;
869 /// \brief Rotate right by rotateAmt.
870 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(unsigned rotateAmt) const;
872 /// \brief Arithmetic right-shift function.
874 /// Arithmetic right-shift this APInt by shiftAmt.
875 APInt LLVM_ATTRIBUTE_UNUSED_RESULT ashr(const APInt &shiftAmt) const;
877 /// \brief Logical right-shift function.
879 /// Logical right-shift this APInt by shiftAmt.
880 APInt LLVM_ATTRIBUTE_UNUSED_RESULT lshr(const APInt &shiftAmt) const;
882 /// \brief Left-shift function.
884 /// Left-shift this APInt by shiftAmt.
885 APInt LLVM_ATTRIBUTE_UNUSED_RESULT shl(const APInt &shiftAmt) const;
887 /// \brief Rotate left by rotateAmt.
888 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotl(const APInt &rotateAmt) const;
890 /// \brief Rotate right by rotateAmt.
891 APInt LLVM_ATTRIBUTE_UNUSED_RESULT rotr(const APInt &rotateAmt) const;
893 /// \brief Unsigned division operation.
895 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
896 /// RHS are treated as unsigned quantities for purposes of this division.
898 /// \returns a new APInt value containing the division result
899 APInt LLVM_ATTRIBUTE_UNUSED_RESULT udiv(const APInt &RHS) const;
901 /// \brief Signed division function for APInt.
903 /// Signed divide this APInt by APInt RHS.
904 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sdiv(const APInt &RHS) const;
906 /// \brief Unsigned remainder operation.
908 /// Perform an unsigned remainder operation on this APInt with RHS being the
909 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
910 /// of this operation. Note that this is a true remainder operation and not a
911 /// modulo operation because the sign follows the sign of the dividend which
914 /// \returns a new APInt value containing the remainder result
915 APInt LLVM_ATTRIBUTE_UNUSED_RESULT urem(const APInt &RHS) const;
917 /// \brief Function for signed remainder operation.
919 /// Signed remainder operation on APInt.
920 APInt LLVM_ATTRIBUTE_UNUSED_RESULT srem(const APInt &RHS) const;
922 /// \brief Dual division/remainder interface.
924 /// Sometimes it is convenient to divide two APInt values and obtain both the
925 /// quotient and remainder. This function does both operations in the same
926 /// computation making it a little more efficient. The pair of input arguments
927 /// may overlap with the pair of output arguments. It is safe to call
928 /// udivrem(X, Y, X, Y), for example.
929 static void udivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
932 static void sdivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
935 // Operations that return overflow indicators.
936 APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
937 APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
938 APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
939 APInt usub_ov(const APInt &RHS, bool &Overflow) const;
940 APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
941 APInt smul_ov(const APInt &RHS, bool &Overflow) const;
942 APInt umul_ov(const APInt &RHS, bool &Overflow) const;
943 APInt sshl_ov(unsigned Amt, bool &Overflow) const;
945 /// \brief Array-indexing support.
947 /// \returns the bit value at bitPosition
948 bool operator[](unsigned bitPosition) const {
949 assert(bitPosition < getBitWidth() && "Bit position out of bounds!");
950 return (maskBit(bitPosition) &
951 (isSingleWord() ? VAL : pVal[whichWord(bitPosition)])) !=
956 /// \name Comparison Operators
959 /// \brief Equality operator.
961 /// Compares this APInt with RHS for the validity of the equality
963 bool operator==(const APInt &RHS) const {
964 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
966 return VAL == RHS.VAL;
967 return EqualSlowCase(RHS);
970 /// \brief Equality operator.
972 /// Compares this APInt with a uint64_t for the validity of the equality
975 /// \returns true if *this == Val
976 bool operator==(uint64_t Val) const {
979 return EqualSlowCase(Val);
982 /// \brief Equality comparison.
984 /// Compares this APInt with RHS for the validity of the equality
987 /// \returns true if *this == Val
988 bool eq(const APInt &RHS) const { return (*this) == RHS; }
990 /// \brief Inequality operator.
992 /// Compares this APInt with RHS for the validity of the inequality
995 /// \returns true if *this != Val
996 bool operator!=(const APInt &RHS) const { return !((*this) == RHS); }
998 /// \brief Inequality operator.
1000 /// Compares this APInt with a uint64_t for the validity of the inequality
1003 /// \returns true if *this != Val
1004 bool operator!=(uint64_t Val) const { return !((*this) == Val); }
1006 /// \brief Inequality comparison
1008 /// Compares this APInt with RHS for the validity of the inequality
1011 /// \returns true if *this != Val
1012 bool ne(const APInt &RHS) const { return !((*this) == RHS); }
1014 /// \brief Unsigned less than comparison
1016 /// Regards both *this and RHS as unsigned quantities and compares them for
1017 /// the validity of the less-than relationship.
1019 /// \returns true if *this < RHS when both are considered unsigned.
1020 bool ult(const APInt &RHS) const;
1022 /// \brief Unsigned less than comparison
1024 /// Regards both *this as an unsigned quantity and compares it with RHS for
1025 /// the validity of the less-than relationship.
1027 /// \returns true if *this < RHS when considered unsigned.
1028 bool ult(uint64_t RHS) const { return ult(APInt(getBitWidth(), RHS)); }
1030 /// \brief Signed less than comparison
1032 /// Regards both *this and RHS as signed quantities and compares them for
1033 /// validity of the less-than relationship.
1035 /// \returns true if *this < RHS when both are considered signed.
1036 bool slt(const APInt &RHS) const;
1038 /// \brief Signed less than comparison
1040 /// Regards both *this as a signed quantity and compares it with RHS for
1041 /// the validity of the less-than relationship.
1043 /// \returns true if *this < RHS when considered signed.
1044 bool slt(uint64_t RHS) const { return slt(APInt(getBitWidth(), RHS)); }
1046 /// \brief Unsigned less or equal comparison
1048 /// Regards both *this and RHS as unsigned quantities and compares them for
1049 /// validity of the less-or-equal relationship.
1051 /// \returns true if *this <= RHS when both are considered unsigned.
1052 bool ule(const APInt &RHS) const { return ult(RHS) || eq(RHS); }
1054 /// \brief Unsigned less or equal comparison
1056 /// Regards both *this as an unsigned quantity and compares it with RHS for
1057 /// the validity of the less-or-equal relationship.
1059 /// \returns true if *this <= RHS when considered unsigned.
1060 bool ule(uint64_t RHS) const { return ule(APInt(getBitWidth(), RHS)); }
1062 /// \brief Signed less or equal comparison
1064 /// Regards both *this and RHS as signed quantities and compares them for
1065 /// validity of the less-or-equal relationship.
1067 /// \returns true if *this <= RHS when both are considered signed.
1068 bool sle(const APInt &RHS) const { return slt(RHS) || eq(RHS); }
1070 /// \brief Signed less or equal comparison
1072 /// Regards both *this as a signed quantity and compares it with RHS for the
1073 /// validity of the less-or-equal relationship.
1075 /// \returns true if *this <= RHS when considered signed.
1076 bool sle(uint64_t RHS) const { return sle(APInt(getBitWidth(), RHS)); }
1078 /// \brief Unsigned greather than comparison
1080 /// Regards both *this and RHS as unsigned quantities and compares them for
1081 /// the validity of the greater-than relationship.
1083 /// \returns true if *this > RHS when both are considered unsigned.
1084 bool ugt(const APInt &RHS) const { return !ult(RHS) && !eq(RHS); }
1086 /// \brief Unsigned greater than comparison
1088 /// Regards both *this as an unsigned quantity and compares it with RHS for
1089 /// the validity of the greater-than relationship.
1091 /// \returns true if *this > RHS when considered unsigned.
1092 bool ugt(uint64_t RHS) const { return ugt(APInt(getBitWidth(), RHS)); }
1094 /// \brief Signed greather than comparison
1096 /// Regards both *this and RHS as signed quantities and compares them for the
1097 /// validity of the greater-than relationship.
1099 /// \returns true if *this > RHS when both are considered signed.
1100 bool sgt(const APInt &RHS) const { return !slt(RHS) && !eq(RHS); }
1102 /// \brief Signed greater than comparison
1104 /// Regards both *this as a signed quantity and compares it with RHS for
1105 /// the validity of the greater-than relationship.
1107 /// \returns true if *this > RHS when considered signed.
1108 bool sgt(uint64_t RHS) const { return sgt(APInt(getBitWidth(), RHS)); }
1110 /// \brief Unsigned greater or equal comparison
1112 /// Regards both *this and RHS as unsigned quantities and compares them for
1113 /// validity of the greater-or-equal relationship.
1115 /// \returns true if *this >= RHS when both are considered unsigned.
1116 bool uge(const APInt &RHS) const { return !ult(RHS); }
1118 /// \brief Unsigned greater or equal comparison
1120 /// Regards both *this as an unsigned quantity and compares it with RHS for
1121 /// the validity of the greater-or-equal relationship.
1123 /// \returns true if *this >= RHS when considered unsigned.
1124 bool uge(uint64_t RHS) const { return uge(APInt(getBitWidth(), RHS)); }
1126 /// \brief Signed greather or equal comparison
1128 /// Regards both *this and RHS as signed quantities and compares them for
1129 /// validity of the greater-or-equal relationship.
1131 /// \returns true if *this >= RHS when both are considered signed.
1132 bool sge(const APInt &RHS) const { return !slt(RHS); }
1134 /// \brief Signed greater or equal comparison
1136 /// Regards both *this as a signed quantity and compares it with RHS for
1137 /// the validity of the greater-or-equal relationship.
1139 /// \returns true if *this >= RHS when considered signed.
1140 bool sge(uint64_t RHS) const { return sge(APInt(getBitWidth(), RHS)); }
1142 /// This operation tests if there are any pairs of corresponding bits
1143 /// between this APInt and RHS that are both set.
1144 bool intersects(const APInt &RHS) const { return (*this & RHS) != 0; }
1147 /// \name Resizing Operators
1150 /// \brief Truncate to new width.
1152 /// Truncate the APInt to a specified width. It is an error to specify a width
1153 /// that is greater than or equal to the current width.
1154 APInt LLVM_ATTRIBUTE_UNUSED_RESULT trunc(unsigned width) const;
1156 /// \brief Sign extend to a new width.
1158 /// This operation sign extends the APInt to a new width. If the high order
1159 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
1160 /// It is an error to specify a width that is less than or equal to the
1162 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sext(unsigned width) const;
1164 /// \brief Zero extend to a new width.
1166 /// This operation zero extends the APInt to a new width. The high order bits
1167 /// are filled with 0 bits. It is an error to specify a width that is less
1168 /// than or equal to the current width.
1169 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zext(unsigned width) const;
1171 /// \brief Sign extend or truncate to width
1173 /// Make this APInt have the bit width given by \p width. The value is sign
1174 /// extended, truncated, or left alone to make it that width.
1175 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrTrunc(unsigned width) const;
1177 /// \brief Zero extend or truncate to width
1179 /// Make this APInt have the bit width given by \p width. The value is zero
1180 /// extended, truncated, or left alone to make it that width.
1181 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrTrunc(unsigned width) const;
1183 /// \brief Sign extend or truncate to width
1185 /// Make this APInt have the bit width given by \p width. The value is sign
1186 /// extended, or left alone to make it that width.
1187 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sextOrSelf(unsigned width) const;
1189 /// \brief Zero extend or truncate to width
1191 /// Make this APInt have the bit width given by \p width. The value is zero
1192 /// extended, or left alone to make it that width.
1193 APInt LLVM_ATTRIBUTE_UNUSED_RESULT zextOrSelf(unsigned width) const;
1196 /// \name Bit Manipulation Operators
1199 /// \brief Set every bit to 1.
1204 // Set all the bits in all the words.
1205 for (unsigned i = 0; i < getNumWords(); ++i)
1206 pVal[i] = UINT64_MAX;
1208 // Clear the unused ones
1212 /// \brief Set a given bit to 1.
1214 /// Set the given bit to 1 whose position is given as "bitPosition".
1215 void setBit(unsigned bitPosition);
1217 /// \brief Set every bit to 0.
1218 void clearAllBits() {
1222 memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
1225 /// \brief Set a given bit to 0.
1227 /// Set the given bit to 0 whose position is given as "bitPosition".
1228 void clearBit(unsigned bitPosition);
1230 /// \brief Toggle every bit to its opposite value.
1231 void flipAllBits() {
1235 for (unsigned i = 0; i < getNumWords(); ++i)
1236 pVal[i] ^= UINT64_MAX;
1241 /// \brief Toggles a given bit to its opposite value.
1243 /// Toggle a given bit to its opposite value whose position is given
1244 /// as "bitPosition".
1245 void flipBit(unsigned bitPosition);
1247 /// \brief Returns true if the bit in bitPosition is set.
1248 bool extractBit(unsigned bitPosition) const;
1251 /// \name Value Characterization Functions
1254 /// \brief Return the number of bits in the APInt.
1255 unsigned getBitWidth() const { return BitWidth; }
1257 /// \brief Get the number of words.
1259 /// Here one word's bitwidth equals to that of uint64_t.
1261 /// \returns the number of words to hold the integer value of this APInt.
1262 unsigned getNumWords() const { return getNumWords(BitWidth); }
1264 /// \brief Get the number of words.
1266 /// *NOTE* Here one word's bitwidth equals to that of uint64_t.
1268 /// \returns the number of words to hold the integer value with a given bit
1270 static unsigned getNumWords(unsigned BitWidth) {
1271 return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1274 /// \brief Compute the number of active bits in the value
1276 /// This function returns the number of active bits which is defined as the
1277 /// bit width minus the number of leading zeros. This is used in several
1278 /// computations to see how "wide" the value is.
1279 unsigned getActiveBits() const { return BitWidth - countLeadingZeros(); }
1281 /// \brief Compute the number of active words in the value of this APInt.
1283 /// This is used in conjunction with getActiveData to extract the raw value of
1285 unsigned getActiveWords() const {
1286 unsigned numActiveBits = getActiveBits();
1287 return numActiveBits ? whichWord(numActiveBits - 1) + 1 : 1;
1290 /// \brief Get the minimum bit size for this signed APInt
1292 /// Computes the minimum bit width for this APInt while considering it to be a
1293 /// signed (and probably negative) value. If the value is not negative, this
1294 /// function returns the same value as getActiveBits()+1. Otherwise, it
1295 /// returns the smallest bit width that will retain the negative value. For
1296 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1297 /// for -1, this function will always return 1.
1298 unsigned getMinSignedBits() const {
1300 return BitWidth - countLeadingOnes() + 1;
1301 return getActiveBits() + 1;
1304 /// \brief Get zero extended value
1306 /// This method attempts to return the value of this APInt as a zero extended
1307 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1308 /// uint64_t. Otherwise an assertion will result.
1309 uint64_t getZExtValue() const {
1312 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1316 /// \brief Get sign extended value
1318 /// This method attempts to return the value of this APInt as a sign extended
1319 /// int64_t. The bit width must be <= 64 or the value must fit within an
1320 /// int64_t. Otherwise an assertion will result.
1321 int64_t getSExtValue() const {
1323 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1324 (APINT_BITS_PER_WORD - BitWidth);
1325 assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
1326 return int64_t(pVal[0]);
1329 /// \brief Get bits required for string value.
1331 /// This method determines how many bits are required to hold the APInt
1332 /// equivalent of the string given by \p str.
1333 static unsigned getBitsNeeded(StringRef str, uint8_t radix);
1335 /// \brief The APInt version of the countLeadingZeros functions in
1338 /// It counts the number of zeros from the most significant bit to the first
1341 /// \returns BitWidth if the value is zero, otherwise returns the number of
1342 /// zeros from the most significant bit to the first one bits.
1343 unsigned countLeadingZeros() const {
1344 if (isSingleWord()) {
1345 unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
1346 return llvm::countLeadingZeros(VAL) - unusedBits;
1348 return countLeadingZerosSlowCase();
1351 /// \brief Count the number of leading one bits.
1353 /// This function is an APInt version of the countLeadingOnes_{32,64}
1354 /// functions in MathExtras.h. It counts the number of ones from the most
1355 /// significant bit to the first zero bit.
1357 /// \returns 0 if the high order bit is not set, otherwise returns the number
1358 /// of 1 bits from the most significant to the least
1359 unsigned countLeadingOnes() const;
1361 /// Computes the number of leading bits of this APInt that are equal to its
1363 unsigned getNumSignBits() const {
1364 return isNegative() ? countLeadingOnes() : countLeadingZeros();
1367 /// \brief Count the number of trailing zero bits.
1369 /// This function is an APInt version of the countTrailingZeros_{32,64}
1370 /// functions in MathExtras.h. It counts the number of zeros from the least
1371 /// significant bit to the first set bit.
1373 /// \returns BitWidth if the value is zero, otherwise returns the number of
1374 /// zeros from the least significant bit to the first one bit.
1375 unsigned countTrailingZeros() const;
1377 /// \brief Count the number of trailing one bits.
1379 /// This function is an APInt version of the countTrailingOnes_{32,64}
1380 /// functions in MathExtras.h. It counts the number of ones from the least
1381 /// significant bit to the first zero bit.
1383 /// \returns BitWidth if the value is all ones, otherwise returns the number
1384 /// of ones from the least significant bit to the first zero bit.
1385 unsigned countTrailingOnes() const {
1387 return CountTrailingOnes_64(VAL);
1388 return countTrailingOnesSlowCase();
1391 /// \brief Count the number of bits set.
1393 /// This function is an APInt version of the countPopulation_{32,64} functions
1394 /// in MathExtras.h. It counts the number of 1 bits in the APInt value.
1396 /// \returns 0 if the value is zero, otherwise returns the number of set bits.
1397 unsigned countPopulation() const {
1399 return CountPopulation_64(VAL);
1400 return countPopulationSlowCase();
1404 /// \name Conversion Functions
1406 void print(raw_ostream &OS, bool isSigned) const;
1408 /// Converts an APInt to a string and append it to Str. Str is commonly a
1410 void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
1411 bool formatAsCLiteral = false) const;
1413 /// Considers the APInt to be unsigned and converts it into a string in the
1414 /// radix given. The radix can be 2, 8, 10 16, or 36.
1415 void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1416 toString(Str, Radix, false, false);
1419 /// Considers the APInt to be signed and converts it into a string in the
1420 /// radix given. The radix can be 2, 8, 10, 16, or 36.
1421 void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1422 toString(Str, Radix, true, false);
1425 /// \brief Return the APInt as a std::string.
1427 /// Note that this is an inefficient method. It is better to pass in a
1428 /// SmallVector/SmallString to the methods above to avoid thrashing the heap
1430 std::string toString(unsigned Radix, bool Signed) const;
1432 /// \returns a byte-swapped representation of this APInt Value.
1433 APInt LLVM_ATTRIBUTE_UNUSED_RESULT byteSwap() const;
1435 /// \brief Converts this APInt to a double value.
1436 double roundToDouble(bool isSigned) const;
1438 /// \brief Converts this unsigned APInt to a double value.
1439 double roundToDouble() const { return roundToDouble(false); }
1441 /// \brief Converts this signed APInt to a double value.
1442 double signedRoundToDouble() const { return roundToDouble(true); }
1444 /// \brief Converts APInt bits to a double
1446 /// The conversion does not do a translation from integer to double, it just
1447 /// re-interprets the bits as a double. Note that it is valid to do this on
1448 /// any bit width. Exactly 64 bits will be translated.
1449 double bitsToDouble() const {
1454 T.I = (isSingleWord() ? VAL : pVal[0]);
1458 /// \brief Converts APInt bits to a double
1460 /// The conversion does not do a translation from integer to float, it just
1461 /// re-interprets the bits as a float. Note that it is valid to do this on
1462 /// any bit width. Exactly 32 bits will be translated.
1463 float bitsToFloat() const {
1468 T.I = unsigned((isSingleWord() ? VAL : pVal[0]));
1472 /// \brief Converts a double to APInt bits.
1474 /// The conversion does not do a translation from double to integer, it just
1475 /// re-interprets the bits of the double.
1476 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT doubleToBits(double V) {
1482 return APInt(sizeof T * CHAR_BIT, T.I);
1485 /// \brief Converts a float to APInt bits.
1487 /// The conversion does not do a translation from float to integer, it just
1488 /// re-interprets the bits of the float.
1489 static APInt LLVM_ATTRIBUTE_UNUSED_RESULT floatToBits(float V) {
1495 return APInt(sizeof T * CHAR_BIT, T.I);
1499 /// \name Mathematics Operations
1502 /// \returns the floor log base 2 of this APInt.
1503 unsigned logBase2() const { return BitWidth - 1 - countLeadingZeros(); }
1505 /// \returns the ceil log base 2 of this APInt.
1506 unsigned ceilLogBase2() const {
1507 return BitWidth - (*this - 1).countLeadingZeros();
1510 /// \returns the nearest log base 2 of this APInt. Ties round up.
1511 unsigned nearestLogBase2() const {
1512 // This is implemented by taking the normal log 2 of a number and adding 1
1513 // to it if MSB - 1 is set.
1515 // We follow the model from logBase2 that logBase2(0) == UINT32_MAX. This
1516 // works since if we have 0, MSB will be 0. Then we subtract one yielding
1517 // UINT32_MAX. Finally extractBit of MSB - 1 will be UINT32_MAX implying
1518 // that we get BitWidth - 1.
1519 unsigned lg = logBase2();
1520 return lg + unsigned(extractBit(std::min(lg - 1, BitWidth - 1)));
1523 /// \returns the log base 2 of this APInt if its an exact power of two, -1
1525 int32_t exactLogBase2() const {
1531 /// \brief Compute the square root
1532 APInt LLVM_ATTRIBUTE_UNUSED_RESULT sqrt() const;
1534 /// \brief Get the absolute value;
1536 /// If *this is < 0 then return -(*this), otherwise *this;
1537 APInt LLVM_ATTRIBUTE_UNUSED_RESULT abs() const {
1543 /// \returns the multiplicative inverse for a given modulo.
1544 APInt multiplicativeInverse(const APInt &modulo) const;
1547 /// \name Support for division by constant
1550 /// Calculate the magic number for signed division by a constant.
1554 /// Calculate the magic number for unsigned division by a constant.
1556 mu magicu(unsigned LeadingZeros = 0) const;
1559 /// \name Building-block Operations for APInt and APFloat
1562 // These building block operations operate on a representation of arbitrary
1563 // precision, two's-complement, bignum integer values. They should be
1564 // sufficient to implement APInt and APFloat bignum requirements. Inputs are
1565 // generally a pointer to the base of an array of integer parts, representing
1566 // an unsigned bignum, and a count of how many parts there are.
1568 /// Sets the least significant part of a bignum to the input value, and zeroes
1569 /// out higher parts.
1570 static void tcSet(integerPart *, integerPart, unsigned int);
1572 /// Assign one bignum to another.
1573 static void tcAssign(integerPart *, const integerPart *, unsigned int);
1575 /// Returns true if a bignum is zero, false otherwise.
1576 static bool tcIsZero(const integerPart *, unsigned int);
1578 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1579 static int tcExtractBit(const integerPart *, unsigned int bit);
1581 /// Copy the bit vector of width srcBITS from SRC, starting at bit srcLSB, to
1582 /// DST, of dstCOUNT parts, such that the bit srcLSB becomes the least
1583 /// significant bit of DST. All high bits above srcBITS in DST are
1585 static void tcExtract(integerPart *, unsigned int dstCount,
1586 const integerPart *, unsigned int srcBits,
1587 unsigned int srcLSB);
1589 /// Set the given bit of a bignum. Zero-based.
1590 static void tcSetBit(integerPart *, unsigned int bit);
1592 /// Clear the given bit of a bignum. Zero-based.
1593 static void tcClearBit(integerPart *, unsigned int bit);
1595 /// Returns the bit number of the least or most significant set bit of a
1596 /// number. If the input number has no bits set -1U is returned.
1597 static unsigned int tcLSB(const integerPart *, unsigned int);
1598 static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1600 /// Negate a bignum in-place.
1601 static void tcNegate(integerPart *, unsigned int);
1603 /// DST += RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1604 static integerPart tcAdd(integerPart *, const integerPart *,
1605 integerPart carry, unsigned);
1607 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1608 static integerPart tcSubtract(integerPart *, const integerPart *,
1609 integerPart carry, unsigned);
1611 /// DST += SRC * MULTIPLIER + PART if add is true
1612 /// DST = SRC * MULTIPLIER + PART if add is false
1614 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC they must
1615 /// start at the same point, i.e. DST == SRC.
1617 /// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is returned.
1618 /// Otherwise DST is filled with the least significant DSTPARTS parts of the
1619 /// result, and if all of the omitted higher parts were zero return zero,
1620 /// otherwise overflow occurred and return one.
1621 static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1622 integerPart multiplier, integerPart carry,
1623 unsigned int srcParts, unsigned int dstParts,
1626 /// DST = LHS * RHS, where DST has the same width as the operands and is
1627 /// filled with the least significant parts of the result. Returns one if
1628 /// overflow occurred, otherwise zero. DST must be disjoint from both
1630 static int tcMultiply(integerPart *, const integerPart *, const integerPart *,
1633 /// DST = LHS * RHS, where DST has width the sum of the widths of the
1634 /// operands. No overflow occurs. DST must be disjoint from both
1635 /// operands. Returns the number of parts required to hold the result.
1636 static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1637 const integerPart *, unsigned, unsigned);
1639 /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1640 /// Otherwise set LHS to LHS / RHS with the fractional part discarded, set
1641 /// REMAINDER to the remainder, return zero. i.e.
1643 /// OLD_LHS = RHS * LHS + REMAINDER
1645 /// SCRATCH is a bignum of the same size as the operands and result for use by
1646 /// the routine; its contents need not be initialized and are destroyed. LHS,
1647 /// REMAINDER and SCRATCH must be distinct.
1648 static int tcDivide(integerPart *lhs, const integerPart *rhs,
1649 integerPart *remainder, integerPart *scratch,
1650 unsigned int parts);
1652 /// Shift a bignum left COUNT bits. Shifted in bits are zero. There are no
1653 /// restrictions on COUNT.
1654 static void tcShiftLeft(integerPart *, unsigned int parts,
1655 unsigned int count);
1657 /// Shift a bignum right COUNT bits. Shifted in bits are zero. There are no
1658 /// restrictions on COUNT.
1659 static void tcShiftRight(integerPart *, unsigned int parts,
1660 unsigned int count);
1662 /// The obvious AND, OR and XOR and complement operations.
1663 static void tcAnd(integerPart *, const integerPart *, unsigned int);
1664 static void tcOr(integerPart *, const integerPart *, unsigned int);
1665 static void tcXor(integerPart *, const integerPart *, unsigned int);
1666 static void tcComplement(integerPart *, unsigned int);
1668 /// Comparison (unsigned) of two bignums.
1669 static int tcCompare(const integerPart *, const integerPart *, unsigned int);
1671 /// Increment a bignum in-place. Return the carry flag.
1672 static integerPart tcIncrement(integerPart *, unsigned int);
1674 /// Decrement a bignum in-place. Return the borrow flag.
1675 static integerPart tcDecrement(integerPart *, unsigned int);
1677 /// Set the least significant BITS and clear the rest.
1678 static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1681 /// \brief debug method
1687 /// Magic data for optimising signed division by a constant.
1689 APInt m; ///< magic number
1690 unsigned s; ///< shift amount
1693 /// Magic data for optimising unsigned division by a constant.
1695 APInt m; ///< magic number
1696 bool a; ///< add indicator
1697 unsigned s; ///< shift amount
1700 inline bool operator==(uint64_t V1, const APInt &V2) { return V2 == V1; }
1702 inline bool operator!=(uint64_t V1, const APInt &V2) { return V2 != V1; }
1704 inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
1709 namespace APIntOps {
1711 /// \brief Determine the smaller of two APInts considered to be signed.
1712 inline APInt smin(const APInt &A, const APInt &B) { return A.slt(B) ? A : B; }
1714 /// \brief Determine the larger of two APInts considered to be signed.
1715 inline APInt smax(const APInt &A, const APInt &B) { return A.sgt(B) ? A : B; }
1717 /// \brief Determine the smaller of two APInts considered to be signed.
1718 inline APInt umin(const APInt &A, const APInt &B) { return A.ult(B) ? A : B; }
1720 /// \brief Determine the larger of two APInts considered to be unsigned.
1721 inline APInt umax(const APInt &A, const APInt &B) { return A.ugt(B) ? A : B; }
1723 /// \brief Check if the specified APInt has a N-bits unsigned integer value.
1724 inline bool isIntN(unsigned N, const APInt &APIVal) { return APIVal.isIntN(N); }
1726 /// \brief Check if the specified APInt has a N-bits signed integer value.
1727 inline bool isSignedIntN(unsigned N, const APInt &APIVal) {
1728 return APIVal.isSignedIntN(N);
1731 /// \returns true if the argument APInt value is a sequence of ones starting at
1732 /// the least significant bit with the remainder zero.
1733 inline bool isMask(unsigned numBits, const APInt &APIVal) {
1734 return numBits <= APIVal.getBitWidth() &&
1735 APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
1738 /// \brief Return true if the argument APInt value contains a sequence of ones
1739 /// with the remainder zero.
1740 inline bool isShiftedMask(unsigned numBits, const APInt &APIVal) {
1741 return isMask(numBits, (APIVal - APInt(numBits, 1)) | APIVal);
1744 /// \brief Returns a byte-swapped representation of the specified APInt Value.
1745 inline APInt byteSwap(const APInt &APIVal) { return APIVal.byteSwap(); }
1747 /// \brief Returns the floor log base 2 of the specified APInt value.
1748 inline unsigned logBase2(const APInt &APIVal) { return APIVal.logBase2(); }
1750 /// \brief Compute GCD of two APInt values.
1752 /// This function returns the greatest common divisor of the two APInt values
1753 /// using Euclid's algorithm.
1755 /// \returns the greatest common divisor of Val1 and Val2
1756 APInt GreatestCommonDivisor(const APInt &Val1, const APInt &Val2);
1758 /// \brief Converts the given APInt to a double value.
1760 /// Treats the APInt as an unsigned value for conversion purposes.
1761 inline double RoundAPIntToDouble(const APInt &APIVal) {
1762 return APIVal.roundToDouble();
1765 /// \brief Converts the given APInt to a double value.
1767 /// Treats the APInt as a signed value for conversion purposes.
1768 inline double RoundSignedAPIntToDouble(const APInt &APIVal) {
1769 return APIVal.signedRoundToDouble();
1772 /// \brief Converts the given APInt to a float vlalue.
1773 inline float RoundAPIntToFloat(const APInt &APIVal) {
1774 return float(RoundAPIntToDouble(APIVal));
1777 /// \brief Converts the given APInt to a float value.
1779 /// Treast the APInt as a signed value for conversion purposes.
1780 inline float RoundSignedAPIntToFloat(const APInt &APIVal) {
1781 return float(APIVal.signedRoundToDouble());
1784 /// \brief Converts the given double value into a APInt.
1786 /// This function convert a double value to an APInt value.
1787 APInt RoundDoubleToAPInt(double Double, unsigned width);
1789 /// \brief Converts a float value into a APInt.
1791 /// Converts a float value into an APInt value.
1792 inline APInt RoundFloatToAPInt(float Float, unsigned width) {
1793 return RoundDoubleToAPInt(double(Float), width);
1796 /// \brief Arithmetic right-shift function.
1798 /// Arithmetic right-shift the APInt by shiftAmt.
1799 inline APInt ashr(const APInt &LHS, unsigned shiftAmt) {
1800 return LHS.ashr(shiftAmt);
1803 /// \brief Logical right-shift function.
1805 /// Logical right-shift the APInt by shiftAmt.
1806 inline APInt lshr(const APInt &LHS, unsigned shiftAmt) {
1807 return LHS.lshr(shiftAmt);
1810 /// \brief Left-shift function.
1812 /// Left-shift the APInt by shiftAmt.
1813 inline APInt shl(const APInt &LHS, unsigned shiftAmt) {
1814 return LHS.shl(shiftAmt);
1817 /// \brief Signed division function for APInt.
1819 /// Signed divide APInt LHS by APInt RHS.
1820 inline APInt sdiv(const APInt &LHS, const APInt &RHS) { return LHS.sdiv(RHS); }
1822 /// \brief Unsigned division function for APInt.
1824 /// Unsigned divide APInt LHS by APInt RHS.
1825 inline APInt udiv(const APInt &LHS, const APInt &RHS) { return LHS.udiv(RHS); }
1827 /// \brief Function for signed remainder operation.
1829 /// Signed remainder operation on APInt.
1830 inline APInt srem(const APInt &LHS, const APInt &RHS) { return LHS.srem(RHS); }
1832 /// \brief Function for unsigned remainder operation.
1834 /// Unsigned remainder operation on APInt.
1835 inline APInt urem(const APInt &LHS, const APInt &RHS) { return LHS.urem(RHS); }
1837 /// \brief Function for multiplication operation.
1839 /// Performs multiplication on APInt values.
1840 inline APInt mul(const APInt &LHS, const APInt &RHS) { return LHS * RHS; }
1842 /// \brief Function for addition operation.
1844 /// Performs addition on APInt values.
1845 inline APInt add(const APInt &LHS, const APInt &RHS) { return LHS + RHS; }
1847 /// \brief Function for subtraction operation.
1849 /// Performs subtraction on APInt values.
1850 inline APInt sub(const APInt &LHS, const APInt &RHS) { return LHS - RHS; }
1852 /// \brief Bitwise AND function for APInt.
1854 /// Performs bitwise AND operation on APInt LHS and
1856 inline APInt And(const APInt &LHS, const APInt &RHS) { return LHS & RHS; }
1858 /// \brief Bitwise OR function for APInt.
1860 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1861 inline APInt Or(const APInt &LHS, const APInt &RHS) { return LHS | RHS; }
1863 /// \brief Bitwise XOR function for APInt.
1865 /// Performs bitwise XOR operation on APInt.
1866 inline APInt Xor(const APInt &LHS, const APInt &RHS) { return LHS ^ RHS; }
1868 /// \brief Bitwise complement function.
1870 /// Performs a bitwise complement operation on APInt.
1871 inline APInt Not(const APInt &APIVal) { return ~APIVal; }
1873 } // End of APIntOps namespace
1875 // See friend declaration above. This additional declaration is required in
1876 // order to compile LLVM with IBM xlC compiler.
1877 hash_code hash_value(const APInt &Arg);
1878 } // End of llvm namespace