LLVM  3.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::ICmpInst Class Reference

This instruction compares its operands according to the predicate given to the constructor. More...

#include <Instructions.h>

Inheritance diagram for llvm::ICmpInst:
[legend]
Collaboration diagram for llvm::ICmpInst:
[legend]

Public Member Functions

 ICmpInst (Instruction *InsertBefore, Predicate pred, Value *LHS, Value *RHS, const Twine &NameStr="")
 Constructor with insert-before-instruction semantics. More...
 
 ICmpInst (BasicBlock &InsertAtEnd, Predicate pred, Value *LHS, Value *RHS, const Twine &NameStr="")
 Constructor with insert-at-end semantics. More...
 
 ICmpInst (Predicate pred, Value *LHS, Value *RHS, const Twine &NameStr="")
 Constructor with no-insertion semantics. More...
 
Predicate getSignedPredicate () const
 For example, EQ->EQ, SLE->SLE, UGT->SGT, etc. More...
 
Predicate getUnsignedPredicate () const
 For example, EQ->EQ, SLE->ULE, UGT->UGT, etc. More...
 
bool isEquality () const
 isEquality - Return true if this predicate is either EQ or NE. More...
 
bool isCommutative () const
 Determine if this relation is commutative. More...
 
bool isRelational () const
 isRelational - Return true if the predicate is relational (not EQ or NE). More...
 
void swapOperands ()
 Exchange the two operands to this instruction in such a way that it does not modify the semantics of the instruction. More...
 
- Public Member Functions inherited from llvm::CmpInst
void * operator new (size_t s)
 
OtherOps getOpcode () const
 Get the opcode casted to the right type. More...
 
Predicate getPredicate () const
 Return the predicate for this instruction. More...
 
void setPredicate (Predicate P)
 Set the predicate for this instruction to the specified value. More...
 
bool isFPPredicate () const
 
bool isIntPredicate () const
 
Predicate getInversePredicate () const
 For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc. More...
 
Predicate getSwappedPredicate () const
 For example, EQ->EQ, SLE->SGE, ULT->UGT, OEQ->OEQ, ULE->UGE, OLT->OGT, etc. More...
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 Provide more efficient getOperand methods. More...
 
void swapOperands ()
 This is just a convenience that dispatches to the subclasses. More...
 
bool isCommutative () const
 This is just a convenience that dispatches to the subclasses. More...
 
bool isEquality () const
 This is just a convenience that dispatches to the subclasses. More...
 
bool isSigned () const
 Determine if this instruction is using a signed comparison. More...
 
bool isUnsigned () const
 Determine if this instruction is using an unsigned comparison. More...
 
bool isTrueWhenEqual () const
 This is just a convenience. More...
 
bool isFalseWhenEqual () const
 This is just a convenience. More...
 
- Public Member Functions inherited from llvm::Instruction
 ~Instruction () override
 
Instructionuser_back ()
 user_back - Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions. More...
 
const Instructionuser_back () const
 
const BasicBlockgetParent () const
 
BasicBlockgetParent ()
 
const ModulegetModule () const
 Return the module owning the function this instruction belongs to or nullptr it the function does not have a module. More...
 
ModulegetModule ()
 
void removeFromParent ()
 removeFromParent - This method unlinks 'this' from the containing basic block, but does not delete it. More...
 
iplist< Instruction >::iterator eraseFromParent ()
 eraseFromParent - This method unlinks 'this' from the containing basic block and deletes it. More...
 
