LLVM API Documentation

llvm::ConstantRange Class Reference

#include <ConstantRange.h>

Collaboration diagram for llvm::ConstantRange:
[legend]

List of all members.

Public Member Functions

 ConstantRange (uint32_t BitWidth, bool isFullSet=true)
 ConstantRange (const APInt &Value)
 ConstantRange (const APInt &Lower, const APInt &Upper)
 Initialize a range of values explicitly. This will assert out if Lower==Upper and Lower != Min or Max value for its type. It will also assert out if the two APInt's are not the same bit width.
const APInt & getLower () const
const APInt & getUpper () const
uint32_t getBitWidth () const
bool isFullSet () const
bool isEmptySet () const
bool isWrappedSet () const
bool contains (const APInt &Val) const
bool contains (const ConstantRange &CR) const
const APInt * getSingleElement () const
bool isSingleElement () const
APInt getSetSize () const
APInt getUnsignedMax () const
APInt getUnsignedMin () const
APInt getSignedMax () const
APInt getSignedMin () const
bool operator== (const ConstantRange &CR) const
bool operator!= (const ConstantRange &CR) const
ConstantRange subtract (const APInt &CI) const
ConstantRange intersectWith (const ConstantRange &CR) const
ConstantRange unionWith (const ConstantRange &CR) const
ConstantRange zeroExtend (uint32_t BitWidth) const
ConstantRange signExtend (uint32_t BitWidth) const
ConstantRange truncate (uint32_t BitWidth) const
ConstantRange add (const ConstantRange &Other) const
ConstantRange multiply (const ConstantRange &Other) const
ConstantRange smax (const ConstantRange &Other) const
ConstantRange umax (const ConstantRange &Other) const
ConstantRange udiv (const ConstantRange &Other) const
void print (raw_ostream &OS) const
void dump () const

Static Public Member Functions

static ConstantRange makeICmpRegion (unsigned Pred, const ConstantRange &Other)


Detailed Description

ConstantRange - This class represents an range of values.

Definition at line 42 of file ConstantRange.h.


Constructor & Destructor Documentation

ConstantRange::ConstantRange ( uint32_t  BitWidth,
bool  Full = true 
) [explicit]

Initialize a full (the default) or empty set for the specified bit width.

Initialize a full (the default) or empty set for the specified type.

Definition at line 31 of file ConstantRange.cpp.

References llvm::APInt::getMaxValue(), and llvm::APInt::getMinValue().

Referenced by add(), intersectWith(), makeICmpRegion(), multiply(), signExtend(), smax(), subtract(), truncate(), udiv(), umax(), unionWith(), and zeroExtend().

ConstantRange::ConstantRange ( const APInt &  V  ) 

Initialize a range to hold the single specified value.

Definition at line 40 of file ConstantRange.cpp.

ConstantRange::ConstantRange ( const APInt &  Lower,
const APInt &  Upper 
)

Initialize a range of values explicitly. This will assert out if Lower==Upper and Lower != Min or Max value for its type. It will also assert out if the two APInt's are not the same bit width.

Definition at line 42 of file ConstantRange.cpp.

References llvm::APInt::getBitWidth(), llvm::APInt::isMaxValue(), and llvm::APInt::isMinValue().


Member Function Documentation

ConstantRange ConstantRange::makeICmpRegion ( unsigned  Pred,
const ConstantRange &  Other 
) [static]

makeICmpRegion - Produce the smallest range that contains all values that might satisfy the comparison specified by Pred when compared to any value contained within Other.

Solves for range X in 'for all x in X, there exists a y in Y such that icmp op x, y is true'. Every value that might make the comparison true is included in the resulting range.

Definition at line 50 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getLower(), llvm::APInt::getMinValue(), llvm::APInt::getNullValue(), getSignedMax(), getSignedMin(), llvm::APInt::getSignedMinValue(), getUnsignedMax(), getUnsignedMin(), getUpper(), llvm::CmpInst::ICMP_EQ, llvm::CmpInst::ICMP_NE, llvm::CmpInst::ICMP_SGE, llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::CmpInst::ICMP_ULE, llvm::CmpInst::ICMP_ULT, and isSingleElement().

const APInt& llvm::ConstantRange::getLower (  )  const [inline]

