1 //===-- llvm/Support/APInt.h - For Arbitrary Precision Integer -*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Sheng Zhou and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a class to represent arbitrary precision integral
13 //===----------------------------------------------------------------------===//
18 #include "llvm/Support/DataTypes.h"
24 /// Forward declaration.
27 APInt udiv(const APInt& LHS, const APInt& RHS);
28 APInt urem(const APInt& LHS, const APInt& RHS);
31 //===----------------------------------------------------------------------===//
33 //===----------------------------------------------------------------------===//
35 /// APInt - This class represents arbitrary precision constant integral values.
36 /// It is a functional replacement for common case unsigned integer type like
37 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
38 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
39 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
40 /// and methods to manipulate integer values of any bit-width. It supports both
41 /// the typical integer arithmetic and comparison operations as well as bitwise
44 /// The class has several invariants worth noting:
45 /// * All bit, byte, and word positions are zero-based.
46 /// * Once the bit width is set, it doesn't change except by the Truncate,
47 /// SignExtend, or ZeroExtend operations.
48 /// * All binary operators must be on APInt instances of the same bit width.
49 /// Attempting to use these operators on instances with different bit
50 /// widths will yield an assertion.
51 /// * The value is stored canonically as an unsigned value. For operations
52 /// where it makes a difference, there are both signed and unsigned variants
53 /// of the operation. For example, sdiv and udiv. However, because the bit
54 /// widths must be the same, operations such as Mul and Add produce the same
55 /// results regardless of whether the values are interpreted as signed or
57 /// * In general, the class tries to follow the style of computation that LLVM
58 /// uses in its IR. This simplifies its use for LLVM.
60 /// @brief Class for arbitrary precision integers.
63 uint32_t BitWidth; ///< The number of bits in this APInt.
65 /// This union is used to store the integer value. When the
66 /// integer bit-width <= 64, it uses VAL;
67 /// otherwise it uses the pVal.
69 uint64_t VAL; ///< Used to store the <= 64 bits integer value.
70 uint64_t *pVal; ///< Used to store the >64 bits integer value.
73 /// This enum is just used to hold a constant we needed for APInt.
75 APINT_BITS_PER_WORD = sizeof(uint64_t) * 8,
76 APINT_WORD_SIZE = sizeof(uint64_t)
79 // Fast internal constructor
80 APInt(uint64_t* val, uint32_t bits) : BitWidth(bits), pVal(val) { }
82 /// Here one word's bitwidth equals to that of uint64_t.
83 /// @returns the number of words to hold the integer value of this APInt.
84 /// @brief Get the number of words.
85 inline uint32_t getNumWords() const {
86 return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
89 /// @returns true if the number of bits <= 64, false otherwise.
90 /// @brief Determine if this APInt just has one word to store value.
91 inline bool isSingleWord() const {
92 return BitWidth <= APINT_BITS_PER_WORD;
95 /// @returns the word position for the specified bit position.
96 static inline uint32_t whichWord(uint32_t bitPosition) {
97 return bitPosition / APINT_BITS_PER_WORD;
100 /// @returns the bit position in a word for the specified bit position
102 static inline uint32_t whichBit(uint32_t bitPosition) {
103 return bitPosition % APINT_BITS_PER_WORD;
106 /// @returns a uint64_t type integer with just bit position at
107 /// "whichBit(bitPosition)" setting, others zero.
108 static inline uint64_t maskBit(uint32_t bitPosition) {
109 return (static_cast<uint64_t>(1)) << whichBit(bitPosition);
112 /// This method is used internally to clear the to "N" bits that are not used
113 /// by the APInt. This is needed after the most significant word is assigned
114 /// a value to ensure that those bits are zero'd out.
115 /// @brief Clear high order bits
116 inline APInt& clearUnusedBits() {
117 // Compute how many bits are used in the final word
118 uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
120 // If all bits are used, we want to leave the value alone. This also
121 // avoids the undefined behavior of >> when the shfit is the same size as
122 // the word size (64).
125 // Mask out the hight bits.
126 uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
130 pVal[getNumWords() - 1] &= mask;
134 /// @returns the corresponding word for the specified bit position.
135 /// @brief Get the word corresponding to a bit position
136 inline uint64_t getWord(uint32_t bitPosition) const {
137 return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
140 /// This is used by the constructors that take string arguments.
141 /// @brief Converts a char array into an APInt
142 void fromString(uint32_t numBits, const char *StrStart, uint32_t slen,
145 /// This is used by the toString method to divide by the radix. It simply
146 /// provides a more convenient form of divide for internal use since KnuthDiv
147 /// has specific constraints on its inputs. If those constraints are not met
148 /// then it provides a simpler form of divide.
149 /// @brief An internal division function for dividing APInts.
150 static void divide(const APInt LHS, uint32_t lhsWords,
151 const APInt &RHS, uint32_t rhsWords,
152 APInt *Quotient, APInt *Remainder);
155 /// @brief debug method
160 /// @brief Create a new APInt of numBits width, initialized as val.
161 APInt(uint32_t numBits, uint64_t val);
163 /// Note that numWords can be smaller or larger than the corresponding bit
164 /// width but any extraneous bits will be dropped.
165 /// @brief Create a new APInt of numBits width, initialized as bigVal[].
166 APInt(uint32_t numBits, uint32_t numWords, uint64_t bigVal[]);
168 /// @brief Create a new APInt by translating the string represented
170 APInt(uint32_t numBits, const std::string& Val, uint8_t radix);
172 /// @brief Create a new APInt by translating the char array represented
174 APInt(uint32_t numBits, const char StrStart[], uint32_t slen, uint8_t radix);
176 /// @brief Copy Constructor.
177 APInt(const APInt& API);
179 /// @brief Destructor.
182 /// @brief Copy assignment operator.
183 APInt& operator=(const APInt& RHS);
185 /// Assigns an integer value to the APInt.
186 /// @brief Assignment operator.
187 APInt& operator=(uint64_t RHS);
189 /// Increments the APInt by one.
190 /// @brief Postfix increment operator.
191 inline const APInt operator++(int) {
197 /// Increments the APInt by one.
198 /// @brief Prefix increment operator.
201 /// Decrements the APInt by one.
202 /// @brief Postfix decrement operator.
203 inline const APInt operator--(int) {
209 /// Decrements the APInt by one.
210 /// @brief Prefix decrement operator.
213 /// Performs bitwise AND operation on this APInt and the given APInt& RHS,
214 /// assigns the result to this APInt.
215 /// @brief Bitwise AND assignment operator.
216 APInt& operator&=(const APInt& RHS);
218 /// Performs bitwise OR operation on this APInt and the given APInt& RHS,
219 /// assigns the result to this APInt.
220 /// @brief Bitwise OR assignment operator.
221 APInt& operator|=(const APInt& RHS);
223 /// Performs bitwise XOR operation on this APInt and the given APInt& RHS,
224 /// assigns the result to this APInt.
225 /// @brief Bitwise XOR assignment operator.
226 APInt& operator^=(const APInt& RHS);
228 /// Performs a bitwise complement operation on this APInt.
229 /// @brief Bitwise complement operator.
230 APInt operator~() const;
232 /// Multiplies this APInt by the given APInt& RHS and
233 /// assigns the result to this APInt.
234 /// @brief Multiplication assignment operator.
235 APInt& operator*=(const APInt& RHS);
237 /// Adds this APInt by the given APInt& RHS and
238 /// assigns the result to this APInt.
239 /// @brief Addition assignment operator.
240 APInt& operator+=(const APInt& RHS);
242 /// Subtracts this APInt by the given APInt &RHS and
243 /// assigns the result to this APInt.
244 /// @brief Subtraction assignment operator.
245 APInt& operator-=(const APInt& RHS);
247 /// Performs bitwise AND operation on this APInt and
248 /// the given APInt& RHS.
249 /// @brief Bitwise AND operator.
250 APInt operator&(const APInt& RHS) const;
252 /// Performs bitwise OR operation on this APInt and the given APInt& RHS.
253 /// @brief Bitwise OR operator.
254 APInt operator|(const APInt& RHS) const;
256 /// Performs bitwise XOR operation on this APInt and the given APInt& RHS.
257 /// @brief Bitwise XOR operator.
258 APInt operator^(const APInt& RHS) const;
260 /// Performs logical negation operation on this APInt.
261 /// @brief Logical negation operator.
262 bool operator !() const;
264 /// Multiplies this APInt by the given APInt& RHS.
265 /// @brief Multiplication operator.
266 APInt operator*(const APInt& RHS) const;
268 /// Adds this APInt by the given APInt& RHS.
269 /// @brief Addition operator.
270 APInt operator+(const APInt& RHS) const;
271 APInt operator+(uint64_t RHS) const {
272 return (*this) + APInt(BitWidth, RHS);
276 /// Subtracts this APInt by the given APInt& RHS
277 /// @brief Subtraction operator.
278 APInt operator-(const APInt& RHS) const;
279 APInt operator-(uint64_t RHS) const {
280 return (*this) - APInt(BitWidth, RHS);
283 /// @brief Unary negation operator
284 inline APInt operator-() const {
285 return APInt(BitWidth, 0) - (*this);
288 /// @brief Array-indexing support.
289 bool operator[](uint32_t bitPosition) const;
291 /// Compare this APInt with the given APInt& RHS
292 /// for the validity of the equality relationship.
293 /// @brief Equality operator.
294 bool operator==(const APInt& RHS) const;
296 /// Compare this APInt with the given uint64_t value
297 /// for the validity of the equality relationship.
298 /// @brief Equality operator.
299 bool operator==(uint64_t Val) const;
301 /// Compare this APInt with the given APInt& RHS
302 /// for the validity of the inequality relationship.
303 /// @brief Inequality operator.
304 inline bool operator!=(const APInt& RHS) const {
305 return !((*this) == RHS);
308 /// Compare this APInt with the given uint64_t value
309 /// for the validity of the inequality relationship.
310 /// @brief Inequality operator.
311 inline bool operator!=(uint64_t Val) const {
312 return !((*this) == Val);
315 /// @brief Equality comparison
316 bool eq(const APInt &RHS) const {
317 return (*this) == RHS;
320 /// @brief Inequality comparison
321 bool ne(const APInt &RHS) const {
322 return !((*this) == RHS);
325 /// @brief Unsigned less than comparison
326 bool ult(const APInt& RHS) const;
328 /// @brief Signed less than comparison
329 bool slt(const APInt& RHS) const;
331 /// @brief Unsigned less or equal comparison
332 bool ule(const APInt& RHS) const {
333 return ult(RHS) || eq(RHS);
336 /// @brief Signed less or equal comparison
337 bool sle(const APInt& RHS) const {
338 return slt(RHS) || eq(RHS);
341 /// @brief Unsigned greather than comparison
342 bool ugt(const APInt& RHS) const {
343 return !ult(RHS) && !eq(RHS);
346 /// @brief Signed greather than comparison
347 bool sgt(const APInt& RHS) const {
348 return !slt(RHS) && !eq(RHS);
351 /// @brief Unsigned greater or equal comparison
352 bool uge(const APInt& RHS) const {
356 /// @brief Signed greather or equal comparison
357 bool sge(const APInt& RHS) const {
361 /// This just tests the high bit of this APInt to determine if it is negative.
362 /// @returns true if this APInt is negative, false otherwise
363 /// @brief Determine sign of this APInt.
364 bool isNegative() const {
365 return (*this)[BitWidth - 1];
368 /// Arithmetic right-shift this APInt by shiftAmt.
369 /// @brief Arithmetic right-shift function.
370 APInt ashr(uint32_t shiftAmt) const;
372 /// Logical right-shift this APInt by shiftAmt.
373 /// @brief Logical right-shift function.
374 APInt lshr(uint32_t shiftAmt) const;
376 /// Left-shift this APInt by shiftAmt.
377 /// @brief Left-shift function.
378 APInt shl(uint32_t shiftAmt) const;
380 /// Signed divide this APInt by APInt RHS.
381 /// @brief Signed division function for APInt.
382 inline APInt sdiv(const APInt& RHS) const {
383 bool isNegativeLHS = isNegative();
384 bool isNegativeRHS = RHS.isNegative();
385 APInt Result = APIntOps::udiv(
386 isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
387 return isNegativeLHS != isNegativeRHS ? -Result : Result;
390 /// Unsigned divide this APInt by APInt RHS.
391 /// @brief Unsigned division function for APInt.
392 APInt udiv(const APInt& RHS) const;
394 /// Signed remainder operation on APInt.
395 /// @brief Function for signed remainder operation.
396 inline APInt srem(const APInt& RHS) const {
397 bool isNegativeLHS = isNegative();
398 bool isNegativeRHS = RHS.isNegative();
399 APInt Result = APIntOps::urem(
400 isNegativeLHS ? -(*this) : (*this), isNegativeRHS ? -RHS : RHS);
401 return isNegativeLHS ? -Result : Result;
404 /// Unsigned remainder operation on APInt.
405 /// @brief Function for unsigned remainder operation.
406 APInt urem(const APInt& RHS) const;
408 /// Truncate the APInt to a specified width. It is an error to specify a width
409 /// that is greater than or equal to the current width.
410 /// @brief Truncate to new width.
411 APInt &trunc(uint32_t width);
413 /// This operation sign extends the APInt to a new width. If the high order
414 /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
415 /// It is an error to specify a width that is less than or equal to the
417 /// @brief Sign extend to a new width.
418 APInt &sext(uint32_t width);
420 /// This operation zero extends the APInt to a new width. Thie high order bits
421 /// are filled with 0 bits. It is an error to specify a width that is less
422 /// than or equal to the current width.
423 /// @brief Zero extend to a new width.
424 APInt &zext(uint32_t width);
426 /// Make this APInt have the bit width given by \p width. The value is sign
427 /// extended, truncated, or left alone to make it that width.
428 /// @brief Sign extend or truncate to width
429 APInt &sextOrTrunc(uint32_t width);
431 /// Make this APInt have the bit width given by \p width. The value is zero
432 /// extended, truncated, or left alone to make it that width.
433 /// @brief Zero extend or truncate to width
434 APInt &zextOrTrunc(uint32_t width);
436 /// @brief Set every bit to 1.
439 /// Set the given bit to 1 whose position is given as "bitPosition".
440 /// @brief Set a given bit to 1.
441 APInt& set(uint32_t bitPosition);
443 /// @brief Set every bit to 0.
446 /// Set the given bit to 0 whose position is given as "bitPosition".
447 /// @brief Set a given bit to 0.
448 APInt& clear(uint32_t bitPosition);
450 /// @brief Toggle every bit to its opposite value.
453 /// Toggle a given bit to its opposite value whose position is given
454 /// as "bitPosition".
455 /// @brief Toggles a given bit to its opposite value.
456 APInt& flip(uint32_t bitPosition);
458 /// This function returns the number of active bits which is defined as the
459 /// bit width minus the number of leading zeros. This is used in several
460 /// computations to see how "wide" the value is.
461 /// @brief Compute the number of active bits in the value
462 inline uint32_t getActiveBits() const {
463 return BitWidth - countLeadingZeros();
466 /// This function returns the number of active words in the value of this
467 /// APInt. This is used in conjunction with getActiveData to extract the raw
468 /// value of the APInt.
469 inline uint32_t getActiveWords() const {
470 return whichWord(getActiveBits()-1) + 1;
473 /// This function returns a pointer to the internal storage of the APInt.
474 /// This is useful for writing out the APInt in binary form without any
476 inline const uint64_t* getRawData() const {
482 /// Computes the minimum bit width for this APInt while considering it to be
483 /// a signed (and probably negative) value. If the value is not negative,
484 /// this function returns the same value as getActiveBits(). Otherwise, it
485 /// returns the smallest bit width that will retain the negative value. For
486 /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
487 /// for -1, this function will always return 1.
488 /// @brief Get the minimum bit size for this signed APInt
489 inline uint32_t getMinSignedBits() const {
491 return BitWidth - countLeadingOnes() + 1;
492 return getActiveBits();
495 /// This method attempts to return the value of this APInt as a zero extended
496 /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
497 /// uint64_t. Otherwise an assertion will result.
498 /// @brief Get zero extended value
499 inline uint64_t getZExtValue() const {
502 assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
506 /// This method attempts to return the value of this APInt as a sign extended
507 /// int64_t. The bit width must be <= 64 or the value must fit within an
508 /// int64_t. Otherwise an assertion will result.
509 /// @brief Get sign extended value
510 inline int64_t getSExtValue() const {
512 return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
513 (APINT_BITS_PER_WORD - BitWidth);
514 assert(getActiveBits() <= 64 && "Too many bits for int64_t");
515 return int64_t(pVal[0]);
518 /// @brief Gets maximum unsigned value of APInt for specific bit width.
519 static APInt getMaxValue(uint32_t numBits) {
520 return APInt(numBits, 0).set();
523 /// @brief Gets maximum signed value of APInt for a specific bit width.
524 static APInt getSignedMaxValue(uint32_t numBits) {
525 return APInt(numBits, 0).set().clear(numBits - 1);
528 /// @brief Gets minimum unsigned value of APInt for a specific bit width.
529 static APInt getMinValue(uint32_t numBits) {
530 return APInt(numBits, 0);
533 /// @brief Gets minimum signed value of APInt for a specific bit width.
534 static APInt getSignedMinValue(uint32_t numBits) {
535 return APInt(numBits, 0).set(numBits - 1);
538 /// @returns the all-ones value for an APInt of the specified bit-width.
539 /// @brief Get the all-ones value.
540 static APInt getAllOnesValue(uint32_t numBits) {
541 return APInt(numBits, 0).set();
544 /// @returns the '0' value for an APInt of the specified bit-width.
545 /// @brief Get the '0' value.
546 static APInt getNullValue(uint32_t numBits) {
547 return APInt(numBits, 0);
550 /// The hash value is computed as the sum of the words and the bit width.
551 /// @returns A hash value computed from the sum of the APInt words.
552 /// @brief Get a hash value based on this APInt
553 uint64_t getHashValue() const;
555 /// This converts the APInt to a boolean valy as a test against zero.
556 /// @brief Boolean conversion function.
557 inline bool getBoolValue() const {
558 return countLeadingZeros() != BitWidth;
561 /// This checks to see if the value has all bits of the APInt are set or not.
562 /// @brief Determine if all bits are set
563 inline bool isAllOnesValue() const {
564 return countPopulation() == BitWidth;
567 /// This checks to see if the value of this APInt is the maximum unsigned
568 /// value for the APInt's bit width.
569 /// @brief Determine if this is the largest unsigned value.
570 bool isMaxValue() const {
571 return countPopulation() == BitWidth;
574 /// This checks to see if the value of this APInt is the maximum signed
575 /// value for the APInt's bit width.
576 /// @brief Determine if this is the largest signed value.
577 bool isMaxSignedValue() const {
578 return BitWidth == 1 ? VAL == 0 :
579 !isNegative() && countPopulation() == BitWidth - 1;
582 /// This checks to see if the value of this APInt is the minimum signed
583 /// value for the APInt's bit width.
584 /// @brief Determine if this is the smallest unsigned value.
585 bool isMinValue() const {
586 return countPopulation() == 0;
589 /// This checks to see if the value of this APInt is the minimum signed
590 /// value for the APInt's bit width.
591 /// @brief Determine if this is the smallest signed value.
592 bool isMinSignedValue() const {
593 return BitWidth == 1 ? VAL == 1 :
594 isNegative() && countPopulation() == 1;
597 /// This is used internally to convert an APInt to a string.
598 /// @brief Converts an APInt to a std::string
599 std::string toString(uint8_t radix, bool wantSigned) const;
601 /// Considers the APInt to be unsigned and converts it into a string in the
602 /// radix given. The radix can be 2, 8, 10 or 16.
603 /// @returns a character interpretation of the APInt
604 /// @brief Convert unsigned APInt to string representation.
605 inline std::string toString(uint8_t radix = 10) const {
606 return toString(radix, false);
609 /// Considers the APInt to be unsigned and converts it into a string in the
610 /// radix given. The radix can be 2, 8, 10 or 16.
611 /// @returns a character interpretation of the APInt
612 /// @brief Convert unsigned APInt to string representation.
613 inline std::string toStringSigned(uint8_t radix = 10) const {
614 return toString(radix, true);
617 /// Get an APInt with the same BitWidth as this APInt, just zero mask
618 /// the low bits and right shift to the least significant bit.
619 /// @returns the high "numBits" bits of this APInt.
620 APInt getHiBits(uint32_t numBits) const;
622 /// Get an APInt with the same BitWidth as this APInt, just zero mask
624 /// @returns the low "numBits" bits of this APInt.
625 APInt getLoBits(uint32_t numBits) const;
627 /// @returns true if the argument APInt value is a power of two > 0.
628 bool isPowerOf2() const;
630 /// countLeadingZeros - This function is an APInt version of the
631 /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
632 /// of zeros from the most significant bit to the first one bit.
633 /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
634 /// @returns the number of zeros from the most significant bit to the first
636 /// @brief Count the number of leading one bits.
637 uint32_t countLeadingZeros() const;
639 /// countLeadingOnes - This function counts the number of contiguous 1 bits
640 /// in the high order bits. The count stops when the first 0 bit is reached.
641 /// @returns 0 if the high order bit is not set
642 /// @returns the number of 1 bits from the most significant to the least
643 /// @brief Count the number of leading one bits.
644 uint32_t countLeadingOnes() const;
646 /// countTrailingZeros - This function is an APInt version of the
647 /// countTrailingZoers_{32,64} functions in MathExtras.h. It counts
648 /// the number of zeros from the least significant bit to the first one bit.
649 /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
650 /// @returns the number of zeros from the least significant bit to the first
652 /// @brief Count the number of trailing zero bits.
653 uint32_t countTrailingZeros() const;
655 /// countPopulation - This function is an APInt version of the
656 /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
657 /// of 1 bits in the APInt value.
658 /// @returns 0 if the value is zero.
659 /// @returns the number of set bits.
660 /// @brief Count the number of bits set.
661 uint32_t countPopulation() const;
663 /// @returns the total number of bits.
664 inline uint32_t getBitWidth() const {
668 /// @brief Check if this APInt has a N-bits integer value.
669 inline bool isIntN(uint32_t N) const {
670 assert(N && "N == 0 ???");
671 if (isSingleWord()) {
672 return VAL == (VAL & (~0ULL >> (64 - N)));
674 APInt Tmp(N, getNumWords(), pVal);
675 return Tmp == (*this);
679 /// @returns a byte-swapped representation of this APInt Value.
680 APInt byteSwap() const;
682 /// @returns the floor log base 2 of this APInt.
683 inline uint32_t logBase2() const {
684 return getNumWords() * APINT_BITS_PER_WORD - 1 - countLeadingZeros();
687 /// @brief Converts this APInt to a double value.
688 double roundToDouble(bool isSigned) const;
690 /// @brief Converts this unsigned APInt to a double value.
691 double roundToDouble() const {
692 return roundToDouble(false);
695 /// @brief Converts this signed APInt to a double value.
696 double signedRoundToDouble() const {
697 return roundToDouble(true);
700 /// @brief Compute the square root
704 inline bool operator==(uint64_t V1, const APInt& V2) {
708 inline bool operator!=(uint64_t V1, const APInt& V2) {
714 /// @brief Determine the smaller of two APInts considered to be signed.
715 inline APInt smin(const APInt &A, const APInt &B) {
716 return A.slt(B) ? A : B;
719 /// @brief Determine the larger of two APInts considered to be signed.
720 inline APInt smax(const APInt &A, const APInt &B) {
721 return A.sgt(B) ? A : B;
724 /// @brief Determine the smaller of two APInts considered to be signed.
725 inline APInt umin(const APInt &A, const APInt &B) {
726 return A.ult(B) ? A : B;
729 /// @brief Determine the larger of two APInts considered to be unsigned.
730 inline APInt umax(const APInt &A, const APInt &B) {
731 return A.ugt(B) ? A : B;
734 /// @brief Check if the specified APInt has a N-bits integer value.
735 inline bool isIntN(uint32_t N, const APInt& APIVal) {
736 return APIVal.isIntN(N);
739 /// @returns true if the argument APInt value is a sequence of ones
740 /// starting at the least significant bit with the remainder zero.
741 inline const bool isMask(uint32_t numBits, const APInt& APIVal) {
742 return APIVal.getBoolValue() && ((APIVal + APInt(numBits,1)) & APIVal) == 0;
745 /// @returns true if the argument APInt value contains a sequence of ones
746 /// with the remainder zero.
747 inline const bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
748 return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
751 /// @returns a byte-swapped representation of the specified APInt Value.
752 inline APInt byteSwap(const APInt& APIVal) {
753 return APIVal.byteSwap();
756 /// @returns the floor log base 2 of the specified APInt value.
757 inline uint32_t logBase2(const APInt& APIVal) {
758 return APIVal.logBase2();
761 /// GreatestCommonDivisor - This function returns the greatest common
762 /// divisor of the two APInt values using Enclid's algorithm.
763 /// @returns the greatest common divisor of Val1 and Val2
764 /// @brief Compute GCD of two APInt values.
765 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
767 /// Treats the APInt as an unsigned value for conversion purposes.
768 /// @brief Converts the given APInt to a double value.
769 inline double RoundAPIntToDouble(const APInt& APIVal) {
770 return APIVal.roundToDouble();
773 /// Treats the APInt as a signed value for conversion purposes.
774 /// @brief Converts the given APInt to a double value.
775 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
776 return APIVal.signedRoundToDouble();
779 /// @brief Converts the given APInt to a float vlalue.
780 inline float RoundAPIntToFloat(const APInt& APIVal) {
781 return float(RoundAPIntToDouble(APIVal));
784 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
785 /// @brief Converts the given double value into a APInt.
786 APInt RoundDoubleToAPInt(double Double, uint32_t width = 64);
788 /// RoundFloatToAPInt - Converts a float value into an APInt value.
789 /// @brief Converts a float value into a APInt.
790 inline APInt RoundFloatToAPInt(float Float) {
791 return RoundDoubleToAPInt(double(Float));
794 /// Arithmetic right-shift the APInt by shiftAmt.
795 /// @brief Arithmetic right-shift function.
796 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
797 return LHS.ashr(shiftAmt);
800 /// Logical right-shift the APInt by shiftAmt.
801 /// @brief Logical right-shift function.
802 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
803 return LHS.lshr(shiftAmt);
806 /// Left-shift the APInt by shiftAmt.
807 /// @brief Left-shift function.
808 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
809 return LHS.shl(shiftAmt);
812 /// Signed divide APInt LHS by APInt RHS.
813 /// @brief Signed division function for APInt.
814 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
815 return LHS.sdiv(RHS);
818 /// Unsigned divide APInt LHS by APInt RHS.
819 /// @brief Unsigned division function for APInt.
820 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
821 return LHS.udiv(RHS);
824 /// Signed remainder operation on APInt.
825 /// @brief Function for signed remainder operation.
826 inline APInt srem(const APInt& LHS, const APInt& RHS) {
827 return LHS.srem(RHS);
830 /// Unsigned remainder operation on APInt.
831 /// @brief Function for unsigned remainder operation.
832 inline APInt urem(const APInt& LHS, const APInt& RHS) {
833 return LHS.urem(RHS);
836 /// Performs multiplication on APInt values.
837 /// @brief Function for multiplication operation.
838 inline APInt mul(const APInt& LHS, const APInt& RHS) {
842 /// Performs addition on APInt values.
843 /// @brief Function for addition operation.
844 inline APInt add(const APInt& LHS, const APInt& RHS) {
848 /// Performs subtraction on APInt values.
849 /// @brief Function for subtraction operation.
850 inline APInt sub(const APInt& LHS, const APInt& RHS) {
854 /// Performs bitwise AND operation on APInt LHS and
856 /// @brief Bitwise AND function for APInt.
857 inline APInt And(const APInt& LHS, const APInt& RHS) {
861 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
862 /// @brief Bitwise OR function for APInt.
863 inline APInt Or(const APInt& LHS, const APInt& RHS) {
867 /// Performs bitwise XOR operation on APInt.
868 /// @brief Bitwise XOR function for APInt.
869 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
873 /// Performs a bitwise complement operation on APInt.
874 /// @brief Bitwise complement function.
875 inline APInt Not(const APInt& APIVal) {
879 } // End of APIntOps namespace
881 } // End of llvm namespace