void insertBefore (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction. More...
 
void insertAfter (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately after the specified instruction. More...
 
void moveBefore (Instruction *MovePos)
 moveBefore - Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos. More...
 
unsigned getOpcode () const
 getOpcode() returns a member of one of the enums like Instruction::Add. More...
 
const char * getOpcodeName () const
 
bool isTerminator () const
 
bool isBinaryOp () const
 
bool isShift ()
 
bool isCast () const
 
bool isLogicalShift () const
 isLogicalShift - Return true if this is a logical shift left or a logical shift right. More...
 
bool isArithmeticShift () const
 isArithmeticShift - Return true if this is an arithmetic shift right. More...
 
bool hasMetadata () const
 hasMetadata() - Return true if this instruction has any metadata attached to it. More...
 
bool hasMetadataOtherThanDebugLoc () const
 hasMetadataOtherThanDebugLoc - Return true if this instruction has metadata attached to it other than a debug location. More...
 
MDNodegetMetadata (unsigned KindID) const
 getMetadata - Get the metadata of given kind attached to this Instruction. More...
 
MDNodegetMetadata (StringRef Kind) const
 getMetadata - Get the metadata of given kind attached to this Instruction. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 getAllMetadata - Get all metadata attached to this Instruction. More...
 
void getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 getAllMetadataOtherThanDebugLoc - This does the same thing as getAllMetadata, except that it filters out the debug location. More...
 
void getAAMetadata (AAMDNodes &N, bool Merge=false) const
 getAAMetadata - Fills the AAMDNodes structure with AA metadata from this instruction. More...
 
void setMetadata (unsigned KindID, MDNode *Node)
 setMetadata - Set the metadata of the specified kind to the specified node. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void dropUnknownMetadata (ArrayRef< unsigned > KnownIDs)
 Drop unknown metadata. More...
 
void dropUnknownMetadata ()
 
void dropUnknownMetadata (unsigned ID1)
 
void dropUnknownMetadata (unsigned ID1, unsigned ID2)
 
void setAAMetadata (const AAMDNodes &N)
 setAAMetadata - Sets the metadata on this instruction from the AAMDNodes structure. More...
 
void setDebugLoc (DebugLoc Loc)
 setDebugLoc - Set the debug location information for this instruction. More...
 
const DebugLocgetDebugLoc () const
 getDebugLoc - Return the debug location for this node as a DebugLoc. More...
 
void setHasUnsafeAlgebra (bool B)
 Set or clear the unsafe-algebra flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag. More...
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags. More...
 
void copyFastMathFlags (FastMathFlags FMF)
 Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags. More...
 
bool hasUnsafeAlgebra () const
 Determine whether the unsafe-algebra flag is set. More...
 
bool hasNoNaNs () const
 Determine whether the no-NaNs flag is set. More...
 
bool hasNoInfs () const
 Determine whether the no-infs flag is set. More...
 
bool hasNoSignedZeros () const
 Determine whether the no-signed-zeros flag is set. More...
 
bool hasAllowReciprocal () const
 Determine whether the allow-reciprocal flag is set. More...
 
FastMathFlags getFastMathFlags () const
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags. More...
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags. More...
 
bool isAssociative () const
 isAssociative - Return true if the instruction is associative: More...
 
bool isCommutative () const
 isCommutative - Return true if the instruction is commutative: More...
 
bool isIdempotent () const
 isIdempotent - Return true if the instruction is idempotent: More...
 
bool isNilpotent () const
 isNilpotent - Return true if the instruction is nilpotent: More...
 
bool mayWriteToMemory () const
 mayWriteToMemory - Return true if this instruction may modify memory. More...
 
bool mayReadFromMemory () const
 mayReadFromMemory - Return true if this instruction may read memory. More...
 
bool mayReadOrWriteMemory () const
 mayReadOrWriteMemory - Return true if this instruction may read or write memory. More...
 
bool isAtomic () const
 isAtomic - Return true if this instruction has an AtomicOrdering of unordered or higher. More...
 
bool mayThrow () const
 mayThrow - Return true if this instruction may throw an exception. More...
 
bool mayReturn () const
 mayReturn - Return true if this is a function that may return. More...
 
bool mayHaveSideEffects () const
 mayHaveSideEffects - Return true if the instruction may have side effects. More...
 
Instructionclone () const
 clone() - Create a copy of 'this' instruction that is identical in all ways except the following: More...
 
bool isIdenticalTo (const Instruction *I) const
 isIdenticalTo - Return true if the specified instruction is exactly identical to the current one. More...
 
bool isIdenticalToWhenDefined (const Instruction *I) const
 isIdenticalToWhenDefined - This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which specify conditions under which the instruction's result is undefined. More...
 
bool isSameOperationAs (const Instruction *I, unsigned flags=0) const
 This function determines if the specified instruction executes the same operation as the current one. More...
 
bool isUsedOutsideOfBlock (const BasicBlock *BB) const
 isUsedOutsideOfBlock - Return true if there are any uses of this instruction in blocks other than the specified block. More...
 
- Public Member Functions inherited from llvm::User
 ~User () override
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *, unsigned)
 Placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Placement delete - required by std, but never called. More...
 
UsegetOperandList ()
 
const UsegetOperandList () const
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setFunctionNumOperands (unsigned NumOps)
 Set the number of operands on a Function. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
virtual ~Value ()
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
bool use_empty () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratoruses ()
 
iterator_range
< const_use_iterator
uses () const
 
bool user_empty () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratorusers ()
 
iterator_range
< const_user_iterator
users () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
void intersectOptionalDataWith (const Value *V)
 Clear any optional flags not set in the given Value. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
ValuestripPointerCasts ()
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
const ValuestripPointerCasts () const
 
ValuestripPointerCastsNoFollowAliases ()
 Strip off pointer casts and all-zero GEPs. More...
 
const ValuestripPointerCastsNoFollowAliases () const
 
ValuestripInBoundsConstantOffsets ()
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
const ValuestripInBoundsConstantOffsets () const
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 
ValuestripInBoundsOffsets ()
 Strip off pointer casts and inbounds GEPs. More...
 
const ValuestripInBoundsOffsets () const
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 Translate PHI node to its predecessor from the given basic block. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node< Instruction >
InstructiongetPrevNode ()
 Get the previous node, or 0 for the list head. More...
 
const InstructiongetPrevNode () const
 Get the previous node, or 0 for the list head. More...
 
InstructiongetNextNode ()
 Get the next node, or 0 for the list tail. More...
 
const InstructiongetNextNode () const
 Get the next node, or 0 for the list tail. More...
 

Static Public Member Functions

static Predicate getSignedPredicate (Predicate pred)
 This is a static version that you can use without an instruction. More...
 
static Predicate getUnsignedPredicate (Predicate pred)
 This is a static version that you can use without an instruction. More...
 
static bool isEquality (Predicate P)
 isEquality - Return true if this predicate is either EQ or NE. More...
 
static bool isRelational (Predicate P)
 isRelational - Return true if the predicate is relational (not EQ or NE). More...
 
static ConstantRange makeConstantRange (Predicate pred, const APInt &C)
 Initialize a set of values that all satisfy the predicate with C. More...
 
static bool classof (const Instruction *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::CmpInst
static CmpInstCreate (OtherOps Op, unsigned short predicate, Value *S1, Value *S2, const Twine &Name="", Instruction *InsertBefore=nullptr)
 Construct a compare instruction, given the opcode, the predicate and the two operands. More...
 
static CmpInstCreate (OtherOps Op, unsigned short predicate, Value *S1, Value *S2, const Twine &Name, BasicBlock *InsertAtEnd)
 Construct a compare instruction, given the opcode, the predicate and the two operands. More...
 
static bool isFPPredicate (Predicate P)
 
static bool isIntPredicate (Predicate P)
 
static Predicate getInversePredicate (Predicate pred)
 For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc. More...
 
static Predicate getSwappedPredicate (Predicate pred)
 This is a static version that you can use without an instruction available. More...
 
static bool isUnsigned (unsigned short predicate)
 Determine if the predicate is an unsigned operation. More...
 
static bool isSigned (unsigned short predicate)
 Determine if the predicate is an signed operation. More...
 
static bool isOrdered (unsigned short predicate)
 Determine if the predicate is an ordered operation. More...
 
static bool isUnordered (unsigned short predicate)
 Determine if the predicate is an unordered operation. More...
 
static bool isTrueWhenEqual (unsigned short predicate)
 Determine if the predicate is true when comparing a value with itself. More...
 
static bool isFalseWhenEqual (unsigned short predicate)
 Determine if the predicate is false when comparing a value with itself. More...
 
static bool classof (const Instruction *I)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const Value *V)
 
static TypemakeCmpResultType (Type *opnd_type)
 Create a result type for fcmp/icmp. More...
 
- Static Public Member Functions inherited from llvm::Instruction
static const char * getOpcodeName (unsigned OpCode)
 
static bool isTerminator (unsigned OpCode)
 
static bool isBinaryOp (unsigned Opcode)
 
static bool isShift (unsigned Opcode)
 Determine if the Opcode is one of the shift instructions. More...
 
static bool isCast (unsigned OpCode)
 Determine if the OpCode is one of the CastInst instructions. More...
 
static bool isAssociative (unsigned op)
 isAssociative - Return true if the instruction is associative: More...
 
static bool isCommutative (unsigned op)
 isCommutative - Return true if the instruction is commutative: More...
 
static bool isIdempotent (unsigned op)
 isIdempotent - Return true if the instruction is idempotent: More...
 
static bool isNilpotent (unsigned op)
 isNilpotent - Return true if the instruction is nilpotent: More...
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Protected Member Functions

ICmpInstcloneImpl () const
 Clone an identical ICmpInst. More...
 
- Protected Member Functions inherited from llvm::CmpInst
 CmpInst (Type *ty, Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS, const Twine &Name="", Instruction *InsertBefore=nullptr)
 
 CmpInst (Type *ty, Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS, const Twine &Name, BasicBlock *InsertAtEnd)
 
void anchor () override
 
- Protected Member Functions inherited from llvm::Instruction
void setInstructionSubclassData (unsigned short D)
 
unsigned getSubclassDataFromInstruction () const
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, Instruction *InsertBefore=nullptr)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, BasicBlock *InsertAtEnd)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node< Instruction >
 ilist_node ()
 