getLower - Return the lower value for this range...

Definition at line 73 of file ConstantRange.h.

Referenced by add(), contains(), llvm::SCEVAddRecExpr::getNumIterationsInRange(), getSignedMax(), getSignedMin(), getUnsignedMin(), makeICmpRegion(), and udiv().

const APInt& llvm::ConstantRange::getUpper (  )  const [inline]

getUpper - Return the upper value for this range...

Definition at line 77 of file ConstantRange.h.

Referenced by add(), contains(), llvm::SCEVAddRecExpr::getNumIterationsInRange(), getSignedMax(), getSignedMin(), getUnsignedMax(), getUnsignedMin(), makeICmpRegion(), and udiv().

uint32_t llvm::ConstantRange::getBitWidth (  )  const [inline]

bool ConstantRange::isFullSet (  )  const

isFullSet - Return true if this set contains all of the elements possible for this data-type

isFullSet - Return true if this set contains all of the elements possible for this data-type

Definition at line 99 of file ConstantRange.cpp.

References llvm::APInt::isMaxValue().

Referenced by add(), contains(), llvm::SCEVAddRecExpr::getNumIterationsInRange(), getUnsignedMax(), getUnsignedMin(), intersectWith(), multiply(), llvm::LoopVR::narrow(), signExtend(), truncate(), udiv(), unionWith(), and zeroExtend().

bool ConstantRange::isEmptySet (  )  const

isEmptySet - Return true if this set contains no members.

Definition at line 105 of file ConstantRange.cpp.

References llvm::APInt::isMinValue().

Referenced by add(), contains(), getSetSize(), intersectWith(), llvm::ScalarEvolution::isKnownPredicate(), multiply(), smax(), udiv(), umax(), and unionWith().

bool ConstantRange::isWrappedSet (  )  const

isWrappedSet - Return true if this set wraps around the top of the range, for example: [100, 8)

isWrappedSet - Return true if this set wraps around the top of the range, for example: [100, 8)

Definition at line 112 of file ConstantRange.cpp.

References llvm::APInt::ugt().

Referenced by contains(), getSignedMax(), getSignedMin(), getUnsignedMax(), getUnsignedMin(), intersectWith(), and unionWith().

bool ConstantRange::contains ( const APInt &  V  )  const

contains - Return true if the specified value is in the set.

Definition at line 193 of file ConstantRange.cpp.

References isFullSet(), isWrappedSet(), llvm::APInt::ule(), and llvm::APInt::ult().

Referenced by llvm::SCEVAddRecExpr::getNumIterationsInRange().

bool ConstantRange::contains ( const ConstantRange &  Other  )  const

contains - Return true if the other range is a subset of this one.

contains - Return true if the argument is a subset of this range. Two equal set contain each other. The empty set is considered to be contained by all other sets.

Definition at line 207 of file ConstantRange.cpp.

References getLower(), getUpper(), isEmptySet(), isFullSet(), isWrappedSet(), and llvm::APInt::ule().

const APInt* llvm::ConstantRange::getSingleElement (  )  const [inline]

getSingleElement - If this set contains a single element, return it, otherwise return null.

Definition at line 108 of file ConstantRange.h.

Referenced by isSingleElement().

bool llvm::ConstantRange::isSingleElement (  )  const [inline]

isSingleElement - Return true if this set contains exactly one member.

Definition at line 116 of file ConstantRange.h.

References getSingleElement().

Referenced by makeICmpRegion().

APInt ConstantRange::getSetSize (  )  const

getSetSize - Return the number of elements in this set.

Definition at line 118 of file ConstantRange.cpp.

References getBitWidth(), and isEmptySet().

Referenced by add(), intersectWith(), and truncate().

APInt ConstantRange::getUnsignedMax (  )  const

getUnsignedMax - Return the largest unsigned value contained in the ConstantRange.

getUnsignedMax - Return the largest unsigned value contained in the ConstantRange.

Definition at line 134 of file ConstantRange.cpp.

References getBitWidth(), llvm::APInt::getMaxValue(), getUpper(), isFullSet(), and isWrappedSet().

Referenced by llvm::ScalarEvolution::getUnsignedRange(), llvm::ScalarEvolution::isKnownPredicate(), makeICmpRegion(), multiply(), udiv(), and umax().

