1 //===-- llvm/ADT/APInt.h - For Arbitrary Precision Integer -----*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a class to represent arbitrary precision integral
11 // constant values and operations on them.
13 //===----------------------------------------------------------------------===//
18 #include "llvm/Support/DataTypes.h"
19 #include "llvm/Support/MathExtras.h"
29 class FoldingSetNodeID;
32 class SmallVectorImpl;
34 /* An unsigned host type used as a single part of a multi-part
36 typedef uint64_t integerPart;
38 const unsigned int host_char_bit = 8;
39 const unsigned int integerPartWidth = host_char_bit *
40 static_cast<unsigned int>(sizeof(integerPart));
42 //===----------------------------------------------------------------------===//
44 //===----------------------------------------------------------------------===//
46 /// APInt - This class represents arbitrary precision constant integral values.
47 /// It is a functional replacement for common case unsigned integer type like
48 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
49 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
50 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
51 /// and methods to manipulate integer values of any bit-width. It supports both
52 /// the typical integer arithmetic and comparison operations as well as bitwise
55 /// The class has several invariants worth noting:
56 /// * All bit, byte, and word positions are zero-based.
57 /// * Once the bit width is set, it doesn't change except by the Truncate,
58 /// SignExtend, or ZeroExtend operations.
59 /// * All binary operators must be on APInt instances of the same bit width.
60 /// Attempting to use these operators on instances with different bit
61 /// widths will yield an assertion.
62 /// * The value is stored canonically as an unsigned value. For operations
63 /// where it makes a difference, there are both signed and unsigned variants
64 /// of the operation. For example, sdiv and udiv. However, because the bit
65 /// widths must be the same, operations such as Mul and Add produce the same
66 /// results regardless of whether the values are interpreted as signed or
68 /// * In general, the class tries to follow the style of computation that LLVM
69 /// uses in its IR. This simplifies its use for LLVM.
71 /// @brief Class for arbitrary precision integers.
73 uint32_t BitWidth; ///< The number of bits in this APInt.
75 /// This union is used to store the integer value. When the
76 /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
78 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
79 uint64_t *pVal; ///< Used to store the >64 bits integer value.
82 /// This enum is used to hold the constants we needed for APInt.
85 APINT_BITS_PER_WORD = static_cast<unsigned int>(sizeof(uint64_t)) * 8,
86 /// Byte size of a word
87 APINT_WORD_SIZE = static_cast<unsigned int>(sizeof(uint64_t))
90 /// This constructor is used only internally for speed of construction of
91 /// temporaries. It is unsafe for general use so it is not public.
92 /// @brief Fast internal constructor
93 APInt(uint64_t* val, uint32_t bits) : BitWidth(bits), pVal(val) { }
95 /// @returns true if the number of bits <= 64, false otherwise.
96 /// @brief Determine if this APInt just has one word to store value.
97 bool isSingleWord() const {
98 return BitWidth <= APINT_BITS_PER_WORD;
101 /// @returns the word position for the specified bit position.
102 /// @brief Determine which word a bit is in.
103 static uint32_t whichWord(uint32_t bitPosition) {
104 return bitPosition / APINT_BITS_PER_WORD;
107 /// @returns the bit position in a word for the specified bit position
109 /// @brief Determine which bit in a word a bit is in.
110 static uint32_t whichBit(uint32_t bitPosition) {
111 return bitPosition % APINT_BITS_PER_WORD;
114 /// This method generates and returns a uint64_t (word) mask for a single
115 /// bit at a specific bit position. This is used to mask the bit in the
116 /// corresponding word.
117 /// @returns a uint64_t with only bit at "whichBit(bitPosition)" set
118 /// @brief Get a single bit mask.
119 static uint64_t maskBit(uint32_t bitPosition) {
120 return 1ULL << whichBit(bitPosition);
123 /// This method is used internally to clear the to "N" bits in the high order
124 /// word that are not used by the APInt. This is needed after the most
125 /// significant word is assigned a value to ensure that those bits are
127 /// @brief Clear unused high order bits
128 APInt& clearUnusedBits() {
129 // Compute how many bits are used in the final word
130 uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
132 // If all bits are used, we want to leave the value alone. This also
133 // avoids the undefined behavior of >> when the shift is the same size as
134 // the word size (64).
137 // Mask out the high bits.
138 uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
142 pVal[getNumWords() - 1] &= mask;
146 /// @returns the corresponding word for the specified bit position.
147 /// @brief Get the word corresponding to a bit position
148 uint64_t getWord(uint32_t bitPosition) const {
149 return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
152 /// This is used by the constructors that take string arguments.
153 /// @brief Convert a char array into an APInt
154 void fromString(uint32_t numBits, const char *strStart, uint32_t slen,
157 /// This is used by the toString method to divide by the radix. It simply
158 /// provides a more convenient form of divide for internal use since KnuthDiv
159 /// has specific constraints on its inputs. If those constraints are not met
160 /// then it provides a simpler form of divide.
161 /// @brief An internal division function for dividing APInts.
162 static void divide(const APInt LHS, uint32_t lhsWords,
163 const APInt &RHS, uint32_t rhsWords,
164 APInt *Quotient, APInt *Remainder);
166 /// out-of-line slow case for inline constructor
167 void initSlowCase(uint32_t numBits, uint64_t val, bool isSigned);
169 /// out-of-line slow case for inline copy constructor
170 void initSlowCase(const APInt& that);
172 /// out-of-line slow case for shl
173 APInt shlSlowCase(uint32_t shiftAmt) const;
175 /// out-of-line slow case for operator&
176 APInt AndSlowCase(const APInt& RHS) const;
178 /// out-of-line slow case for operator|
179 APInt OrSlowCase(const APInt& RHS) const;
181 /// out-of-line slow case for operator^
182 APInt XorSlowCase(const APInt& RHS) const;
184 /// out-of-line slow case for operator=
185 APInt& AssignSlowCase(const APInt& RHS);
187 /// out-of-line slow case for operator==
188 bool EqualSlowCase(const APInt& RHS) const;
190 /// out-of-line slow case for operator==
191 bool EqualSlowCase(uint64_t Val) const;
193 /// out-of-line slow case for countLeadingZeros
194 uint32_t countLeadingZerosSlowCase() const;
196 /// out-of-line slow case for countTrailingOnes
197 uint32_t countTrailingOnesSlowCase() const;
199 /// out-of-line slow case for countPopulation
200 uint32_t countPopulationSlowCase() const;
203 /// @name Constructors
205 /// If isSigned is true then val is treated as if it were a signed value
206 /// (i.e. as an int64_t) and the appropriate sign extension to the bit width
207 /// will be done. Otherwise, no sign extension occurs (high order bits beyond
208 /// the range of val are zero filled).
209 /// @param numBits the bit width of the constructed APInt
210 /// @param val the initial value of the APInt
211 /// @param isSigned how to treat signedness of val
212 /// @brief Create a new APInt of numBits width, initialized as val.
213 APInt(uint32_t numBits, uint64_t val, bool isSigned = false)
214 : BitWidth(numBits), VAL(0) {
215 assert(BitWidth && "bitwidth too small");
219 initSlowCase(numBits, val, isSigned);
223 /// Note that numWords can be smaller or larger than the corresponding bit
224 /// width but any extraneous bits will be dropped.
225 /// @param numBits the bit width of the constructed APInt
226 /// @param numWords the number of words in bigVal
227 /// @param bigVal a sequence of words to form the initial value of the APInt
228 /// @brief Construct an APInt of numBits width, initialized as bigVal[].
229 APInt(uint32_t numBits, uint32_t numWords, const uint64_t bigVal[]);
231 /// This constructor interprets the slen characters starting at StrStart as
232 /// a string in the given radix. The interpretation stops when the first
233 /// character that is not suitable for the radix is encountered. Acceptable
234 /// radix values are 2, 8, 10 and 16. It is an error for the value implied by
235 /// the string to require more bits than numBits.
236 /// @param numBits the bit width of the constructed APInt
237 /// @param strStart the start of the string to be interpreted
238 /// @param slen the maximum number of characters to interpret
239 /// @param radix the radix to use for the conversion
240 /// @brief Construct an APInt from a string representation.
241 APInt(uint32_t numBits, const char strStart[], uint32_t slen, uint8_t radix);
243 /// Simply makes *this a copy of that.
244 /// @brief Copy Constructor.
245 APInt(const APInt& that)
246 : BitWidth(that.BitWidth), VAL(0) {
247 assert(BitWidth && "bitwidth too small");
254 /// @brief Destructor.
260 /// Default constructor that creates an uninitialized APInt. This is useful
261 /// for object deserialization (pair this with the static method Read).
262 explicit APInt() : BitWidth(1) {}
264 /// Profile - Used to insert APInt objects, or objects that contain APInt
265 /// objects, into FoldingSets.
266 void Profile(FoldingSetNodeID& id) const;
268 /// @brief Used by the Bitcode serializer to emit APInts to Bitcode.
269 void Emit(Serializer& S) const;
271 /// @brief Used by the Bitcode deserializer to deserialize APInts.
272 void Read(Deserializer& D);
275 /// @name Value Tests
277 /// This tests the high bit of this APInt to determine if it is set.
278 /// @returns true if this APInt is negative, false otherwise
279 /// @brief Determine sign of this APInt.
280 bool isNegative() const {
281 return (*this)[BitWidth - 1];
284 /// This tests the high bit of the APInt to determine if it is unset.
285 /// @brief Determine if this APInt Value is non-negative (>= 0)
286 bool isNonNegative() const {
287 return !isNegative();
290 /// This tests if the value of this APInt is positive (> 0). Note
291 /// that 0 is not a positive value.
292 /// @returns true if this APInt is positive.
293 /// @brief Determine if this APInt Value is positive.
294 bool isStrictlyPositive() const {
295 return isNonNegative() && (*this) != 0;
298 /// This checks to see if the value has all bits of the APInt are set or not.
299 /// @brief Determine if all bits are set
300 bool isAllOnesValue() const {
301 return countPopulation() == BitWidth;
304 /// This checks to see if the value of this APInt is the maximum unsigned
305 /// value for the APInt's bit width.
306 /// @brief Determine if this is the largest unsigned value.
307 bool isMaxValue() const {
308 return countPopulation() == BitWidth;
311 /// This checks to see if the value of this APInt is the maximum signed
312 /// value for the APInt's bit width.
313 /// @brief Determine if this is the largest signed value.
314 bool isMaxSignedValue() const {
315 return BitWidth == 1 ? VAL == 0 :
316 !isNegative() && countPopulation() == BitWidth - 1;
319 /// This checks to see if the value of this APInt is the minimum unsigned
320 /// value for the APInt's bit width.
321 /// @brief Determine if this is the smallest unsigned value.
322 bool isMinValue() const {
323 return countPopulation() == 0;
326 /// This checks to see if the value of this APInt is the minimum signed
327 /// value for the APInt's bit width.
328 /// @brief Determine if this is the smallest signed value.
329 bool isMinSignedValue() const {
330 return BitWidth == 1 ? VAL == 1 :
331 isNegative() && countPopulation() == 1;
334 /// @brief Check if this APInt has an N-bits unsigned integer value.
335 bool isIntN(uint32_t N) const {
336 assert(N && "N == 0 ???");
337 if (isSingleWord()) {
338 return VAL == (VAL & (~0ULL >> (64 - N)));
340 APInt Tmp(N, getNumWords(), pVal);
341 return Tmp == (*this);
345 /// @brief Check if this APInt has an N-bits signed integer value.
346 bool isSignedIntN(uint32_t N) const {
347 assert(N && "N == 0 ???");
348 return getMinSignedBits() <= N;
351 /// @returns true if the argument APInt value is a power of two > 0.
352 bool isPowerOf2() const;
354 /// isSignBit - Return true if this is the value returned by getSignBit.
355 bool isSignBit() const { return isMinSignedValue(); }
357 /// This converts the APInt to a boolean value as a test against zero.
358 /// @brief Boolean conversion function.
359 bool getBoolValue() const {
363 /// getLimitedValue - If this value is smaller than the specified limit,
364 /// return it, otherwise return the limit value. This causes the value
365 /// to saturate to the limit.
366 uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
367 return (getActiveBits() > 64 || getZExtValue() > Limit) ?
368 Limit : getZExtValue();
372 /// @name Value Generators
374 /// @brief Gets maximum unsigned value of APInt for specific bit width.
375 static APInt getMaxValue(uint32_t numBits) {
376 return APInt(numBits, 0).set();
379 /// @brief Gets maximum signed value of APInt for a specific bit width.
380 static APInt getSignedMaxValue(uint32_t numBits) {
381 return APInt(numBits, 0).set().clear(numBits - 1);
384 /// @brief Gets minimum unsigned value of APInt for a specific bit width.
385 static APInt getMinValue(uint32_t numBits) {
386 return APInt(numBits, 0);
389 /// @brief Gets minimum signed value of APInt for a specific bit width.
390 static APInt getSignedMinValue(uint32_t numBits) {
391 return APInt(numBits, 0).set(numBits - 1);
394 /// getSignBit - This is just a wrapper function of getSignedMinValue(), and
395 /// it helps code readability when we want to get a SignBit.
396 /// @brief Get the SignBit for a specific bit width.
397 static APInt getSignBit(uint32_t BitWidth) {
398 return getSignedMinValue(BitWidth);
401 /// @returns the all-ones value for an APInt of the specified bit-width.
402 /// @brief Get the all-ones value.
403 static APInt getAllOnesValue(uint32_t numBits) {
404 return APInt(numBits, 0).set();
407 /// @returns the '0' value for an APInt of the specified bit-width.
408 /// @brief Get the '0' value.
409 static APInt getNullValue(uint32_t numBits) {
410 return APInt(numBits, 0);
413 /// Get an APInt with the same BitWidth as this APInt, just zero mask
414 /// the low bits and right shift to the least significant bit.
415 /// @returns the high "numBits" bits of this APInt.
416 APInt getHiBits(uint32_t numBits) const;
418 /// Get an APInt with the same BitWidth as this APInt, just zero mask
420 /// @returns the low "numBits" bits of this APInt.
421 APInt getLoBits(uint32_t numBits) const;
423 /// Constructs an APInt value that has a contiguous range of bits set. The
424 /// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
425 /// bits will be zero. For example, with parameters(32, 0, 16) you would get
426 /// 0x0000FFFF. If hiBit is less than loBit then the set bits "wrap". For
427 /// example, with parameters (32, 28, 4), you would get 0xF000000F.
428 /// @param numBits the intended bit width of the result
429 /// @param loBit the index of the lowest bit set.
430 /// @param hiBit the index of the highest bit set.
431 /// @returns An APInt value with the requested bits set.
432 /// @brief Get a value with a block of bits set.
433 static APInt getBitsSet(uint32_t numBits, uint32_t loBit, uint32_t hiBit) {
434 assert(hiBit <= numBits && "hiBit out of range");
435 assert(loBit < numBits && "loBit out of range");
437 return getLowBitsSet(numBits, hiBit) |
438 getHighBitsSet(numBits, numBits-loBit);
439 return getLowBitsSet(numBits, hiBit-loBit).shl(loBit);
442 /// Constructs an APInt value that has the top hiBitsSet bits set.
443 /// @param numBits the bitwidth of the result
444 /// @param hiBitsSet the number of high-order bits set in the result.
445 /// @brief Get a value with high bits set
446 static APInt getHighBitsSet(uint32_t numBits, uint32_t hiBitsSet) {
447 assert(hiBitsSet <= numBits && "Too many bits to set!");
448 // Handle a degenerate case, to avoid shifting by word size
450 return APInt(numBits, 0);
451 uint32_t shiftAmt = numBits - hiBitsSet;
452 // For small values, return quickly
453 if (numBits <= APINT_BITS_PER_WORD)
454 return APInt(numBits, ~0ULL << shiftAmt);
455 return (~APInt(numBits, 0)).shl(shiftAmt);
458 /// Constructs an APInt value that has the bottom loBitsSet bits set.
459 /// @param numBits the bitwidth of the result
460 /// @param loBitsSet the number of low-order bits set in the result.
461 /// @brief Get a value with low bits set
462 // XXX why isn't this inlining?
463 static APInt getLowBitsSet(uint32_t numBits, uint32_t loBitsSet) {
464 assert(loBitsSet <= numBits && "Too many bits to set!");
465 // Handle a degenerate case, to avoid shifting by word size
467 return APInt(numBits, 0);
468 if (loBitsSet == APINT_BITS_PER_WORD)
469 return APInt(numBits, -1ULL);
470 // For small values, return quickly
471 if (numBits < APINT_BITS_PER_WORD)
472 return APInt(numBits, (1ULL << loBitsSet) - 1);
473 return (~APInt(numBits, 0)).lshr(numBits - loBitsSet);
476 /// The hash value is computed as the sum of the words and the bit width.
477 /// @returns A hash value computed from the sum of the APInt words.
478 /// @brief Get a hash value based on this APInt
479 uint64_t getHashValue() const;
481 /// This function returns a pointer to the internal storage of the APInt.
482 /// This is useful for writing out the APInt in binary form without any
484 const uint64_t* getRawData() const {
491 /// @name Unary Operators
493 /// @returns a new APInt value representing *this incremented by one
494 /// @brief Postfix increment operator.
495 const APInt operator++(int) {
501 /// @returns *this incremented by one
502 /// @brief Prefix increment operator.
505 /// @returns a new APInt representing *this decremented by one.
506 /// @brief Postfix decrement operator.
507 const APInt operator--(int) {
513 /// @returns *this decremented by one.
514 /// @brief Prefix decrement operator.
517 /// Performs a bitwise complement operation on this APInt.
518 /// @returns an APInt that is the bitwise complement of *this
519 /// @brief Unary bitwise complement operator.
520 APInt operator~() const {
526 /// Negates *this using two's complement logic.
527 /// @returns An APInt value representing the negation of *this.
528 /// @brief Unary negation operator
529 APInt operator-() const {
530 return APInt(BitWidth, 0) - (*this);
533 /// Performs logical negation operation on this APInt.
534 /// @returns true if *this is zero, false otherwise.
535 /// @brief Logical negation operator.
536 bool operator!() const;
539 /// @name Assignment Operators
541 /// @returns *this after assignment of RHS.
542 /// @brief Copy assignment operator.
543 APInt& operator=(const APInt& RHS) {
544 // If the bitwidths are the same, we can avoid mucking with memory
545 if (isSingleWord() && RHS.isSingleWord()) {
547 BitWidth = RHS.BitWidth;
548 return clearUnusedBits();
551 return AssignSlowCase(RHS);
554 /// The RHS value is assigned to *this. If the significant bits in RHS exceed
555 /// the bit width, the excess bits are truncated. If the bit width is larger
556 /// than 64, the value is zero filled in the unspecified high order bits.
557 /// @returns *this after assignment of RHS value.
558 /// @brief Assignment operator.
559 APInt& operator=(uint64_t RHS);
561 /// Performs a bitwise AND operation on this APInt and RHS. The result is
562 /// assigned to *this.
563 /// @returns *this after ANDing with RHS.
564 /// @brief Bitwise AND assignment operator.
565 APInt& operator&=(const APInt& RHS);
567 /// Performs a bitwise OR operation on this APInt and RHS. The result is
569 /// @returns *this after ORing with RHS.
570 /// @brief Bitwise OR assignment operator.
571 APInt& operator|=(const APInt& RHS);
573 /// Performs a bitwise XOR operation on this APInt and RHS. The result is
574 /// assigned to *this.
575 /// @returns *this after XORing with RHS.
576 /// @brief Bitwise XOR assignment operator.
577 APInt& operator^=(const APInt& RHS);
579 /// Multiplies this APInt by RHS and assigns the result to *this.
581 /// @brief Multiplication assignment operator.
582 APInt& operator*=(const APInt& RHS);
584 /// Adds RHS to *this and assigns the result to *this.
586 /// @brief Addition assignment operator.
587 APInt& operator+=(const APInt& RHS);
589 /// Subtracts RHS from *this and assigns the result to *this.
591 /// @brief Subtraction assignment operator.
592 APInt& operator-=(const APInt& RHS);
594 /// Shifts *this left by shiftAmt and assigns the result to *this.
595 /// @returns *this after shifting left by shiftAmt
596 /// @brief Left-shift assignment function.
597 APInt& operator<<=(uint32_t shiftAmt) {
598 *this = shl(shiftAmt);
603 /// @name Binary Operators
605 /// Performs a bitwise AND operation on *this and RHS.
606 /// @returns An APInt value representing the bitwise AND of *this and RHS.
607 /// @brief Bitwise AND operator.
608 APInt operator&(const APInt& RHS) const {
609 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
611 return APInt(getBitWidth(), VAL & RHS.VAL);
612 return AndSlowCase(RHS);
614 APInt And(const APInt& RHS) const {
615 return this->operator&(RHS);
618 /// Performs a bitwise OR operation on *this and RHS.
619 /// @returns An APInt value representing the bitwise OR of *this and RHS.
620 /// @brief Bitwise OR operator.
621 APInt operator|(const APInt& RHS) const {
622 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
624 return APInt(getBitWidth(), VAL | RHS.VAL);
625 return OrSlowCase(RHS);
627 APInt Or(const APInt& RHS) const {
628 return this->operator|(RHS);
631 /// Performs a bitwise XOR operation on *this and RHS.
632 /// @returns An APInt value representing the bitwise XOR of *this and RHS.
633 /// @brief Bitwise XOR operator.
634 APInt operator^(const APInt& RHS) const {
635 assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
637 return APInt(BitWidth, VAL ^ RHS.VAL);
638 return XorSlowCase(RHS);
640 APInt Xor(const APInt& RHS) const {
641 return this->operator^(RHS);
644 /// Multiplies this APInt by RHS and returns the result.
645 /// @brief Multiplication operator.
646 APInt operator*(const APInt& RHS) const;
648 /// Adds RHS to this APInt and returns the result.
649 /// @brief Addition operator.
650 APInt operator+(const APInt& RHS) const;
651 APInt operator+(uint64_t RHS) const {
652 return (*this) + APInt(BitWidth, RHS);
655 /// Subtracts RHS from this APInt and returns the result.
656 /// @brief Subtraction operator.
657 APInt operator-(const APInt& RHS) const;
658 APInt operator-(uint64_t RHS) const {
659 return (*this) - APInt(BitWidth, RHS);
662 APInt operator<<(unsigned Bits) const {
666 APInt operator<<(const APInt &Bits) const {
670 /// Arithmetic right-shift this APInt by shiftAmt.
671 /// @brief Arithmetic right-shift function.
672 APInt ashr(uint32_t shiftAmt) const;
674 /// Logical right-shift this APInt by shiftAmt.
675 /// @brief Logical right-shift function.
676 APInt lshr(uint32_t shiftAmt) const;
678 /// Left-shift this APInt by shiftAmt.
679 /// @brief Left-shift function.
680 APInt shl(uint32_t shiftAmt) const {
681 assert(shiftAmt <= BitWidth && "Invalid shift amount");
682 if (isSingleWord()) {
683 if (shiftAmt == BitWidth)
684 return APInt(BitWidth, 0); // avoid undefined shift results
685 return APInt(BitWidth, VAL << shiftAmt);
687 return shlSlowCase(shiftAmt);
690 /// @brief Rotate left by rotateAmt.
691 APInt rotl(uint32_t rotateAmt) const;
693 /// @brief Rotate right by rotateAmt.
694 APInt rotr(uint32_t rotateAmt) const;
696 /// Arithmetic right-shift this APInt by shiftAmt.
697 /// @brief Arithmetic right-shift function.
698 APInt ashr(const APInt &shiftAmt) const;
700 /// Logical right-shift this APInt by shiftAmt.
701 /// @brief Logical right-shift function.
702 APInt lshr(const APInt &shiftAmt) const;
704 /// Left-shift this APInt by shiftAmt.
705 /// @brief Left-shift function.
706 APInt shl(const APInt &shiftAmt) const;
708 /// @brief Rotate left by rotateAmt.
709 APInt rotl(const APInt &rotateAmt) const;
711 /// @brief Rotate right by rotateAmt.
712 APInt rotr(const APInt &rotateAmt) const;
714 /// Perform an unsigned divide operation on this APInt by RHS. Both this and
715 /// RHS are treated as unsigned quantities for purposes of this division.
716 /// @returns a new APInt value containing the division result
717 /// @brief Unsigned division operation.
718 APInt udiv(const APInt& RHS) const;
720 /// Signed divide this APInt by APInt RHS.
721 /// @brief Signed division function for APInt.
722 APInt sdiv(const APInt& RHS) const {
724 if (RHS.isNegative())
725 return (-(*this)).udiv(-RHS);
727 return -((-(*this)).udiv(RHS));
728 else if (RHS.isNegative())
729 return -(this->udiv(-RHS));
730 return this->udiv(RHS);
733 /// Perform an unsigned remainder operation on this APInt with RHS being the
734 /// divisor. Both this and RHS are treated as unsigned quantities for purposes
735 /// of this operation. Note that this is a true remainder operation and not
736 /// a modulo operation because the sign follows the sign of the dividend
738 /// @returns a new APInt value containing the remainder result
739 /// @brief Unsigned remainder operation.
740 APInt urem(const APInt& RHS) const;
742 /// Signed remainder operation on APInt.
743 /// @brief Function for signed remainder operation.
744 APInt srem(const APInt& RHS) const {
746 if (RHS.isNegative())
747 return -((-(*this)).urem(-RHS));
749 return -((-(*this)).urem(RHS));
750 else if (RHS.isNegative())
751 return this->urem(-RHS);
752 return this->urem(RHS);
755 /// Sometimes it is convenient to divide two APInt values and obtain both the
756 /// quotient and remainder. This function does both operations in the same
757 /// computation making it a little more efficient. The pair of input arguments
758 /// may overlap with the pair of output arguments. It is safe to call
759 /// udivrem(X, Y, X, Y), for example.
760 /// @brief Dual division/remainder interface.
761 static void udivrem(const APInt &LHS, const APInt &RHS,
762 APInt &Quotient, APInt &Remainder);
764 static void sdivrem(const APInt &LHS, const APInt &RHS,
765 APInt &Quotient, APInt &Remainder)
767 if (LHS.isNegative()) {
768 if (RHS.isNegative())
769 APInt::udivrem(-LHS, -RHS, Quotient, Remainder);
771 APInt::udivrem(-LHS, RHS, Quotient, Remainder);
772 Quotient = -Quotient;
773 Remainder = -Remainder;
774 } else if (RHS.isNegative()) {
775 APInt::udivrem(LHS, -RHS, Quotient, Remainder);
776 Quotient = -Quotient;
778 APInt::udivrem(LHS, RHS, Quotient, Remainder);
782 /// @returns the bit value at bitPosition
783 /// @brief Array-indexing support.
784 bool operator[](uint32_t bitPosition) const;
787 /// @name Comparison Operators
789 /// Compares this APInt with RHS for the validity of the equality
791 /// @brief Equality operator.
792 bool operator==(const APInt& RHS) const {
793 assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
795 return VAL == RHS.VAL;
796 return EqualSlowCase(RHS);
799 /// Compares this APInt with a uint64_t for the validity of the equality
801 /// @returns true if *this == Val
802 /// @brief Equality operator.
803 bool operator==(uint64_t Val) const {
806 return EqualSlowCase(Val);
809 /// Compares this APInt with RHS for the validity of the equality
811 /// @returns true if *this == Val
812 /// @brief Equality comparison.
813 bool eq(const APInt &RHS) const {
814 return (*this) == RHS;
817 /// Compares this APInt with RHS for the validity of the inequality
819 /// @returns true if *this != Val
820 /// @brief Inequality operator.
821 bool operator!=(const APInt& RHS) const {
822 return !((*this) == RHS);
825 /// Compares this APInt with a uint64_t for the validity of the inequality
827 /// @returns true if *this != Val
828 /// @brief Inequality operator.
829 bool operator!=(uint64_t Val) const {
830 return !((*this) == Val);
833 /// Compares this APInt with RHS for the validity of the inequality
835 /// @returns true if *this != Val
836 /// @brief Inequality comparison
837 bool ne(const APInt &RHS) const {
838 return !((*this) == RHS);
841 /// Regards both *this and RHS as unsigned quantities and compares them for
842 /// the validity of the less-than relationship.
843 /// @returns true if *this < RHS when both are considered unsigned.
844 /// @brief Unsigned less than comparison
845 bool ult(const APInt& RHS) const;
847 /// Regards both *this and RHS as signed quantities and compares them for
848 /// validity of the less-than relationship.
849 /// @returns true if *this < RHS when both are considered signed.
850 /// @brief Signed less than comparison
851 bool slt(const APInt& RHS) const;
853 /// Regards both *this and RHS as unsigned quantities and compares them for
854 /// validity of the less-or-equal relationship.
855 /// @returns true if *this <= RHS when both are considered unsigned.
856 /// @brief Unsigned less or equal comparison
857 bool ule(const APInt& RHS) const {
858 return ult(RHS) || eq(RHS);
861 /// Regards both *this and RHS as signed quantities and compares them for
862 /// validity of the less-or-equal relationship.
863 /// @returns true if *this <= RHS when both are considered signed.
864 /// @brief Signed less or equal comparison
865 bool sle(const APInt& RHS) const {
866 return slt(RHS) || eq(RHS);
869 /// Regards both *this and RHS as unsigned quantities and compares them for
870 /// the validity of the greater-than relationship.
871 /// @returns true if *this > RHS when both are considered unsigned.
872 /// @brief Unsigned greather than comparison
873 bool ugt(const APInt& RHS) const {
874 return !ult(RHS) && !eq(RHS);
877 /// Regards both *this and RHS as signed quantities and compares them for
878 /// the validity of the greater-than relationship.
879 /// @returns true if *this > RHS when both are considered signed.
880 /// @brief Signed greather than comparison
881 bool sgt(const APInt& RHS) const {
882 return !slt(RHS) && !eq(RHS);
885 /// Regards both *this and RHS as unsigned quantities and compares them for
886 /// validity of the greater-or-equal relationship.
887 /// @returns true if *this >= RHS when both are considered unsigned.
888 /// @brief Unsigned greater or equal comparison
889 bool uge(const APInt& RHS) const {
893 /// Regards both *this and RHS as signed quantities and compares them for
894 /// validity of the greater-or-equal relationship.
895 /// @returns true if *this >= RHS when both are considered signed.
896 /// @brief Signed greather or equal comparison
897 bool sge(const APInt& RHS) const {
901 /// This operation tests if there are any pairs of corresponding bits
902 /// between this APInt and RHS that are both set.
903 bool intersects(const APInt &RHS) const {
904 return (*this & RHS) != 0;
908 /// @name Resizing Operators
910 /// Truncate the APInt to a specified width. It is an error to specify a width
911 /// that is greater than or equal to the current width.
912 /// @brief Truncate to new width.
913 APInt &trunc(uint32_t width);
915 /// This operation sign extends the APInt to a new width. If the high order
916 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
917 /// It is an error to specify a width that is less than or equal to the
919 /// @brief Sign extend to a new width.
920 APInt &sext(uint32_t width);
922 /// This operation zero extends the APInt to a new width. The high order bits
923 /// are filled with 0 bits. It is an error to specify a width that is less
924 /// than or equal to the current width.
925 /// @brief Zero extend to a new width.
926 APInt &zext(uint32_t width);
928 /// Make this APInt have the bit width given by \p width. The value is sign
929 /// extended, truncated, or left alone to make it that width.
930 /// @brief Sign extend or truncate to width
931 APInt &sextOrTrunc(uint32_t width);
933 /// Make this APInt have the bit width given by \p width. The value is zero
934 /// extended, truncated, or left alone to make it that width.
935 /// @brief Zero extend or truncate to width
936 APInt &zextOrTrunc(uint32_t width);
939 /// @name Bit Manipulation Operators
941 /// @brief Set every bit to 1.
943 if (isSingleWord()) {
945 return clearUnusedBits();
948 // Set all the bits in all the words.
949 for (uint32_t i = 0; i < getNumWords(); ++i)
951 // Clear the unused ones
952 return clearUnusedBits();
955 /// Set the given bit to 1 whose position is given as "bitPosition".
956 /// @brief Set a given bit to 1.
957 APInt& set(uint32_t bitPosition);
959 /// @brief Set every bit to 0.
964 memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
968 /// Set the given bit to 0 whose position is given as "bitPosition".
969 /// @brief Set a given bit to 0.
970 APInt& clear(uint32_t bitPosition);
972 /// @brief Toggle every bit to its opposite value.
974 if (isSingleWord()) {
976 return clearUnusedBits();
978 for (uint32_t i = 0; i < getNumWords(); ++i)
980 return clearUnusedBits();
983 /// Toggle a given bit to its opposite value whose position is given
984 /// as "bitPosition".
985 /// @brief Toggles a given bit to its opposite value.
986 APInt& flip(uint32_t bitPosition);
989 /// @name Value Characterization Functions
992 /// @returns the total number of bits.
993 uint32_t getBitWidth() const {
997 /// Here one word's bitwidth equals to that of uint64_t.
998 /// @returns the number of words to hold the integer value of this APInt.
999 /// @brief Get the number of words.
1000 uint32_t getNumWords() const {
1001 return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
1004 /// This function returns the number of active bits which is defined as the
1005 /// bit width minus the number of leading zeros. This is used in several
1006 /// computations to see how "wide" the value is.
1007 /// @brief Compute the number of active bits in the value
1008 uint32_t getActiveBits() const {
1009 return BitWidth - countLeadingZeros();
1012 /// This function returns the number of active words in the value of this
1013 /// APInt. This is used in conjunction with getActiveData to extract the raw
1014 /// value of the APInt.
1015 uint32_t getActiveWords() const {
1016 return whichWord(getActiveBits()-1) + 1;
1019 /// Computes the minimum bit width for this APInt while considering it to be
1020 /// a signed (and probably negative) value. If the value is not negative,
1021 /// this function returns the same value as getActiveBits()+1. Otherwise, it
1022 /// returns the smallest bit width that will retain the negative value. For
1023 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
1024 /// for -1, this function will always return 1.
1025 /// @brief Get the minimum bit size for this signed APInt
1026 uint32_t getMinSignedBits() const {
1028 return BitWidth - countLeadingOnes() + 1;
1029 return getActiveBits()+1;
1032 /// This method attempts to return the value of this APInt as a zero extended
1033 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
1034 /// uint64_t. Otherwise an assertion will result.
1035 /// @brief Get zero extended value
1036 uint64_t getZExtValue() const {
1039 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
1043 /// This method attempts to return the value of this APInt as a sign extended
1044 /// int64_t. The bit width must be <= 64 or the value must fit within an
1045 /// int64_t. Otherwise an assertion will result.
1046 /// @brief Get sign extended value
1047 int64_t getSExtValue() const {
1049 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
1050 (APINT_BITS_PER_WORD - BitWidth);
1051 assert(getActiveBits() <= 64 && "Too many bits for int64_t");
1052 return int64_t(pVal[0]);
1055 /// This method determines how many bits are required to hold the APInt
1056 /// equivalent of the string given by \p str of length \p slen.
1057 /// @brief Get bits required for string value.
1058 static uint32_t getBitsNeeded(const char* str, uint32_t slen, uint8_t radix);
1060 /// countLeadingZeros - This function is an APInt version of the
1061 /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
1062 /// of zeros from the most significant bit to the first one bit.
1063 /// @returns BitWidth if the value is zero.
1064 /// @returns the number of zeros from the most significant bit to the first
1066 uint32_t countLeadingZeros() const {
1067 if (isSingleWord()) {
1068 uint32_t unusedBits = APINT_BITS_PER_WORD - BitWidth;
1069 return CountLeadingZeros_64(VAL) - unusedBits;
1071 return countLeadingZerosSlowCase();
1074 /// countLeadingOnes - This function is an APInt version of the
1075 /// countLeadingOnes_{32,64} functions in MathExtras.h. It counts the number
1076 /// of ones from the most significant bit to the first zero bit.
1077 /// @returns 0 if the high order bit is not set
1078 /// @returns the number of 1 bits from the most significant to the least
1079 /// @brief Count the number of leading one bits.
1080 uint32_t countLeadingOnes() const;
1082 /// countTrailingZeros - This function is an APInt version of the
1083 /// countTrailingZeros_{32,64} functions in MathExtras.h. It counts
1084 /// the number of zeros from the least significant bit to the first set bit.
1085 /// @returns BitWidth if the value is zero.
1086 /// @returns the number of zeros from the least significant bit to the first
1088 /// @brief Count the number of trailing zero bits.
1089 uint32_t countTrailingZeros() const;
1091 /// countTrailingOnes - This function is an APInt version of the
1092 /// countTrailingOnes_{32,64} functions in MathExtras.h. It counts
1093 /// the number of ones from the least significant bit to the first zero bit.
1094 /// @returns BitWidth if the value is all ones.
1095 /// @returns the number of ones from the least significant bit to the first
1097 /// @brief Count the number of trailing one bits.
1098 uint32_t countTrailingOnes() const {
1100 return CountTrailingOnes_64(VAL);
1101 return countTrailingOnesSlowCase();
1104 /// countPopulation - This function is an APInt version of the
1105 /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
1106 /// of 1 bits in the APInt value.
1107 /// @returns 0 if the value is zero.
1108 /// @returns the number of set bits.
1109 /// @brief Count the number of bits set.
1110 uint32_t countPopulation() const {
1112 return CountPopulation_64(VAL);
1113 return countPopulationSlowCase();
1117 /// @name Conversion Functions
1120 void print(std::ostream &OS, bool isSigned) const;
1122 /// toString - Converts an APInt to a string and append it to Str. Str is
1123 /// commonly a SmallString.
1124 void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed) const;
1126 /// Considers the APInt to be unsigned and converts it into a string in the
1127 /// radix given. The radix can be 2, 8, 10 or 16.
1128 void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1129 return toString(Str, Radix, false);
1132 /// Considers the APInt to be signed and converts it into a string in the
1133 /// radix given. The radix can be 2, 8, 10 or 16.
1134 void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
1135 return toString(Str, Radix, true);
1138 /// toString - This returns the APInt as a std::string. Note that this is an
1139 /// inefficient method. It is better to pass in a SmallVector/SmallString
1140 /// to the methods above to avoid thrashing the heap for the string.
1141 std::string toString(unsigned Radix, bool Signed) const;
1144 /// @returns a byte-swapped representation of this APInt Value.
1145 APInt byteSwap() const;
1147 /// @brief Converts this APInt to a double value.
1148 double roundToDouble(bool isSigned) const;
1150 /// @brief Converts this unsigned APInt to a double value.
1151 double roundToDouble() const {
1152 return roundToDouble(false);
1155 /// @brief Converts this signed APInt to a double value.
1156 double signedRoundToDouble() const {
1157 return roundToDouble(true);
1160 /// The conversion does not do a translation from integer to double, it just
1161 /// re-interprets the bits as a double. Note that it is valid to do this on
1162 /// any bit width. Exactly 64 bits will be translated.
1163 /// @brief Converts APInt bits to a double
1164 double bitsToDouble() const {
1169 T.I = (isSingleWord() ? VAL : pVal[0]);
1173 /// The conversion does not do a translation from integer to float, it just
1174 /// re-interprets the bits as a float. Note that it is valid to do this on
1175 /// any bit width. Exactly 32 bits will be translated.
1176 /// @brief Converts APInt bits to a double
1177 float bitsToFloat() const {
1182 T.I = uint32_t((isSingleWord() ? VAL : pVal[0]));
1186 /// The conversion does not do a translation from double to integer, it just
1187 /// re-interprets the bits of the double. Note that it is valid to do this on
1188 /// any bit width but bits from V may get truncated.
1189 /// @brief Converts a double to APInt bits.
1190 APInt& doubleToBits(double V) {
1200 return clearUnusedBits();
1203 /// The conversion does not do a translation from float to integer, it just
1204 /// re-interprets the bits of the float. Note that it is valid to do this on
1205 /// any bit width but bits from V may get truncated.
1206 /// @brief Converts a float to APInt bits.
1207 APInt& floatToBits(float V) {
1217 return clearUnusedBits();
1221 /// @name Mathematics Operations
1224 /// @returns the floor log base 2 of this APInt.
1225 uint32_t logBase2() const {
1226 return BitWidth - 1 - countLeadingZeros();
1229 /// @returns the log base 2 of this APInt if its an exact power of two, -1
1231 int32_t exactLogBase2() const {
1237 /// @brief Compute the square root
1240 /// If *this is < 0 then return -(*this), otherwise *this;
1241 /// @brief Get the absolute value;
1248 /// @returns the multiplicative inverse for a given modulo.
1249 APInt multiplicativeInverse(const APInt& modulo) const;
1252 /// @name Building-block Operations for APInt and APFloat
1255 // These building block operations operate on a representation of
1256 // arbitrary precision, two's-complement, bignum integer values.
1257 // They should be sufficient to implement APInt and APFloat bignum
1258 // requirements. Inputs are generally a pointer to the base of an
1259 // array of integer parts, representing an unsigned bignum, and a
1260 // count of how many parts there are.
1262 /// Sets the least significant part of a bignum to the input value,
1263 /// and zeroes out higher parts. */
1264 static void tcSet(integerPart *, integerPart, unsigned int);
1266 /// Assign one bignum to another.
1267 static void tcAssign(integerPart *, const integerPart *, unsigned int);
1269 /// Returns true if a bignum is zero, false otherwise.
1270 static bool tcIsZero(const integerPart *, unsigned int);
1272 /// Extract the given bit of a bignum; returns 0 or 1. Zero-based.
1273 static int tcExtractBit(const integerPart *, unsigned int bit);
1275 /// Copy the bit vector of width srcBITS from SRC, starting at bit
1276 /// srcLSB, to DST, of dstCOUNT parts, such that the bit srcLSB
1277 /// becomes the least significant bit of DST. All high bits above
1278 /// srcBITS in DST are zero-filled.
1279 static void tcExtract(integerPart *, unsigned int dstCount, const integerPart *,
1280 unsigned int srcBits, unsigned int srcLSB);
1282 /// Set the given bit of a bignum. Zero-based.
1283 static void tcSetBit(integerPart *, unsigned int bit);
1285 /// Returns the bit number of the least or most significant set bit
1286 /// of a number. If the input number has no bits set -1U is
1288 static unsigned int tcLSB(const integerPart *, unsigned int);
1289 static unsigned int tcMSB(const integerPart *parts, unsigned int n);
1291 /// Negate a bignum in-place.
1292 static void tcNegate(integerPart *, unsigned int);
1294 /// DST += RHS + CARRY where CARRY is zero or one. Returns the
1296 static integerPart tcAdd(integerPart *, const integerPart *,
1297 integerPart carry, unsigned);
1299 /// DST -= RHS + CARRY where CARRY is zero or one. Returns the
1301 static integerPart tcSubtract(integerPart *, const integerPart *,
1302 integerPart carry, unsigned);
1304 /// DST += SRC * MULTIPLIER + PART if add is true
1305 /// DST = SRC * MULTIPLIER + PART if add is false
1307 /// Requires 0 <= DSTPARTS <= SRCPARTS + 1. If DST overlaps SRC
1308 /// they must start at the same point, i.e. DST == SRC.
1310 /// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is
1311 /// returned. Otherwise DST is filled with the least significant
1312 /// DSTPARTS parts of the result, and if all of the omitted higher
1313 /// parts were zero return zero, otherwise overflow occurred and
1315 static int tcMultiplyPart(integerPart *dst, const integerPart *src,
1316 integerPart multiplier, integerPart carry,
1317 unsigned int srcParts, unsigned int dstParts,
1320 /// DST = LHS * RHS, where DST has the same width as the operands
1321 /// and is filled with the least significant parts of the result.
1322 /// Returns one if overflow occurred, otherwise zero. DST must be
1323 /// disjoint from both operands.
1324 static int tcMultiply(integerPart *, const integerPart *,
1325 const integerPart *, unsigned);
1327 /// DST = LHS * RHS, where DST has width the sum of the widths of
1328 /// the operands. No overflow occurs. DST must be disjoint from
1329 /// both operands. Returns the number of parts required to hold the
1331 static unsigned int tcFullMultiply(integerPart *, const integerPart *,
1332 const integerPart *, unsigned, unsigned);
1334 /// If RHS is zero LHS and REMAINDER are left unchanged, return one.
1335 /// Otherwise set LHS to LHS / RHS with the fractional part
1336 /// discarded, set REMAINDER to the remainder, return zero. i.e.
1338 /// OLD_LHS = RHS * LHS + REMAINDER
1340 /// SCRATCH is a bignum of the same size as the operands and result
1341 /// for use by the routine; its contents need not be initialized
1342 /// and are destroyed. LHS, REMAINDER and SCRATCH must be
1344 static int tcDivide(integerPart *lhs, const integerPart *rhs,
1345 integerPart *remainder, integerPart *scratch,
1346 unsigned int parts);
1348 /// Shift a bignum left COUNT bits. Shifted in bits are zero.
1349 /// There are no restrictions on COUNT.
1350 static void tcShiftLeft(integerPart *, unsigned int parts,
1351 unsigned int count);
1353 /// Shift a bignum right COUNT bits. Shifted in bits are zero.
1354 /// There are no restrictions on COUNT.
1355 static void tcShiftRight(integerPart *, unsigned int parts,
1356 unsigned int count);
1358 /// The obvious AND, OR and XOR and complement operations.
1359 static void tcAnd(integerPart *, const integerPart *, unsigned int);
1360 static void tcOr(integerPart *, const integerPart *, unsigned int);
1361 static void tcXor(integerPart *, const integerPart *, unsigned int);
1362 static void tcComplement(integerPart *, unsigned int);
1364 /// Comparison (unsigned) of two bignums.
1365 static int tcCompare(const integerPart *, const integerPart *,
1368 /// Increment a bignum in-place. Return the carry flag.
1369 static integerPart tcIncrement(integerPart *, unsigned int);
1371 /// Set the least significant BITS and clear the rest.
1372 static void tcSetLeastSignificantBits(integerPart *, unsigned int,
1375 /// @brief debug method
1381 inline bool operator==(uint64_t V1, const APInt& V2) {
1385 inline bool operator!=(uint64_t V1, const APInt& V2) {
1389 inline std::ostream &operator<<(std::ostream &OS, const APInt &I) {
1394 namespace APIntOps {
1396 /// @brief Determine the smaller of two APInts considered to be signed.
1397 inline APInt smin(const APInt &A, const APInt &B) {
1398 return A.slt(B) ? A : B;
1401 /// @brief Determine the larger of two APInts considered to be signed.
1402 inline APInt smax(const APInt &A, const APInt &B) {
1403 return A.sgt(B) ? A : B;
1406 /// @brief Determine the smaller of two APInts considered to be signed.
1407 inline APInt umin(const APInt &A, const APInt &B) {
1408 return A.ult(B) ? A : B;
1411 /// @brief Determine the larger of two APInts considered to be unsigned.
1412 inline APInt umax(const APInt &A, const APInt &B) {
1413 return A.ugt(B) ? A : B;
1416 /// @brief Check if the specified APInt has a N-bits unsigned integer value.
1417 inline bool isIntN(uint32_t N, const APInt& APIVal) {
1418 return APIVal.isIntN(N);
1421 /// @brief Check if the specified APInt has a N-bits signed integer value.
1422 inline bool isSignedIntN(uint32_t N, const APInt& APIVal) {
1423 return APIVal.isSignedIntN(N);
1426 /// @returns true if the argument APInt value is a sequence of ones
1427 /// starting at the least significant bit with the remainder zero.
1428 inline bool isMask(uint32_t numBits, const APInt& APIVal) {
1429 return numBits <= APIVal.getBitWidth() &&
1430 APIVal == APInt::getLowBitsSet(APIVal.getBitWidth(), numBits);
1433 /// @returns true if the argument APInt value contains a sequence of ones
1434 /// with the remainder zero.
1435 inline bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
1436 return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
1439 /// @returns a byte-swapped representation of the specified APInt Value.
1440 inline APInt byteSwap(const APInt& APIVal) {
1441 return APIVal.byteSwap();
1444 /// @returns the floor log base 2 of the specified APInt value.
1445 inline uint32_t logBase2(const APInt& APIVal) {
1446 return APIVal.logBase2();
1449 /// GreatestCommonDivisor - This function returns the greatest common
1450 /// divisor of the two APInt values using Euclid's algorithm.
1451 /// @returns the greatest common divisor of Val1 and Val2
1452 /// @brief Compute GCD of two APInt values.
1453 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
1455 /// Treats the APInt as an unsigned value for conversion purposes.
1456 /// @brief Converts the given APInt to a double value.
1457 inline double RoundAPIntToDouble(const APInt& APIVal) {
1458 return APIVal.roundToDouble();
1461 /// Treats the APInt as a signed value for conversion purposes.
1462 /// @brief Converts the given APInt to a double value.
1463 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
1464 return APIVal.signedRoundToDouble();
1467 /// @brief Converts the given APInt to a float vlalue.
1468 inline float RoundAPIntToFloat(const APInt& APIVal) {
1469 return float(RoundAPIntToDouble(APIVal));
1472 /// Treast the APInt as a signed value for conversion purposes.
1473 /// @brief Converts the given APInt to a float value.
1474 inline float RoundSignedAPIntToFloat(const APInt& APIVal) {
1475 return float(APIVal.signedRoundToDouble());
1478 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
1479 /// @brief Converts the given double value into a APInt.
1480 APInt RoundDoubleToAPInt(double Double, uint32_t width);
1482 /// RoundFloatToAPInt - Converts a float value into an APInt value.
1483 /// @brief Converts a float value into a APInt.
1484 inline APInt RoundFloatToAPInt(float Float, uint32_t width) {
1485 return RoundDoubleToAPInt(double(Float), width);
1488 /// Arithmetic right-shift the APInt by shiftAmt.
1489 /// @brief Arithmetic right-shift function.
1490 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
1491 return LHS.ashr(shiftAmt);
1494 /// Logical right-shift the APInt by shiftAmt.
1495 /// @brief Logical right-shift function.
1496 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
1497 return LHS.lshr(shiftAmt);
1500 /// Left-shift the APInt by shiftAmt.
1501 /// @brief Left-shift function.
1502 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
1503 return LHS.shl(shiftAmt);
1506 /// Signed divide APInt LHS by APInt RHS.
1507 /// @brief Signed division function for APInt.
1508 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
1509 return LHS.sdiv(RHS);
1512 /// Unsigned divide APInt LHS by APInt RHS.
1513 /// @brief Unsigned division function for APInt.
1514 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
1515 return LHS.udiv(RHS);
1518 /// Signed remainder operation on APInt.
1519 /// @brief Function for signed remainder operation.
1520 inline APInt srem(const APInt& LHS, const APInt& RHS) {
1521 return LHS.srem(RHS);
1524 /// Unsigned remainder operation on APInt.
1525 /// @brief Function for unsigned remainder operation.
1526 inline APInt urem(const APInt& LHS, const APInt& RHS) {
1527 return LHS.urem(RHS);
1530 /// Performs multiplication on APInt values.
1531 /// @brief Function for multiplication operation.
1532 inline APInt mul(const APInt& LHS, const APInt& RHS) {
1536 /// Performs addition on APInt values.
1537 /// @brief Function for addition operation.
1538 inline APInt add(const APInt& LHS, const APInt& RHS) {
1542 /// Performs subtraction on APInt values.
1543 /// @brief Function for subtraction operation.
1544 inline APInt sub(const APInt& LHS, const APInt& RHS) {
1548 /// Performs bitwise AND operation on APInt LHS and
1550 /// @brief Bitwise AND function for APInt.
1551 inline APInt And(const APInt& LHS, const APInt& RHS) {
1555 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1556 /// @brief Bitwise OR function for APInt.
1557 inline APInt Or(const APInt& LHS, const APInt& RHS) {
1561 /// Performs bitwise XOR operation on APInt.
1562 /// @brief Bitwise XOR function for APInt.
1563 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
1567 /// Performs a bitwise complement operation on APInt.
1568 /// @brief Bitwise complement function.
1569 inline APInt Not(const APInt& APIVal) {
1573 } // End of APIntOps namespace
1575 } // End of llvm namespace