Friends

class Instruction
 

Additional Inherited Members

- Public Types inherited from llvm::CmpInst
enum  Predicate {
  FCMP_FALSE = 0, FCMP_OEQ = 1, FCMP_OGT = 2, FCMP_OGE = 3,
  FCMP_OLT = 4, FCMP_OLE = 5, FCMP_ONE = 6, FCMP_ORD = 7,
  FCMP_UNO = 8, FCMP_UEQ = 9, FCMP_UGT = 10, FCMP_UGE = 11,
  FCMP_ULT = 12, FCMP_ULE = 13, FCMP_UNE = 14, FCMP_TRUE = 15,
  FIRST_FCMP_PREDICATE = FCMP_FALSE, LAST_FCMP_PREDICATE = FCMP_TRUE, BAD_FCMP_PREDICATE = FCMP_TRUE + 1, ICMP_EQ = 32,
  ICMP_NE = 33, ICMP_UGT = 34, ICMP_UGE = 35, ICMP_ULT = 36,
  ICMP_ULE = 37, ICMP_SGT = 38, ICMP_SGE = 39, ICMP_SLT = 40,
  ICMP_SLE = 41, FIRST_ICMP_PREDICATE = ICMP_EQ, LAST_ICMP_PREDICATE = ICMP_SLE, BAD_ICMP_PREDICATE = ICMP_SLE + 1
}
 This enumeration lists the possible predicates for CmpInst subclasses. More...
 
