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/Support/Compiler.h"
20 #include "llvm/Support/MathExtras.h"
27 class FoldingSetNodeID;
32 template <typename T> class SmallVectorImpl;
33 template <typename T> class ArrayRef;
37 inline APInt operator-(APInt);
39 //===----------------------------------------------------------------------===//
41 //===----------------------------------------------------------------------===//
43 /// \brief Class for arbitrary precision integers.
45 /// APInt is a functional replacement for common case unsigned integer type like
46 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
47 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
48 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
49 /// and methods to manipulate integer values of any bit-width. It supports both
50 /// the typical integer arithmetic and comparison operations as well as bitwise
53 /// The class has several invariants worth noting:
54 /// * All bit, byte, and word positions are zero-based.
55 /// * Once the bit width is set, it doesn't change except by the Truncate,
56 /// SignExtend, or ZeroExtend operations.
57 /// * All binary operators must be on APInt instances of the same bit width.
58 /// Attempting to use these operators on instances with different bit
59 /// widths will yield an assertion.
60 /// * The value is stored canonically as an unsigned value. For operations
61 /// where it makes a difference, there are both signed and unsigned variants
62 /// of the operation. For example, sdiv and udiv. However, because the bit
63 /// widths must be the same, operations such as Mul and Add produce the same
64 /// results regardless of whether the values are interpreted as signed or
66 /// * In general, the class tries to follow the style of computation that LLVM
67 /// uses in its IR. This simplifies its use for LLVM.
69 class LLVM_NODISCARD APInt {
71 typedef uint64_t WordType;
73 /// This enum is used to hold the constants we needed for APInt.
75 /// Byte size of a word.
76 APINT_WORD_SIZE = sizeof(WordType),
78 APINT_BITS_PER_WORD = APINT_WORD_SIZE * CHAR_BIT
81 static const WordType WORD_MAX = ~WordType(0);
84 /// This union is used to store the integer value. When the
85 /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
87 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
88 uint64_t *pVal; ///< Used to store the >64 bits integer value.
91 unsigned BitWidth; ///< The number of bits in this APInt.
93 friend struct DenseMapAPIntKeyInfo;
97 /// \brief Fast internal constructor
99 /// This constructor is used only internally for speed of construction of
100 /// temporaries. It is unsafe for general use so it is not public.
101 APInt(uint64_t *val, unsigned bits) : BitWidth(bits) {
105 /// \brief Determine if this APInt just has one word to store value.
107 /// \returns true if the number of bits <= 64, false otherwise.
108 bool isSingleWord() const { return BitWidth <= APINT_BITS_PER_WORD; }
110 /// \brief Determine which word a bit is in.
112 /// \returns the word position for the specified bit position.
113 static unsigned whichWord(unsigned bitPosition) {
114 return bitPosition / APINT_BITS_PER_WORD;
117 /// \brief Determine which bit in a word a bit is in.
119 /// \returns the bit position in a word for the specified bit position
121 static unsigned whichBit(unsigned bitPosition) {
122 return bitPosition % APINT_BITS_PER_WORD;
125 /// \brief Get a single bit mask.
127 /// \returns a uint64_t with only bit at "whichBit(bitPosition)" set
128 /// This method generates and returns a uint64_t (word) mask for a single
129 /// bit at a specific bit position. This is used to mask the bit in the
130 /// corresponding word.
131 static uint64_t maskBit(unsigned bitPosition) {
132 return 1ULL << whichBit(bitPosition);
135 /// \brief Clear unused high order bits
137 /// This method is used internally to clear the top "N" bits in the high order
138 /// word that are not used by the APInt. This is needed after the most
139 /// significant word is assigned a value to ensure that those bits are
141 APInt &clearUnusedBits() {
142 // Compute how many bits are used in the final word
143 unsigned WordBits = ((BitWidth-1) % APINT_BITS_PER_WORD) + 1;
145 // Mask out the high bits.
146 uint64_t mask = WORD_MAX >> (APINT_BITS_PER_WORD - WordBits);
150 U.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() ? U.VAL : U.pVal[whichWord(bitPosition)];
160 /// Utility method to change the bit width of this APInt to new bit width,
161 /// allocating and/or deallocating as necessary. There is no guarantee on the
162 /// value of any bits upon return. Caller should populate the bits after.
163 void reallocate(unsigned NewBitWidth);
165 /// \brief Convert a char array into an APInt
167 /// \param radix 2, 8, 10, 16, or 36
168 /// Converts a string into a number. The string must be non-empty
169 /// and well-formed as a number of the given base. The bit-width
170 /// must be sufficient to hold the result.
172 /// This is used by the constructors that take string arguments.
174 /// StringRef::getAsInteger is superficially similar but (1) does
175 /// not assume that the string is well-formed and (2) grows the
176 /// result to hold the input.
177 void fromString(unsigned numBits, StringRef str, uint8_t radix);
179 /// \brief An internal division function for dividing APInts.
181 /// This is used by the toString method to divide by the radix. It simply
182 /// provides a more convenient form of divide for internal use since KnuthDiv
183 /// has specific constraints on its inputs. If those constraints are not met
184 /// then it provides a simpler form of divide.
185 static void divide(const APInt &LHS, unsigned lhsWords, const APInt &RHS,
186 unsigned rhsWords, APInt *Quotient, APInt *Remainder);
188 /// out-of-line slow case for inline constructor
189 void initSlowCase(uint64_t val, bool isSigned);
191 /// shared code between two array constructors
192 void initFromArray(ArrayRef<uint64_t> array);
194 /// out-of-line slow case for inline copy constructor
195 void initSlowCase(const APInt &that);
197 /// out-of-line slow case for shl
198 void shlSlowCase(unsigned ShiftAmt);
200 /// out-of-line slow case for lshr.
201 void lshrSlowCase(unsigned ShiftAmt);
203 /// out-of-line slow case for ashr.
204 void ashrSlowCase(unsigned ShiftAmt);
206 /// out-of-line slow case for operator=
207 void AssignSlowCase(const APInt &RHS);
209 /// out-of-line slow case for operator==
210 bool EqualSlowCase(const APInt &RHS) const LLVM_READONLY;
212 /// out-of-line slow case for countLeadingZeros
213 unsigned countLeadingZerosSlowCase() const LLVM_READONLY;
215 /// out-of-line slow case for countTrailingOnes
216 unsigned countTrailingOnesSlowCase() const LLVM_READONLY;
218 /// out-of-line slow case for countPopulation
219 unsigned countPopulationSlowCase() const LLVM_READONLY;
221 /// out-of-line slow case for intersects.
222 bool intersectsSlowCase(const APInt &RHS) const LLVM_READONLY;
224 /// out-of-line slow case for isSubsetOf.
225 bool isSubsetOfSlowCase(const APInt &RHS) const LLVM_READONLY;
227 /// out-of-line slow case for setBits.
228 void setBitsSlowCase(unsigned loBit, unsigned hiBit);
230 /// out-of-line slow case for flipAllBits.
231 void flipAllBitsSlowCase();
233 /// out-of-line slow case for operator&=.
234 void AndAssignSlowCase(const APInt& RHS);
236 /// out-of-line slow case for operator|=.
237 void OrAssignSlowCase(const APInt& RHS);
239 /// out-of-line slow case for operator^=.
240 void XorAssignSlowCase(const APInt& RHS);
242 /// Unsigned comparison. Returns -1, 0, or 1 if this APInt is less than, equal
243 /// to, or greater than RHS.
244 int compare(const APInt &RHS) const LLVM_READONLY;
246 /// Signed comparison. Returns -1, 0, or 1 if this APInt is less than, equal
247 /// to, or greater than RHS.
248 int compareSigned(const APInt &RHS) const LLVM_READONLY;
251 /// \name Constructors
254 /// \brief Create a new APInt of numBits width, initialized as val.
256 /// If isSigned is true then val is treated as if it were a signed value
257 /// (i.e. as an int64_t) and the appropriate sign extension to the bit width
258 /// will be done. Otherwise, no sign extension occurs (high order bits beyond
259 /// the range of val are zero filled).
261 /// \param numBits the bit width of the constructed APInt
262 /// \param val the initial value of the APInt
263 /// \param isSigned how to treat signedness of val
264 APInt(unsigned numBits, uint64_t val, bool isSigned = false)
265 : BitWidth(numBits) {
266 assert(BitWidth && "bitwidth too small");
267 if (isSingleWord()) {
271 initSlowCase(val, isSigned);
275 /// \brief Construct an APInt of numBits width, initialized as bigVal[].
277 /// Note that bigVal.size() can be smaller or larger than the corresponding
278 /// bit width but any extraneous bits will be dropped.
280 /// \param numBits the bit width of the constructed APInt
281 /// \param bigVal a sequence of words to form the initial value of the APInt
282 APInt(unsigned numBits, ArrayRef<uint64_t> bigVal);
284 /// Equivalent to APInt(numBits, ArrayRef<uint64_t>(bigVal, numWords)), but
285 /// deprecated because this constructor is prone to ambiguity with the
286 /// APInt(unsigned, uint64_t, bool) constructor.
288 /// If this overload is ever deleted, care should be taken to prevent calls
289 /// from being incorrectly captured by the APInt(unsigned, uint64_t, bool)
291 APInt(unsigned numBits, unsigned numWords, const uint64_t bigVal[]);
293 /// \brief Construct an APInt from a string representation.
295 /// This constructor interprets the string \p str in the given radix. The
296 /// interpretation stops when the first character that is not suitable for the
297 /// radix is encountered, or the end of the string. Acceptable radix values
298 /// are 2, 8, 10, 16, and 36. It is an error for the value implied by the
299 /// string to require more bits than numBits.
301 /// \param numBits the bit width of the constructed APInt
302 /// \param str the string to be interpreted
303 /// \param radix the radix to use for the conversion
304 APInt(unsigned numBits, StringRef str, uint8_t radix);
306 /// Simply makes *this a copy of that.
307 /// @brief Copy Constructor.
308 APInt(const APInt &that) : BitWidth(that.BitWidth) {
315 /// \brief Move Constructor.
316 APInt(APInt &&that) : BitWidth(that.BitWidth) {
317 memcpy(&U, &that.U, sizeof(U));
321 /// \brief Destructor.
327 /// \brief Default constructor that creates an uninteresting APInt
328 /// representing a 1-bit zero value.
330 /// This is useful for object deserialization (pair this with the static
332 explicit APInt() : BitWidth(1) { U.VAL = 0; }
334 /// \brief Returns whether this instance allocated memory.
335 bool needsCleanup() const { return !isSingleWord(); }
337 /// Used to insert APInt objects, or objects that contain APInt objects, into
339 void Profile(FoldingSetNodeID &id) const;
342 /// \name Value Tests
345 /// \brief Determine sign of this APInt.
347 /// This tests the high bit of this APInt to determine if it is set.
349 /// \returns true if this APInt is negative, false otherwise
350 bool isNegative() const { return (*this)[BitWidth - 1]; }
352 /// \brief Determine if this APInt Value is non-negative (>= 0)
354 /// This tests the high bit of the APInt to determine if it is unset.
355 bool isNonNegative() const { return !isNegative(); }
357 /// \brief Determine if sign bit of this APInt is set.
359 /// This tests the high bit of this APInt to determine if it is set.
361 /// \returns true if this APInt has its sign bit set, false otherwise.
362 bool isSignBitSet() const { return (*this)[BitWidth-1]; }
364 /// \brief Determine if sign bit of this APInt is clear.
366 /// This tests the high bit of this APInt to determine if it is clear.
368 /// \returns true if this APInt has its sign bit clear, false otherwise.
369 bool isSignBitClear() const { return !isSignBitSet(); }
371 /// \brief Determine if this APInt Value is positive.
373 /// This tests if the value of this APInt is positive (> 0). Note
374 /// that 0 is not a positive value.
376 /// \returns true if this APInt is positive.
377 bool isStrictlyPositive() const { return isNonNegative() && !isNullValue(); }
379 /// \brief Determine if all bits are set
381 /// This checks to see if the value has all bits of the APInt are set or not.
382 bool isAllOnesValue() const {
384 return U.VAL == WORD_MAX >> (APINT_BITS_PER_WORD - BitWidth);
385 return countPopulationSlowCase() == BitWidth;
388 /// \brief Determine if all bits are clear
390 /// This checks to see if the value has all bits of the APInt are clear or
392 bool isNullValue() const { return !*this; }
394 /// \brief Determine if this is the largest unsigned value.
396 /// This checks to see if the value of this APInt is the maximum unsigned
397 /// value for the APInt's bit width.
398 bool isMaxValue() const { return isAllOnesValue(); }
400 /// \brief Determine if this is the largest signed value.
402 /// This checks to see if the value of this APInt is the maximum signed
403 /// value for the APInt's bit width.
404 bool isMaxSignedValue() const {
405 return !isNegative() && countPopulation() == BitWidth - 1;
408 /// \brief Determine if this is the smallest unsigned value.
410 /// This checks to see if the value of this APInt is the minimum unsigned
411 /// value for the APInt's bit width.
412 bool isMinValue() const { return isNullValue(); }
414 /// \brief Determine if this is the smallest signed value.
416 /// This checks to see if the value of this APInt is the minimum signed
417 /// value for the APInt's bit width.
418 bool isMinSignedValue() const {
419 return isNegative() && isPowerOf2();
422 /// \brief Check if this APInt has an N-bits unsigned integer value.
423 bool isIntN(unsigned N) const {
424 assert(N && "N == 0 ???");
425 return getActiveBits() <= N;
428 /// \brief Check if this APInt has an N-bits signed integer value.
429 bool isSignedIntN(unsigned N) const {
430 assert(N && "N == 0 ???");
431 return getMinSignedBits() <= N;
434 /// \brief Check if this APInt's value is a power of two greater than zero.
436 /// \returns true if the argument APInt value is a power of two > 0.
437 bool isPowerOf2() const {
439 return isPowerOf2_64(U.VAL);
440 return countPopulationSlowCase() == 1;
443 /// \brief Check if the APInt's value is returned by getSignMask.
445 /// \returns true if this is the value returned by getSignMask.
446 bool isSignMask() const { return isMinSignedValue(); }
448 /// \brief Convert APInt to a boolean value.
450 /// This converts the APInt to a boolean value as a test against zero.
451 bool getBoolValue() const { return !!*this; }
453 /// If this value is smaller than the specified limit, return it, otherwise
454 /// return the limit value. This causes the value to saturate to the limit.
455 uint64_t getLimitedValue(uint64_t Limit = UINT64_MAX) const {
456 return ugt(Limit) ? Limit : getZExtValue();
459 /// \brief Check if the APInt consists of a repeated bit pattern.
461 /// e.g. 0x01010101 satisfies isSplat(8).
462 /// \param SplatSizeInBits The size of the pattern in bits. Must divide bit
463 /// width without remainder.
464 bool isSplat(unsigned SplatSizeInBits) const;
466 /// \returns true if this APInt value is a sequence of \param numBits ones
467 /// starting at the least significant bit with the remainder zero.
468 bool isMask(unsigned numBits) const {
469 assert(numBits != 0 && "numBits must be non-zero");
470 assert(numBits <= BitWidth && "numBits out of range");
472 return U.VAL == (WORD_MAX >> (APINT_BITS_PER_WORD - numBits));
473 unsigned Ones = countTrailingOnesSlowCase();
474 return (numBits == Ones) &&
475 ((Ones + countLeadingZerosSlowCase()) == BitWidth);
478 /// \returns true if this APInt is a non-empty sequence of ones starting at
479 /// the least significant bit with the remainder zero.
480 /// Ex. isMask(0x0000FFFFU) == true.
481 bool isMask() const {
483 return isMask_64(U.VAL);
484 unsigned Ones = countTrailingOnesSlowCase();
485 return (Ones > 0) && ((Ones + countLeadingZerosSlowCase()) == BitWidth);
488 /// \brief Return true if this APInt value contains a sequence of ones with
489 /// the remainder zero.
490 bool isShiftedMask() const {
492 return isShiftedMask_64(U.VAL);
493 unsigned Ones = countPopulationSlowCase();
494 unsigned LeadZ = countLeadingZerosSlowCase();
495 return (Ones + LeadZ + countTrailingZeros()) == BitWidth;
499 /// \name Value Generators
502 /// \brief Gets maximum unsigned value of APInt for specific bit width.
503 static APInt getMaxValue(unsigned numBits) {
504 return getAllOnesValue(numBits);
507 /// \brief Gets maximum signed value of APInt for a specific bit width.
508 static APInt getSignedMaxValue(unsigned numBits) {
509 APInt API = getAllOnesValue(numBits);
510 API.clearBit(numBits - 1);
514 /// \brief Gets minimum unsigned value of APInt for a specific bit width.
515 static APInt getMinValue(unsigned numBits) { return APInt(numBits, 0); }
517 /// \brief Gets minimum signed value of APInt for a specific bit width.
518 static APInt getSignedMinValue(unsigned numBits) {
519 APInt API(numBits, 0);
520 API.setBit(numBits - 1);
524 /// \brief Get the SignMask for a specific bit width.
526 /// This is just a wrapper function of getSignedMinValue(), and it helps code
527 /// readability when we want to get a SignMask.
528 static APInt getSignMask(unsigned BitWidth) {
529 return getSignedMinValue(BitWidth);
532 /// \brief Get the all-ones value.
534 /// \returns the all-ones value for an APInt of the specified bit-width.
535 static APInt getAllOnesValue(unsigned numBits) {
536 return APInt(numBits, WORD_MAX, true);
539 /// \brief Get the '0' value.
541 /// \returns the '0' value for an APInt of the specified bit-width.
542 static APInt getNullValue(unsigned numBits) { return APInt(numBits, 0); }
544 /// \brief Compute an APInt containing numBits highbits from this APInt.
546 /// Get an APInt with the same BitWidth as this APInt, just zero mask
547 /// the low bits and right shift to the least significant bit.
549 /// \returns the high "numBits" bits of this APInt.
550 APInt getHiBits(unsigned numBits) const;
552 /// \brief Compute an APInt containing numBits lowbits from this APInt.
554 /// Get an APInt with the same BitWidth as this APInt, just zero mask
557 /// \returns the low "numBits" bits of this APInt.
558 APInt getLoBits(unsigned numBits) const;
560 /// \brief Return an APInt with exactly one bit set in the result.
561 static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
562 APInt Res(numBits, 0);
567 /// \brief Get a value with a block of bits set.
569 /// Constructs an APInt value that has a contiguous range of bits set. The
570 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
571 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
572 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
573 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
575 /// \param numBits the intended bit width of the result
576 /// \param loBit the index of the lowest bit set.
577 /// \param hiBit the index of the highest bit set.
579 /// \returns An APInt value with the requested bits set.
580 static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
581 APInt Res(numBits, 0);
582 Res.setBits(loBit, hiBit);
586 /// \brief Get a value with upper bits starting at loBit set.
588 /// Constructs an APInt value that has a contiguous range of bits set. The
589 /// bits from loBit (inclusive) to numBits (exclusive) will be set. All other
590 /// bits will be zero. For example, with parameters(32, 12) you would get
593 /// \param numBits the intended bit width of the result
594 /// \param loBit the index of the lowest bit to set.
596 /// \returns An APInt value with the requested bits set.
597 static APInt getBitsSetFrom(unsigned numBits, unsigned loBit) {
598 APInt Res(numBits, 0);
599 Res.setBitsFrom(loBit);
603 /// \brief Get a value with high bits set
605 /// Constructs an APInt value that has the top hiBitsSet bits set.
607 /// \param numBits the bitwidth of the result
608 /// \param hiBitsSet the number of high-order bits set in the result.
609 static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
610 APInt Res(numBits, 0);
611 Res.setHighBits(hiBitsSet);
615 /// \brief Get a value with low bits set
617 /// Constructs an APInt value that has the bottom loBitsSet bits set.
619 /// \param numBits the bitwidth of the result
620 /// \param loBitsSet the number of low-order bits set in the result.
621 static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
622 APInt Res(numBits, 0);
623 Res.setLowBits(loBitsSet);
627 /// \brief Return a value containing V broadcasted over NewLen bits.
628 static APInt getSplat(unsigned NewLen, const APInt &V);
630 /// \brief Determine if two APInts have the same value, after zero-extending
631 /// one of them (if needed!) to ensure that the bit-widths match.
632 static bool isSameValue(const APInt &I1, const APInt &I2) {
633 if (I1.getBitWidth() == I2.getBitWidth())
636 if (I1.getBitWidth() > I2.getBitWidth())
637 return I1 == I2.zext(I1.getBitWidth());
639 return I1.zext(I2.getBitWidth()) == I2;
642 /// \brief Overload to compute a hash_code for an APInt value.
643 friend hash_code hash_value(const APInt &Arg);
645 /// This function returns a pointer to the internal storage of the APInt.
646 /// This is useful for writing out the APInt in binary form without any
648 const uint64_t *getRawData() const {
655 /// \name Unary Operators
658 /// \brief Postfix increment operator.
660 /// Increments *this by 1.
662 /// \returns a new APInt value representing the original value of *this.
663 const APInt operator++(int) {
669 /// \brief Prefix increment operator.
671 /// \returns *this incremented by one
674 /// \brief Postfix decrement operator.
676 /// Decrements *this by 1.
678 /// \returns a new APInt value representing the original value of *this.
679 const APInt operator--(int) {
685 /// \brief Prefix decrement operator.
687 /// \returns *this decremented by one.
690 /// \brief Logical negation operator.
692 /// Performs logical negation operation on this APInt.
694 /// \returns true if *this is zero, false otherwise.
695 bool operator!() const {
698 return countLeadingZerosSlowCase() == BitWidth;
702 /// \name Assignment Operators
705 /// \brief Copy assignment operator.
707 /// \returns *this after assignment of RHS.
708 APInt &operator=(const APInt &RHS) {
709 // If the bitwidths are the same, we can avoid mucking with memory
710 if (isSingleWord() && RHS.isSingleWord()) {
712 BitWidth = RHS.BitWidth;
713 return clearUnusedBits();
720 /// @brief Move assignment operator.
721 APInt &operator=(APInt &&that) {
722 assert(this != &that && "Self-move not supported");
726 // Use memcpy so that type based alias analysis sees both VAL and pVal
728 memcpy(&U, &that.U, sizeof(U));
730 BitWidth = that.BitWidth;
736 /// \brief Assignment operator.
738 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
739 /// the bit width, the excess bits are truncated. If the bit width is larger
740 /// than 64, the value is zero filled in the unspecified high order bits.
742 /// \returns *this after assignment of RHS value.
743 APInt &operator=(uint64_t RHS) {
744 if (isSingleWord()) {
749 memset(U.pVal+1, 0, (getNumWords() - 1) * APINT_WORD_SIZE);
754 /// \brief Bitwise AND assignment operator.
756 /// Performs a bitwise AND operation on this APInt and RHS. The result is
757 /// assigned to *this.
759 /// \returns *this after ANDing with RHS.
760 APInt &operator&=(const APInt &RHS) {
761 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
765 AndAssignSlowCase(RHS);
769 /// \brief Bitwise AND assignment operator.
771 /// Performs a bitwise AND operation on this APInt and RHS. RHS is
772 /// logically zero-extended or truncated to match the bit-width of
774 APInt &operator&=(uint64_t RHS) {
775 if (isSingleWord()) {
780 memset(U.pVal+1, 0, (getNumWords() - 1) * APINT_WORD_SIZE);
784 /// \brief Bitwise OR assignment operator.
786 /// Performs a bitwise OR operation on this APInt and RHS. The result is
789 /// \returns *this after ORing with RHS.
790 APInt &operator|=(const APInt &RHS) {
791 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
795 OrAssignSlowCase(RHS);
799 /// \brief Bitwise OR assignment operator.
801 /// Performs a bitwise OR operation on this APInt and RHS. RHS is
802 /// logically zero-extended or truncated to match the bit-width of
804 APInt &operator|=(uint64_t RHS) {
805 if (isSingleWord()) {
814 /// \brief Bitwise XOR assignment operator.
816 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
817 /// assigned to *this.
819 /// \returns *this after XORing with RHS.
820 APInt &operator^=(const APInt &RHS) {
821 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
825 XorAssignSlowCase(RHS);
829 /// \brief Bitwise XOR assignment operator.
831 /// Performs a bitwise XOR operation on this APInt and RHS. RHS is
832 /// logically zero-extended or truncated to match the bit-width of
834 APInt &operator^=(uint64_t RHS) {
835 if (isSingleWord()) {
844 /// \brief Multiplication assignment operator.
846 /// Multiplies this APInt by RHS and assigns the result to *this.
849 APInt &operator*=(const APInt &RHS);
850 APInt &operator*=(uint64_t RHS);
852 /// \brief Addition assignment operator.
854 /// Adds RHS to *this and assigns the result to *this.
857 APInt &operator+=(const APInt &RHS);
858 APInt &operator+=(uint64_t RHS);
860 /// \brief Subtraction assignment operator.
862 /// Subtracts RHS from *this and assigns the result to *this.
865 APInt &operator-=(const APInt &RHS);
866 APInt &operator-=(uint64_t RHS);
868 /// \brief Left-shift assignment function.
870 /// Shifts *this left by shiftAmt and assigns the result to *this.
872 /// \returns *this after shifting left by ShiftAmt
873 APInt &operator<<=(unsigned ShiftAmt) {
874 assert(ShiftAmt <= BitWidth && "Invalid shift amount");
875 if (isSingleWord()) {
876 if (ShiftAmt == BitWidth)
880 return clearUnusedBits();
882 shlSlowCase(ShiftAmt);
886 /// \brief Left-shift assignment function.
888 /// Shifts *this left by shiftAmt and assigns the result to *this.
890 /// \returns *this after shifting left by ShiftAmt
891 APInt &operator<<=(const APInt &ShiftAmt);
894 /// \name Binary Operators
897 /// \brief Multiplication operator.
899 /// Multiplies this APInt by RHS and returns the result.
900 APInt operator*(const APInt &RHS) const;
902 /// \brief Left logical shift operator.
904 /// Shifts this APInt left by \p Bits and returns the result.
905 APInt operator<<(unsigned Bits) const { return shl(Bits); }
907 /// \brief Left logical shift operator.
909 /// Shifts this APInt left by \p Bits and returns the result.
910 APInt operator<<(const APInt &Bits) const { return shl(Bits); }
912 /// \brief Arithmetic right-shift function.
914 /// Arithmetic right-shift this APInt by shiftAmt.
915 APInt ashr(unsigned ShiftAmt) const {
917 R.ashrInPlace(ShiftAmt);
921 /// Arithmetic right-shift this APInt by ShiftAmt in place.
922 void ashrInPlace(unsigned ShiftAmt) {
923 assert(ShiftAmt <= BitWidth && "Invalid shift amount");
924 if (isSingleWord()) {
925 int64_t SExtVAL = SignExtend64(U.VAL, BitWidth);
926 if (ShiftAmt == BitWidth)
927 U.VAL = SExtVAL >> (APINT_BITS_PER_WORD - 1); // Fill with sign bit.
929 U.VAL = SExtVAL >> ShiftAmt;
933 ashrSlowCase(ShiftAmt);
936 /// \brief Logical right-shift function.
938 /// Logical right-shift this APInt by shiftAmt.
939 APInt lshr(unsigned shiftAmt) const {
941 R.lshrInPlace(shiftAmt);
945 /// Logical right-shift this APInt by ShiftAmt in place.
946 void lshrInPlace(unsigned ShiftAmt) {
947 assert(ShiftAmt <= BitWidth && "Invalid shift amount");
948 if (isSingleWord()) {
949 if (ShiftAmt == BitWidth)
955 lshrSlowCase(ShiftAmt);
958 /// \brief Left-shift function.
960 /// Left-shift this APInt by shiftAmt.
961 APInt shl(unsigned shiftAmt) const {
967 /// \brief Rotate left by rotateAmt.
968 APInt rotl(unsigned rotateAmt) const;
970 /// \brief Rotate right by rotateAmt.
971 APInt rotr(unsigned rotateAmt) const;
973 /// \brief Arithmetic right-shift function.
975 /// Arithmetic right-shift this APInt by shiftAmt.
976 APInt ashr(const APInt &ShiftAmt) const {
978 R.ashrInPlace(ShiftAmt);
982 /// Arithmetic right-shift this APInt by shiftAmt in place.
983 void ashrInPlace(const APInt &shiftAmt);
985 /// \brief Logical right-shift function.
987 /// Logical right-shift this APInt by shiftAmt.
988 APInt lshr(const APInt &ShiftAmt) const {
990 R.lshrInPlace(ShiftAmt);
994 /// Logical right-shift this APInt by ShiftAmt in place.
995 void lshrInPlace(const APInt &ShiftAmt);
997 /// \brief Left-shift function.
999 /// Left-shift this APInt by shiftAmt.
1000 APInt shl(const APInt &ShiftAmt) const {
1006 /// \brief Rotate left by rotateAmt.
1007 APInt rotl(const APInt &rotateAmt) const;
1009 /// \brief Rotate right by rotateAmt.
1010 APInt rotr(const APInt &rotateAmt) const;
1012 /// \brief Unsigned division operation.
1014 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
1015 /// RHS are treated as unsigned quantities for purposes of this division.
1017 /// \returns a new APInt value containing the division result
1018 APInt udiv(const APInt &RHS) const;
1020 /// \brief Signed division function for APInt.
1022 /// Signed divide this APInt by APInt RHS.
1023 APInt sdiv(const APInt &RHS) const;
1025 /// \brief Unsigned remainder operation.
1027 /// Perform an unsigned remainder operation on this APInt with RHS being the
1028 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
1029 /// of this operation. Note that this is a true remainder operation and not a
1030 /// modulo operation because the sign follows the sign of the dividend which
1033 /// \returns a new APInt value containing the remainder result
1034 APInt urem(const APInt &RHS) const;
1036 /// \brief Function for signed remainder operation.
1038 /// Signed remainder operation on APInt.
1039 APInt srem(const APInt &RHS) const;
1041 /// \brief Dual division/remainder interface.
1043 /// Sometimes it is convenient to divide two APInt values and obtain both the
1044 /// quotient and remainder. This function does both operations in the same
1045 /// computation making it a little more efficient. The pair of input arguments
1046 /// may overlap with the pair of output arguments. It is safe to call
1047 /// udivrem(X, Y, X, Y), for example.
1048 static void udivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
1051 static void sdivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
1054 // Operations that return overflow indicators.
1055 APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
1056 APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
1057 APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
1058 APInt usub_ov(const APInt &RHS, bool &Overflow) const;
1059 APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
1060 APInt smul_ov(const APInt &RHS, bool &Overflow) const;
1061 APInt umul_ov(const APInt &RHS, bool &Overflow) const;
1062 APInt sshl_ov(const APInt &Amt, bool &Overflow) const;
1063 APInt ushl_ov(const APInt &Amt, bool &Overflow) const;
1065 /// \brief Array-indexing support.
1067 /// \returns the bit value at bitPosition
1068 bool operator[](unsigned bitPosition) const {
1069 assert(bitPosition < getBitWidth() && "Bit position out of bounds!");
1070 return (maskBit(bitPosition) & getWord(bitPosition)) != 0;
1074 /// \name Comparison Operators
1077 /// \brief Equality operator.
1079 /// Compares this APInt with RHS for the validity of the equality
1081 bool operator==(const APInt &RHS) const {
1082 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
1084 return U.VAL == RHS.U.VAL;
1085 return EqualSlowCase(RHS);
1088 /// \brief Equality operator.
1090 /// Compares this APInt with a uint64_t for the validity of the equality
1093 /// \returns true if *this == Val
1094 bool operator==(uint64_t Val) const {
1095 return (isSingleWord() || getActiveBits() <= 64) && getZExtValue() == Val;
1098 /// \brief Equality comparison.
1100 /// Compares this APInt with RHS for the validity of the equality
1103 /// \returns true if *this == Val
1104 bool eq(const APInt &RHS) const { return (*this) == RHS; }
1106 /// \brief Inequality operator.
1108 /// Compares this APInt with RHS for the validity of the inequality
1111 /// \returns true if *this != Val
1112 bool operator!=(const APInt &RHS) const { return !((*this) == RHS); }
1114 /// \brief Inequality operator.
1116 /// Compares this APInt with a uint64_t for the validity of the inequality
1119 /// \returns true if *this != Val
1120 bool operator!=(uint64_t Val) const { return !((*this) == Val); }
1122 /// \brief Inequality comparison
1124 /// Compares this APInt with RHS for the validity of the inequality
1127 /// \returns true if *this != Val
1128 bool ne(const APInt &RHS) const { return !((*this) == RHS); }
1130 /// \brief Unsigned less than comparison
1132 /// Regards both *this and RHS as unsigned quantities and compares them for
1133 /// the validity of the less-than relationship.
1135 /// \returns true if *this < RHS when both are considered unsigned.
1136 bool ult(const APInt &RHS) const { return compare(RHS) < 0; }
1138 /// \brief Unsigned less than comparison
1140 /// Regards both *this as an unsigned quantity and compares it with RHS for
1141 /// the validity of the less-than relationship.
1143 /// \returns true if *this < RHS when considered unsigned.
1144 bool ult(uint64_t RHS) const {
1145 // Only need to check active bits if not a single word.
1146 return (isSingleWord() || getActiveBits() <= 64) && getZExtValue() < RHS;
1149 /// \brief Signed less than comparison
1151 /// Regards both *this and RHS as signed quantities and compares them for
1152 /// validity of the less-than relationship.
1154 /// \returns true if *this < RHS when both are considered signed.
1155 bool slt(const APInt &RHS) const { return compareSigned(RHS) < 0; }
1157 /// \brief Signed less than comparison
1159 /// Regards both *this as a signed quantity and compares it with RHS for
1160 /// the validity of the less-than relationship.
1162 /// \returns true if *this < RHS when considered signed.
1163 bool slt(int64_t RHS) const {
1164 return (!isSingleWord() && getMinSignedBits() > 64) ? isNegative()
1165 : getSExtValue() < RHS;
1168 /// \brief Unsigned less or equal comparison
1170 /// Regards both *this and RHS as unsigned quantities and compares them for
1171 /// validity of the less-or-equal relationship.
1173 /// \returns true if *this <= RHS when both are considered unsigned.
1174 bool ule(const APInt &RHS) const { return compare(RHS) <= 0; }
1176 /// \brief Unsigned less or equal comparison
1178 /// Regards both *this as an unsigned quantity and compares it with RHS for
1179 /// the validity of the less-or-equal relationship.
1181 /// \returns true if *this <= RHS when considered unsigned.
1182 bool ule(uint64_t RHS) const { return !ugt(RHS); }
1184 /// \brief Signed less or equal comparison
1186 /// Regards both *this and RHS as signed quantities and compares them for
1187 /// validity of the less-or-equal relationship.
1189 /// \returns true if *this <= RHS when both are considered signed.
1190 bool sle(const APInt &RHS) const { return compareSigned(RHS) <= 0; }
1192 /// \brief Signed less or equal comparison
1194 /// Regards both *this as a signed quantity and compares it with RHS for the
1195 /// validity of the less-or-equal relationship.
1197 /// \returns true if *this <= RHS when considered signed.
1198 bool sle(uint64_t RHS) const { return !sgt(RHS); }
1200 /// \brief Unsigned greather than comparison
1202 /// Regards both *this and RHS as unsigned quantities and compares them for
1203 /// the validity of the greater-than relationship.
1205 /// \returns true if *this > RHS when both are considered unsigned.
1206 bool ugt(const APInt &RHS) const { return !ule(RHS); }
1208 /// \brief Unsigned greater than comparison
1210 /// Regards both *this as an unsigned quantity and compares it with RHS for
1211 /// the validity of the greater-than relationship.
1213 /// \returns true if *this > RHS when considered unsigned.
1214 bool ugt(uint64_t RHS) const {
1215 // Only need to check active bits if not a single word.
1216 return (!isSingleWord() && getActiveBits() > 64) || getZExtValue() > RHS;
1219 /// \brief Signed greather than comparison
1221 /// Regards both *this and RHS as signed quantities and compares them for the
1222 /// validity of the greater-than relationship.
1224 /// \returns true if *this > RHS when both are considered signed.
1225 bool sgt(const APInt &RHS) const { return !sle(RHS); }
1227 /// \brief Signed greater than comparison
1229 /// Regards both *this as a signed quantity and compares it with RHS for
1230 /// the validity of the greater-than relationship.
1232 /// \returns true if *this > RHS when considered signed.
1233 bool sgt(int64_t RHS) const {
1234 return (!isSingleWord() && getMinSignedBits() > 64) ? !isNegative()
1235 : getSExtValue() > RHS;
1238 /// \brief Unsigned greater or equal comparison
1240 /// Regards both *this and RHS as unsigned quantities and compares them for
1241 /// validity of the greater-or-equal relationship.
1243 /// \returns true if *this >= RHS when both are considered unsigned.
1244 bool uge(const APInt &RHS) const { return !ult(RHS); }
1246 /// \brief Unsigned greater or equal comparison
1248 /// Regards both *this as an unsigned quantity and compares it with RHS for
1249 /// the validity of the greater-or-equal relationship.
1251 /// \returns true if *this >= RHS when considered unsigned.
1252 bool uge(uint64_t RHS) const { return !ult(RHS); }
1254 /// \brief Signed greather or equal comparison
1256 /// Regards both *this and RHS as signed quantities and compares them for
1257 /// validity of the greater-or-equal relationship.
1259 /// \returns true if *this >= RHS when both are considered signed.
1260 bool sge(const APInt &RHS) const { return !slt(RHS); }
1262 /// \brief Signed greater or equal comparison
1264 /// Regards both *this as a signed quantity and compares it with RHS for
1265 /// the validity of the greater-or-equal relationship.
1267 /// \returns true if *this >= RHS when considered signed.
1268 bool sge(int64_t RHS) const { return !slt(RHS); }
1270 /// This operation tests if there are any pairs of corresponding bits
1271 /// between this APInt and RHS that are both set.
1272 bool intersects(const APInt &RHS) const {
1273 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1275 return (U.VAL & RHS.U.VAL) != 0;
1276 return intersectsSlowCase(RHS);
1279 /// This operation checks that all bits set in this APInt are also set in RHS.
1280 bool isSubsetOf(const APInt &RHS) const {
1281 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1283 return (U.VAL & ~RHS.U.VAL) == 0;
1284 return isSubsetOfSlowCase(RHS);
1288 /// \name Resizing Operators
1291 /// \brief Truncate to new width.
1293 /// Truncate the APInt to a specified width. It is an error to specify a width
1294 /// that is greater than or equal to the current width.
1295 APInt trunc(unsigned width) const;
1297 /// \brief Sign extend to a new width.
1299 /// This operation sign extends the APInt to a new width. If the high order
1300 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
1301 /// It is an error to specify a width that is less than or equal to the
1303 APInt sext(unsigned width) const;
1305 /// \brief Zero extend to a new width.
1307 /// This operation zero extends the APInt to a new width. The high order bits
1308 /// are filled with 0 bits. It is an error to specify a width that is less
1309 /// than or equal to the current width.
1310 APInt zext(unsigned width) const;
1312 /// \brief Sign extend or truncate to width
1314 /// Make this APInt have the bit width given by \p width. The value is sign
1315 /// extended, truncated, or left alone to make it that width.
1316 APInt sextOrTrunc(unsigned width) const;
1318 /// \brief Zero extend or truncate to width
1320 /// Make this APInt have the bit width given by \p width. The value is zero
1321 /// extended, truncated, or left alone to make it that width.
1322 APInt zextOrTrunc(unsigned width) const;
1324 /// \brief Sign extend or truncate to width
1326 /// Make this APInt have the bit width given by \p width. The value is sign
1327 /// extended, or left alone to make it that width.
1328 APInt sextOrSelf(unsigned width) const;
1330 /// \brief Zero extend or truncate to width
1332 /// Make this APInt have the bit width given by \p width. The value is zero
1333 /// extended, or left alone to make it that width.
1334 APInt zextOrSelf(unsigned width) const;
1337 /// \name Bit Manipulation Operators
1340 /// \brief Set every bit to 1.
1345 // Set all the bits in all the words.
1346 memset(U.pVal, -1, getNumWords() * APINT_WORD_SIZE);
1347 // Clear the unused ones
1351 /// \brief Set a given bit to 1.
1353 /// Set the given bit to 1 whose position is given as "bitPosition".
1354 void setBit(unsigned BitPosition) {
1355 assert(BitPosition <= BitWidth && "BitPosition out of range");
1356 WordType Mask = maskBit(BitPosition);
1360 U.pVal[whichWord(BitPosition)] |= Mask;
1363 /// Set the sign bit to 1.
1365 setBit(BitWidth - 1);
1368 /// Set the bits from loBit (inclusive) to hiBit (exclusive) to 1.
1369 void setBits(unsigned loBit, unsigned hiBit) {
1370 assert(hiBit <= BitWidth && "hiBit out of range");
1371 assert(loBit <= BitWidth && "loBit out of range");
1372 assert(loBit <= hiBit && "loBit greater than hiBit");
1375 if (loBit < APINT_BITS_PER_WORD && hiBit <= APINT_BITS_PER_WORD) {
1376 uint64_t mask = WORD_MAX >> (APINT_BITS_PER_WORD - (hiBit - loBit));
1383 setBitsSlowCase(loBit, hiBit);
1387 /// Set the top bits starting from loBit.
1388 void setBitsFrom(unsigned loBit) {
1389 return setBits(loBit, BitWidth);
1392 /// Set the bottom loBits bits.
1393 void setLowBits(unsigned loBits) {
1394 return setBits(0, loBits);
1397 /// Set the top hiBits bits.
1398 void setHighBits(unsigned hiBits) {
1399 return setBits(BitWidth - hiBits, BitWidth);
1402 /// \brief Set every bit to 0.
1403 void clearAllBits() {
1407 memset(U.pVal, 0, getNumWords() * APINT_WORD_SIZE);
1410 /// \brief Set a given bit to 0.
1412 /// Set the given bit to 0 whose position is given as "bitPosition".
1413 void clearBit(unsigned BitPosition) {
1414 assert(BitPosition <= BitWidth && "BitPosition out of range");
1415 WordType Mask = ~maskBit(BitPosition);
1419 U.pVal[whichWord(BitPosition)] &= Mask;
1422 /// Set the sign bit to 0.
1423 void clearSignBit() {
1424 clearBit(BitWidth - 1);
1427 /// \brief Toggle every bit to its opposite value.
1428 void flipAllBits() {
1429 if (isSingleWord()) {
1433 flipAllBitsSlowCase();
1437 /// \brief Toggles a given bit to its opposite value.
1439 /// Toggle a given bit to its opposite value whose position is given
1440 /// as "bitPosition".
1441 void flipBit(unsigned bitPosition);
1443 /// Negate this APInt in place.
1449 /// Insert the bits from a smaller APInt starting at bitPosition.
1450 void insertBits(const APInt &SubBits, unsigned bitPosition);
1452 /// Return an APInt with the extracted bits [bitPosition,bitPosition+numBits).
1453 APInt extractBits(unsigned numBits, unsigned bitPosition) const;
1456 /// \name Value Characterization Functions
1459 /// \brief Return the number of bits in the APInt.
1460 unsigned getBitWidth() const { return BitWidth; }
1462 /// \brief Get the number of words.
1464 /// Here one word's bitwidth equals to that of uint64_t.
1466 /// \returns the number of words to hold the integer value of this APInt.
1467 unsigned getNumWords() const { return getNumWords(BitWidth); }
1469 /// \brief Get the number of words.
1471 /// *NOTE* Here one word's bitwidth equals to that of uint64_t.
1473 /// \returns the number of words to hold the integer value with a given bit
1475 static unsigned getNumWords(unsigned BitWidth) {
1476 return ((uint64_t)BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1479 /// \brief Compute the number of active bits in the value
1481 /// This function returns the number of active bits which is defined as the
1482 /// bit width minus the number of leading zeros. This is used in several
1483 /// computations to see how "wide" the value is.
1484 unsigned getActiveBits() const { return BitWidth - countLeadingZeros(); }
1486 /// \brief Compute the number of active words in the value of this APInt.
1488 /// This is used in conjunction with getActiveData to extract the raw value of
1490 unsigned getActiveWords() const {
1491 unsigned numActiveBits = getActiveBits();
1492 return numActiveBits ? whichWord(numActiveBits - 1) + 1 : 1;
1495 /// \brief Get the minimum bit size for this signed APInt
1497 /// Computes the minimum bit width for this APInt while considering it to be a
1498 /// signed (and probably negative) value. If the value is not negative, this
1499 /// function returns the same value as getActiveBits()+1. Otherwise, it
1500 /// returns the smallest bit width that will retain the negative value. For
1501 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1502 /// for -1, this function will always return 1.
1503 unsigned getMinSignedBits() const {
1505 return BitWidth - countLeadingOnes() + 1;
1506 return getActiveBits() + 1;
1509 /// \brief Get zero extended value
1511 /// This method attempts to return the value of this APInt as a zero extended
1512 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1513 /// uint64_t. Otherwise an assertion will result.
1514 uint64_t getZExtValue() const {
1517 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1521 /// \brief Get sign extended value
1523 /// This method attempts to return the value of this APInt as a sign extended
1524 /// int64_t. The bit width must be <= 64 or the value must fit within an
1525 /// int64_t. Otherwise an assertion will result.
1526 int64_t getSExtValue() const {
1528 return SignExtend64(U.VAL, BitWidth);
1529 assert(getMinSignedBits() <= 64 && "Too many bits for int64_t");
1530 return int64_t(U.pVal[0]);
1533 /// \brief Get bits required for string value.
1535 /// This method determines how many bits are required to hold the APInt
1536 /// equivalent of the string given by \p str.
1537 static unsigned getBitsNeeded(StringRef str, uint8_t radix);
1539 /// \brief The APInt version of the countLeadingZeros functions in
1542 /// It counts the number of zeros from the most significant bit to the first
1545 /// \returns BitWidth if the value is zero, otherwise returns the number of
1546 /// zeros from the most significant bit to the first one bits.
1547 unsigned countLeadingZeros() const {
1548 if (isSingleWord()) {
1549 unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
1550 return llvm::countLeadingZeros(U.VAL) - unusedBits;
1552 return countLeadingZerosSlowCase();
1555 /// \brief Count the number of leading one bits.
1557 /// This function is an APInt version of the countLeadingOnes
1558 /// functions in MathExtras.h. It counts the number of ones from the most
1559 /// significant bit to the first zero bit.
1561 /// \returns 0 if the high order bit is not set, otherwise returns the number
1562 /// of 1 bits from the most significant to the least
1563 unsigned countLeadingOnes() const LLVM_READONLY;
1565 /// Computes the number of leading bits of this APInt that are equal to its
1567 unsigned getNumSignBits() const {
1568 return isNegative() ? countLeadingOnes() : countLeadingZeros();
1571 /// \brief Count the number of trailing zero bits.
1573 /// This function is an APInt version of the countTrailingZeros
1574 /// functions in MathExtras.h. It counts the number of zeros from the least
1575 /// significant bit to the first set bit.
1577 /// \returns BitWidth if the value is zero, otherwise returns the number of
1578 /// zeros from the least significant bit to the first one bit.
1579 unsigned countTrailingZeros() const LLVM_READONLY;
1581 /// \brief Count the number of trailing one bits.
1583 /// This function is an APInt version of the countTrailingOnes
1584 /// functions in MathExtras.h. It counts the number of ones from the least
1585 /// significant bit to the first zero bit.
1587 /// \returns BitWidth if the value is all ones, otherwise returns the number
1588 /// of ones from the least significant bit to the first zero bit.
1589 unsigned countTrailingOnes() const {
1591 return llvm::countTrailingOnes(U.VAL);
1592 return countTrailingOnesSlowCase();
1595 /// \brief Count the number of bits set.
1597 /// This function is an APInt version of the countPopulation functions
1598 /// in MathExtras.h. It counts the number of 1 bits in the APInt value.
1600 /// \returns 0 if the value is zero, otherwise returns the number of set bits.
1601 unsigned countPopulation() const {
1603 return llvm::countPopulation(U.VAL);
1604 return countPopulationSlowCase();
1608 /// \name Conversion Functions
1610 void print(raw_ostream &OS, bool isSigned) const;
1612 /// Converts an APInt to a string and append it to Str. Str is commonly a
1614 void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
1615 bool formatAsCLiteral = false) const;
1617 /// Considers the APInt to be unsigned and converts it into a string in the
1618 /// radix given. The radix can be 2, 8, 10 16, or 36.
1619 void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1620 toString(Str, Radix, false, false);
1623 /// Considers the APInt to be signed and converts it into a string in the
1624 /// radix given. The radix can be 2, 8, 10, 16, or 36.
1625 void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1626 toString(Str, Radix, true, false);
1629 /// \brief Return the APInt as a std::string.
1631 /// Note that this is an inefficient method. It is better to pass in a
1632 /// SmallVector/SmallString to the methods above to avoid thrashing the heap
1634 std::string toString(unsigned Radix, bool Signed) const;
1636 /// \returns a byte-swapped representation of this APInt Value.
1637 APInt byteSwap() const;
1639 /// \returns the value with the bit representation reversed of this APInt
1641 APInt reverseBits() const;
1643 /// \brief Converts this APInt to a double value.
1644 double roundToDouble(bool isSigned) const;
1646 /// \brief Converts this unsigned APInt to a double value.
1647 double roundToDouble() const { return roundToDouble(false); }
1649 /// \brief Converts this signed APInt to a double value.
1650 double signedRoundToDouble() const { return roundToDouble(true); }
1652 /// \brief Converts APInt bits to a double
1654 /// The conversion does not do a translation from integer to double, it just
1655 /// re-interprets the bits as a double. Note that it is valid to do this on
1656 /// any bit width. Exactly 64 bits will be translated.
1657 double bitsToDouble() const {
1658 return BitsToDouble(getWord(0));
1661 /// \brief Converts APInt bits to a double
1663 /// The conversion does not do a translation from integer to float, it just
1664 /// re-interprets the bits as a float. Note that it is valid to do this on
1665 /// any bit width. Exactly 32 bits will be translated.
1666 float bitsToFloat() const {
1667 return BitsToFloat(getWord(0));
1670 /// \brief Converts a double to APInt bits.
1672 /// The conversion does not do a translation from double to integer, it just
1673 /// re-interprets the bits of the double.
1674 static APInt doubleToBits(double V) {
1675 return APInt(sizeof(double) * CHAR_BIT, DoubleToBits(V));
1678 /// \brief Converts a float to APInt bits.
1680 /// The conversion does not do a translation from float to integer, it just
1681 /// re-interprets the bits of the float.
1682 static APInt floatToBits(float V) {
1683 return APInt(sizeof(float) * CHAR_BIT, FloatToBits(V));
1687 /// \name Mathematics Operations
1690 /// \returns the floor log base 2 of this APInt.
1691 unsigned logBase2() const { return BitWidth - 1 - countLeadingZeros(); }
1693 /// \returns the ceil log base 2 of this APInt.
1694 unsigned ceilLogBase2() const {
1697 return BitWidth - temp.countLeadingZeros();
1700 /// \returns the nearest log base 2 of this APInt. Ties round up.
1702 /// NOTE: When we have a BitWidth of 1, we define:
1704 /// log2(0) = UINT32_MAX
1707 /// to get around any mathematical concerns resulting from
1708 /// referencing 2 in a space where 2 does no exist.
1709 unsigned nearestLogBase2() const {
1710 // Special case when we have a bitwidth of 1. If VAL is 1, then we
1711 // get 0. If VAL is 0, we get WORD_MAX which gets truncated to
1716 // Handle the zero case.
1720 // The non-zero case is handled by computing:
1722 // nearestLogBase2(x) = logBase2(x) + x[logBase2(x)-1].
1724 // where x[i] is referring to the value of the ith bit of x.
1725 unsigned lg = logBase2();
1726 return lg + unsigned((*this)[lg - 1]);
1729 /// \returns the log base 2 of this APInt if its an exact power of two, -1
1731 int32_t exactLogBase2() const {
1737 /// \brief Compute the square root
1740 /// \brief Get the absolute value;
1742 /// If *this is < 0 then return -(*this), otherwise *this;
1749 /// \returns the multiplicative inverse for a given modulo.
1750 APInt multiplicativeInverse(const APInt &modulo) const;
1753 /// \name Support for division by constant
1756 /// Calculate the magic number for signed division by a constant.
1760 /// Calculate the magic number for unsigned division by a constant.
1762 mu magicu(unsigned LeadingZeros = 0) const;
1765 /// \name Building-block Operations for APInt and APFloat
1768 // These building block operations operate on a representation of arbitrary
1769 // precision, two's-complement, bignum integer values. They should be
1770 // sufficient to implement APInt and APFloat bignum requirements. Inputs are
1771 // generally a pointer to the base of an array of integer parts, representing
1772 // an unsigned bignum, and a count of how many parts there are.
1774 /// Sets the least significant part of a bignum to the input value, and zeroes
1775 /// out higher parts.
1776 static void tcSet(WordType *, WordType, unsigned);
1778 /// Assign one bignum to another.
1779 static void tcAssign(WordType *, const WordType *, unsigned);
1781 /// Returns true if a bignum is zero, false otherwise.
1782 static bool tcIsZero(const WordType *, unsigned);
1784 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1785 static int tcExtractBit(const WordType *, unsigned bit);
1787 /// Copy the bit vector of width srcBITS from SRC, starting at bit srcLSB, to
1788 /// DST, of dstCOUNT parts, such that the bit srcLSB becomes the least
1789 /// significant bit of DST. All high bits above srcBITS in DST are
1791 static void tcExtract(WordType *, unsigned dstCount,
1792 const WordType *, unsigned srcBits,
1795 /// Set the given bit of a bignum. Zero-based.
1796 static void tcSetBit(WordType *, unsigned bit);
1798 /// Clear the given bit of a bignum. Zero-based.
1799 static void tcClearBit(WordType *, unsigned bit);
1801 /// Returns the bit number of the least or most significant set bit of a
1802 /// number. If the input number has no bits set -1U is returned.
1803 static unsigned tcLSB(const WordType *, unsigned n);
1804 static unsigned tcMSB(const WordType *parts, unsigned n);
1806 /// Negate a bignum in-place.
1807 static void tcNegate(WordType *, unsigned);
1809 /// DST += RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1810 static WordType tcAdd(WordType *, const WordType *,
1811 WordType carry, unsigned);
1812 /// DST += RHS. Returns the carry flag.
1813 static WordType tcAddPart(WordType *, WordType, unsigned);
1815 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the carry flag.
1816 static WordType tcSubtract(WordType *, const WordType *,
1817 WordType carry, unsigned);
1818 /// DST -= RHS. Returns the carry flag.
1819 static WordType tcSubtractPart(WordType *, WordType, unsigned);
1821 /// DST += SRC * MULTIPLIER + PART if add is true
1822 /// DST = SRC * MULTIPLIER + PART if add is false
1824 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC they must
1825 /// start at the same point, i.e. DST == SRC.
1827 /// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is returned.
1828 /// Otherwise DST is filled with the least significant DSTPARTS parts of the
1829 /// result, and if all of the omitted higher parts were zero return zero,
1830 /// otherwise overflow occurred and return one.
1831 static int tcMultiplyPart(WordType *dst, const WordType *src,
1832 WordType multiplier, WordType carry,
1833 unsigned srcParts, unsigned dstParts,
1836 /// DST = LHS * RHS, where DST has the same width as the operands and is
1837 /// filled with the least significant parts of the result. Returns one if
1838 /// overflow occurred, otherwise zero. DST must be disjoint from both
1840 static int tcMultiply(WordType *, const WordType *, const WordType *,
1843 /// DST = LHS * RHS, where DST has width the sum of the widths of the
1844 /// operands. No overflow occurs. DST must be disjoint from both operands.
1845 static void tcFullMultiply(WordType *, const WordType *,
1846 const WordType *, unsigned, unsigned);
1848 /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1849 /// Otherwise set LHS to LHS / RHS with the fractional part discarded, set
1850 /// REMAINDER to the remainder, return zero. i.e.
1852 /// OLD_LHS = RHS * LHS + REMAINDER
1854 /// SCRATCH is a bignum of the same size as the operands and result for use by
1855 /// the routine; its contents need not be initialized and are destroyed. LHS,
1856 /// REMAINDER and SCRATCH must be distinct.
1857 static int tcDivide(WordType *lhs, const WordType *rhs,
1858 WordType *remainder, WordType *scratch,
1861 /// Shift a bignum left Count bits. Shifted in bits are zero. There are no
1862 /// restrictions on Count.
1863 static void tcShiftLeft(WordType *, unsigned Words, unsigned Count);
1865 /// Shift a bignum right Count bits. Shifted in bits are zero. There are no
1866 /// restrictions on Count.
1867 static void tcShiftRight(WordType *, unsigned Words, unsigned Count);
1869 /// The obvious AND, OR and XOR and complement operations.
1870 static void tcAnd(WordType *, const WordType *, unsigned);
1871 static void tcOr(WordType *, const WordType *, unsigned);
1872 static void tcXor(WordType *, const WordType *, unsigned);
1873 static void tcComplement(WordType *, unsigned);
1875 /// Comparison (unsigned) of two bignums.
1876 static int tcCompare(const WordType *, const WordType *, unsigned);
1878 /// Increment a bignum in-place. Return the carry flag.
1879 static WordType tcIncrement(WordType *dst, unsigned parts) {
1880 return tcAddPart(dst, 1, parts);
1883 /// Decrement a bignum in-place. Return the borrow flag.
1884 static WordType tcDecrement(WordType *dst, unsigned parts) {
1885 return tcSubtractPart(dst, 1, parts);
1888 /// Set the least significant BITS and clear the rest.
1889 static void tcSetLeastSignificantBits(WordType *, unsigned, unsigned bits);
1891 /// \brief debug method
1897 /// Magic data for optimising signed division by a constant.
1899 APInt m; ///< magic number
1900 unsigned s; ///< shift amount
1903 /// Magic data for optimising unsigned division by a constant.
1905 APInt m; ///< magic number
1906 bool a; ///< add indicator
1907 unsigned s; ///< shift amount
1910 inline bool operator==(uint64_t V1, const APInt &V2) { return V2 == V1; }
1912 inline bool operator!=(uint64_t V1, const APInt &V2) { return V2 != V1; }
1914 /// \brief Unary bitwise complement operator.
1916 /// \returns an APInt that is the bitwise complement of \p v.
1917 inline APInt operator~(APInt v) {
1922 inline APInt operator&(APInt a, const APInt &b) {
1927 inline APInt operator&(const APInt &a, APInt &&b) {
1929 return std::move(b);
1932 inline APInt operator&(APInt a, uint64_t RHS) {
1937 inline APInt operator&(uint64_t LHS, APInt b) {
1942 inline APInt operator|(APInt a, const APInt &b) {
1947 inline APInt operator|(const APInt &a, APInt &&b) {
1949 return std::move(b);
1952 inline APInt operator|(APInt a, uint64_t RHS) {
1957 inline APInt operator|(uint64_t LHS, APInt b) {
1962 inline APInt operator^(APInt a, const APInt &b) {
1967 inline APInt operator^(const APInt &a, APInt &&b) {
1969 return std::move(b);
1972 inline APInt operator^(APInt a, uint64_t RHS) {
1977 inline APInt operator^(uint64_t LHS, APInt b) {
1982 inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
1987 inline APInt operator-(APInt v) {
1992 inline APInt operator+(APInt a, const APInt &b) {
1997 inline APInt operator+(const APInt &a, APInt &&b) {
1999 return std::move(b);
2002 inline APInt operator+(APInt a, uint64_t RHS) {
2007 inline APInt operator+(uint64_t LHS, APInt b) {
2012 inline APInt operator-(APInt a, const APInt &b) {
2017 inline APInt operator-(const APInt &a, APInt &&b) {
2020 return std::move(b);
2023 inline APInt operator-(APInt a, uint64_t RHS) {
2028 inline APInt operator-(uint64_t LHS, APInt b) {
2034 inline APInt operator*(APInt a, uint64_t RHS) {
2039 inline APInt operator*(uint64_t LHS, APInt b) {
2045 namespace APIntOps {
2047 /// \brief Determine the smaller of two APInts considered to be signed.
2048 inline const APInt &smin(const APInt &A, const APInt &B) {
2049 return A.slt(B) ? A : B;
2052 /// \brief Determine the larger of two APInts considered to be signed.
2053 inline const APInt &smax(const APInt &A, const APInt &B) {
2054 return A.sgt(B) ? A : B;
2057 /// \brief Determine the smaller of two APInts considered to be signed.
2058 inline const APInt &umin(const APInt &A, const APInt &B) {
2059 return A.ult(B) ? A : B;
2062 /// \brief Determine the larger of two APInts considered to be unsigned.
2063 inline const APInt &umax(const APInt &A, const APInt &B) {
2064 return A.ugt(B) ? A : B;
2067 /// \brief Compute GCD of two unsigned APInt values.
2069 /// This function returns the greatest common divisor of the two APInt values
2070 /// using Stein's algorithm.
2072 /// \returns the greatest common divisor of A and B.
2073 APInt GreatestCommonDivisor(APInt A, APInt B);
2075 /// \brief Converts the given APInt to a double value.
2077 /// Treats the APInt as an unsigned value for conversion purposes.
2078 inline double RoundAPIntToDouble(const APInt &APIVal) {
2079 return APIVal.roundToDouble();
2082 /// \brief Converts the given APInt to a double value.
2084 /// Treats the APInt as a signed value for conversion purposes.
2085 inline double RoundSignedAPIntToDouble(const APInt &APIVal) {
2086 return APIVal.signedRoundToDouble();
2089 /// \brief Converts the given APInt to a float vlalue.
2090 inline float RoundAPIntToFloat(const APInt &APIVal) {
2091 return float(RoundAPIntToDouble(APIVal));
2094 /// \brief Converts the given APInt to a float value.
2096 /// Treast the APInt as a signed value for conversion purposes.
2097 inline float RoundSignedAPIntToFloat(const APInt &APIVal) {
2098 return float(APIVal.signedRoundToDouble());
2101 /// \brief Converts the given double value into a APInt.
2103 /// This function convert a double value to an APInt value.
2104 APInt RoundDoubleToAPInt(double Double, unsigned width);
2106 /// \brief Converts a float value into a APInt.
2108 /// Converts a float value into an APInt value.
2109 inline APInt RoundFloatToAPInt(float Float, unsigned width) {
2110 return RoundDoubleToAPInt(double(Float), width);
2113 } // End of APIntOps namespace
2115 // See friend declaration above. This additional declaration is required in
2116 // order to compile LLVM with IBM xlC compiler.
2117 hash_code hash_value(const APInt &Arg);
2118 } // End of llvm namespace