APInt ConstantRange::getUnsignedMin (  )  const

getUnsignedMin - Return the smallest unsigned value contained in the ConstantRange.

getUnsignedMin - Return the smallest unsigned value contained in the ConstantRange.

Definition at line 144 of file ConstantRange.cpp.

References getBitWidth(), getLower(), llvm::APInt::getMinValue(), getUpper(), isFullSet(), and isWrappedSet().

Referenced by llvm::ScalarEvolution::getUnsignedRange(), llvm::ScalarEvolution::isKnownPredicate(), makeICmpRegion(), multiply(), udiv(), and umax().

APInt ConstantRange::getSignedMax (  )  const

getSignedMax - Return the largest signed value contained in the ConstantRange.

getSignedMax - Return the largest signed value contained in the ConstantRange.

Definition at line 154 of file ConstantRange.cpp.

References getBitWidth(), getLower(), llvm::APInt::getSignedMaxValue(), getUpper(), and isWrappedSet().

Referenced by llvm::ScalarEvolution::getSignedRange(), llvm::ScalarEvolution::isKnownNegative(), llvm::ScalarEvolution::isKnownNonPositive(), llvm::ScalarEvolution::isKnownPredicate(), makeICmpRegion(), and smax().

APInt ConstantRange::getSignedMin (  )  const

getSignedMin - Return the smallest signed value contained in the ConstantRange.

getSignedMin - Return the smallest signed value contained in the ConstantRange.

Definition at line 172 of file ConstantRange.cpp.

References getBitWidth(), getLower(), llvm::APInt::getSignedMinValue(), getUpper(), and isWrappedSet().

Referenced by llvm::ScalarEvolution::getSignedRange(), llvm::ScalarEvolution::isKnownNonNegative(), llvm::ScalarEvolution::isKnownPositive(), llvm::ScalarEvolution::isKnownPredicate(), makeICmpRegion(), and smax().

bool llvm::ConstantRange::operator== ( const ConstantRange &  CR  )  const [inline]

operator== - Return true if this range is equal to another range.

Definition at line 144 of file ConstantRange.h.

References Lower, and Upper.

Referenced by operator!=().

bool llvm::ConstantRange::operator!= ( const ConstantRange &  CR  )  const [inline]

Definition at line 147 of file ConstantRange.h.

References operator==().

ConstantRange ConstantRange::subtract ( const APInt &  Val  )  const

subtract - Subtract the specified constant from the endpoints of this constant range.

subtract - Subtract the specified constant from the endpoints of this constant range.

Definition at line 229 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), and llvm::APInt::getBitWidth().

Referenced by llvm::SCEVAddRecExpr::getNumIterationsInRange().

ConstantRange ConstantRange::intersectWith ( const ConstantRange &  CR  )  const

intersectWith - Return the range that results from the intersection of this range with another range. The resultant range is guaranteed to include all elements contained in both input ranges, and to have the smallest possible set size that does so. Because there may be two intersections with the same set size, A.intersectWith(B) might not be equal to B.intersectWith(A).

intersectWith - Return the range that results from the intersection of this range with another range. The resultant range is guaranteed to include all elements contained in both input ranges, and to have the smallest possible set size that does so. Because there may be two intersections with the same set size, A.intersectWith(B) might not be equal to B.intersectWith(A).

Definition at line 282 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getSetSize(), intersectWith(), isEmptySet(), isFullSet(), isWrappedSet(), Lower, llvm::APInt::ule(), llvm::APInt::ult(), and Upper.

Referenced by intersectWith(), and llvm::ScalarEvolution::isKnownPredicate().

ConstantRange ConstantRange::unionWith ( const ConstantRange &  CR  )  const

unionWith - Return the range that results from the union of this range with another range. The resultant range is guaranteed to include the elements of both sets, but may contain more. For example, [3, 9) union [12,15) is [3, 15), which includes 9, 10, and 11, which were not included in either set before.

unionWith - Return the range that results from the union of this range with another range. The resultant range is guaranteed to include the elements of both sets, but may contain more. For example, [3, 9) union [12,15) is [3, 15), which includes 9, 10, and 11, which were not included in either set before.