- Public Types inherited from llvm::Instruction
enum  OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0, CompareUsingScalarTypes = 1<<1 }
 When checking for operation equivalence (using isSameOperationAs) it is sometimes useful to ignore certain attributes. More...
 
enum  TermOps
 
enum  BinaryOps
 
enum  MemoryOps
 
enum  CastOps
 
enum  OtherOps
 
- Public Types inherited from llvm::User
typedef Useop_iterator
 
typedef const Useconst_op_iterator
 
typedef iterator_range
< op_iterator
op_range
 
typedef iterator_range
< const_op_iterator
const_op_range
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
typedef use_iterator_impl< Useuse_iterator
 
typedef use_iterator_impl
< const Use
const_use_iterator
 
typedef user_iterator_impl< Useruser_iterator
 
typedef user_iterator_impl
< const User
const_user_iterator
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 29 }
 The number of operands in the subclass. More...
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
bool IsUsedByMD: 1
 
bool HasName: 1
 
bool HasHungOffUses: 1
 

Detailed Description

This instruction compares its operands according to the predicate given to the constructor.

It only operates on integers or pointers. The operands must be identical types. Represent an integer comparison operator.

Definition at line 1093 of file Instructions.h.

Constructor & Destructor Documentation

llvm::ICmpInst::ICmpInst ( Instruction InsertBefore,
Predicate  pred,
Value LHS,
Value RHS,
const Twine NameStr = "" 
)
inline

Constructor with insert-before-instruction semantics.

Parameters
InsertBeforeWhere to insert
predThe predicate to use for the comparison
LHSThe left-hand-side of the expression
RHSThe right-hand-side of the expression
NameStrName of the instruction

Definition at line 1114 of file Instructions.h.

Referenced by cloneImpl().

llvm::ICmpInst::ICmpInst ( BasicBlock InsertAtEnd,
Predicate  pred,
Value LHS,
Value RHS,
const Twine NameStr = "" 
)
inline

Constructor with insert-at-end semantics.

Parameters
InsertAtEndBlock to insert into.
predThe predicate to use for the comparison
LHSThe left-hand-side of the expression
RHSThe right-hand-side of the expression
NameStrName of the instruction

Definition at line 1129 of file Instructions.h.

llvm::ICmpInst::ICmpInst ( Predicate  pred,
Value LHS,
Value RHS,
const Twine NameStr = "" 
)
inline

Constructor with no-insertion semantics.

Parameters
predThe predicate to use for the comparison
LHSThe left-hand-side of the expression
RHSThe right-hand-side of the expression
NameStrName of the instruction

Definition at line 1144 of file Instructions.h.

Member Function Documentation

static bool llvm::ICmpInst::classof ( const Instruction I)
inlinestatic

Definition at line 1223 of file Instructions.h.

References llvm::Instruction::getOpcode().

static bool llvm::ICmpInst::classof ( const Value V)
inlinestatic

Definition at line 1226 of file Instructions.h.

ICmpInst * ICmpInst::cloneImpl ( ) const
protected

Clone an identical ICmpInst.

Definition at line 3467 of file Instructions.cpp.

References llvm::CmpInst::getPredicate(), and ICmpInst().

Predicate llvm::ICmpInst::getSignedPredicate ( ) const
inline

For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.

Returns
the predicate that would be the result if the operand were regarded as signed. Return the signed version of the predicate

Definition at line 1160 of file Instructions.h.

Referenced by computePointerICmp(), llvm::InstCombiner::FoldGEPICmp(), SimplifyICmpInst(), llvm::InstCombiner::visitICmpInst(), and llvm::InstCombiner::visitICmpInstWithInstAndIntCst().

ICmpInst::Predicate ICmpInst::getSignedPredicate ( Predicate  pred)
static

This is a static version that you can use without an instruction.

Return the signed version of the predicate.

Definition at line 3080 of file Instructions.cpp.

References 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, llvm_unreachable, and pred.

Predicate llvm::ICmpInst::getUnsignedPredicate ( ) const
inline

For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.

Returns
the predicate that would be the result if the operand were regarded as unsigned. Return the unsigned version of the predicate

Definition at line 1172 of file Instructions.h.

Referenced by SimplifyICmpInst(), llvm::InstCombiner::visitICmpInst(), llvm::InstCombiner::visitICmpInstWithCastAndCast(), and llvm::InstCombiner::visitICmpInstWithInstAndIntCst().

ICmpInst::Predicate ICmpInst::getUnsignedPredicate ( Predicate  pred)
static

This is a static version that you can use without an instruction.

Return the unsigned version of the predicate.

Definition at line 3093 of file Instructions.cpp.

References 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, llvm_unreachable, and pred.

bool llvm::ICmpInst::isCommutative ( ) const
inline

Determine if this relation is commutative.

Returns
true if the predicate of this ICmpInst is commutative

Definition at line 1194 of file Instructions.h.

static bool llvm::ICmpInst::isEquality ( Predicate  P)
inlinestatic
bool llvm::ICmpInst::isEquality ( ) const
inline
bool llvm::ICmpInst::isRelational ( ) const
inline

isRelational - Return true if the predicate is relational (not EQ or NE).

Definition at line 1198 of file Instructions.h.

Referenced by isSignTest().

static bool llvm::ICmpInst::isRelational ( Predicate  P)
inlinestatic

isRelational - Return true if the predicate is relational (not EQ or NE).

Definition at line 1204 of file Instructions.h.

ConstantRange ICmpInst::makeConstantRange ( Predicate  pred,
const APInt C 
)
static
void llvm::ICmpInst::swapOperands ( )
inline

Exchange the two operands to this instruction in such a way that it does not modify the semantics of the instruction.

The predicate value may be changed to retain the same result if the predicate is order dependent (e.g. ult). Swap operands and adjust predicate.

Definition at line 1217 of file Instructions.h.

References llvm::PPC::getSwappedPredicate(), and std::swap().

Referenced by llvm::InstCombiner::FoldAndOfICmps(), llvm::InstCombiner::FoldOrOfICmps(), and llvm::InstCombiner::visitICmpInst().

Friends And Related Function Documentation

friend class Instruction
friend

Definition at line 1108 of file Instructions.h.


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