Definition at line 365 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), if(), isEmptySet(), isFullSet(), isWrappedSet(), L, Lower, llvm::APInt::uge(), llvm::APInt::ugt(), llvm::APInt::ule(), llvm::APInt::ult(), unionWith(), and Upper.

Referenced by unionWith().

ConstantRange ConstantRange::zeroExtend ( uint32_t  DstTySize  )  const

zeroExtend - Return a new range in the specified integer type, which must be strictly larger than the current type. The returned range will correspond to the possible range of values if the source range had been zero extended to BitWidth.

zeroExtend - Return a new range in the specified integer type, which must be strictly larger than the current type. The returned range will correspond to the possible range of values as if the source range had been zero extended.

Definition at line 450 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), isFullSet(), L, llvm::APIntOps::shl(), and llvm::APInt::zext().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::signExtend ( uint32_t  DstTySize  )  const

signExtend - Return a new range in the specified integer type, which must be strictly larger than the current type. The returned range will correspond to the possible range of values if the source range had been sign extended to BitWidth.

signExtend - Return a new range in the specified integer type, which must be strictly larger than the current type. The returned range will correspond to the possible range of values as if the source range had been sign extended.

Definition at line 466 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), llvm::APInt::getHighBitsSet(), llvm::APInt::getLowBitsSet(), isFullSet(), L, and llvm::APInt::sext().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::truncate ( uint32_t  DstTySize  )  const

truncate - Return a new range in the specified integer type, which must be strictly smaller than the current type. The returned range will correspond to the possible range of values if the source range had been truncated to the specified type.

truncate - Return a new range in the specified integer type, which must be strictly smaller than the current type. The returned range will correspond to the possible range of values as if the source range had been truncated to the specified type.

Definition at line 483 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), llvm::APInt::getLowBitsSet(), getSetSize(), isFullSet(), L, and llvm::APInt::trunc().

Referenced by llvm::ScalarEvolution::getSignedRange(), llvm::ScalarEvolution::getUnsignedRange(), and multiply().

ConstantRange ConstantRange::add ( const ConstantRange &  Other  )  const

add - Return a new range representing the possible values resulting from an addition of a value in this range and a value in Other.

Definition at line 496 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getLower(), getSetSize(), getUpper(), isEmptySet(), isFullSet(), llvm::APInt::ult(), and llvm::X.

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::multiply ( const ConstantRange &  Other  )  const

multiply - Return a new range representing the possible values resulting from a multiplication of a value in this range and a value in Other. TODO: This isn't fully implemented yet.

Definition at line 517 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getUnsignedMax(), getUnsignedMin(), isEmptySet(), isFullSet(), truncate(), and llvm::APInt::zext().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::smax ( const ConstantRange &  Other  )  const

smax - Return a new range representing the possible values resulting from a signed maximum of a value in this range and a value in Other.

Definition at line 534 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getSignedMax(), getSignedMin(), isEmptySet(), and llvm::APIntOps::smax().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::umax ( const ConstantRange &  Other  )  const

umax - Return a new range representing the possible values resulting from an unsigned maximum of a value in this range and a value in Other.

Definition at line 547 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getUnsignedMax(), getUnsignedMin(), isEmptySet(), and llvm::APIntOps::umax().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

ConstantRange ConstantRange::udiv ( const ConstantRange &  Other  )  const

udiv - Return a new range representing the possible values resulting from an unsigned division of a value in this range and a value in Other. TODO: This isn't fully implemented yet.

Definition at line 560 of file ConstantRange.cpp.

References ConstantRange(), getBitWidth(), getLower(), getUnsignedMax(), getUnsignedMin(), getUpper(), isEmptySet(), isFullSet(), and llvm::APInt::udiv().

Referenced by llvm::ScalarEvolution::getSignedRange(), and llvm::ScalarEvolution::getUnsignedRange().

void ConstantRange::print ( raw_ostream &  OS  )  const

print - Print out the bounds to a stream...

Definition at line 590 of file ConstantRange.cpp.

Referenced by dump(), and llvm::operator<<().

void ConstantRange::dump (  )  const

dump - Allow printing from a debugger easily...

Definition at line 596 of file ConstantRange.cpp.

References llvm::errs(), and print().


The documentation for this class was generated from the following files: