Represents a floating point comparison operator. More...

#include <Instructions.h>

Inheritance diagram for llvm::FCmpInst:

Collaboration diagram for llvm::FCmpInst:

Public Member Functions
	FCmpInst (Instruction InsertBefore, Predicate pred, Value LHS, Value *RHS, const Twine &NameStr="")
	Constructor with insert-before-instruction semantics. More...

	FCmpInst (BasicBlock &InsertAtEnd, Predicate pred, Value LHS, Value RHS, const Twine &NameStr="")
	Constructor with insert-at-end semantics. More...

	FCmpInst (Predicate pred, Value LHS, Value RHS, const Twine &NameStr="")
	Constructor with no-insertion semantics. More...

bool	isEquality () const
	Determine if this is an equality predicate. More...

bool	isCommutative () const
	Determine if this is a commutative predicate. More...

bool	isRelational () const
	Determine if this a relational predicate. More...

void	swapOperands ()
	Swap operands and adjust predicate. 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
	Return the inverse of the instruction's predicate. More...

Predicate	getSwappedPredicate () const
	Return the predicate as if the operands were swapped. More...

	DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
	Provide more efficient getOperand methods. More...

void	swapOperands ()
	Swap the operands and adjust predicate accordingly to retain the same comparison. More...

bool	isCommutative () const
	Determine if this CmpInst is commutative. More...

bool	isEquality () const
	Determine if this is an equals/not equals predicate. 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
	Determine if this is true when both operands are the same. More...

bool	isFalseWhenEqual () const
	Determine if this is false when both operands are the same. More...

Public Member Functions inherited from llvm::Instruction
	~Instruction ()

Instruction *	use_back ()

const Instruction *	use_back () const

const BasicBlock *	getParent () const

BasicBlock *	getParent ()

void	removeFromParent ()

void	eraseFromParent ()

void	insertBefore (Instruction *InsertPos)

void	insertAfter (Instruction *InsertPos)

void	moveBefore (Instruction *MovePos)

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

bool	isArithmeticShift () const
	isArithmeticShift - Return true if this is an arithmetic shift right. More...

bool	hasMetadata () const

bool	hasMetadataOtherThanDebugLoc () const

MDNode *	getMetadata (unsigned KindID) const

MDNode *	getMetadata (StringRef Kind) const

void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const

void	getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const

void	setMetadata (unsigned KindID, MDNode *Node)

void	setMetadata (StringRef Kind, MDNode *Node)

void	setDebugLoc (const DebugLoc &Loc)
	setDebugLoc - Set the debug location information for this instruction. More...

const DebugLoc &	getDebugLoc () const
	getDebugLoc - Return the debug location for this node as a DebugLoc. More...

void	setHasUnsafeAlgebra (bool B)

void	setHasNoNaNs (bool B)

void	setHasNoInfs (bool B)

void	setHasNoSignedZeros (bool B)

void	setHasAllowReciprocal (bool B)

void	setFastMathFlags (FastMathFlags FMF)

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

void	copyFastMathFlags (const Instruction *I)
	Copy I's fast-math flags. More...

bool	isAssociative () const

bool	isCommutative () const

bool	isIdempotent () const

bool	isNilpotent () const

bool	mayWriteToMemory () const

bool	mayReadFromMemory () const

bool	mayReadOrWriteMemory () const

bool	mayThrow () const

bool	mayReturn () const

bool	mayHaveSideEffects () const

Instruction *	clone () const

bool	isIdenticalTo (const Instruction *I) const

bool	isIdenticalToWhenDefined (const Instruction *I) const

bool	isSameOperationAs (const Instruction *I, unsigned flags=0) const
	Determine if one instruction is the same operation as another. More...

bool	isUsedOutsideOfBlock (const BasicBlock *BB) const

Public Member Functions inherited from llvm::User
	~User ()

void	operator delete (void *Usr)
	operator delete - 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...

Value *	getOperand (unsigned i) const

void	setOperand (unsigned i, Value *Val)

const Use &	getOperandUse (unsigned i) const

Use &	getOperandUse (unsigned i)

unsigned	getNumOperands () const

op_iterator	op_begin ()

const_op_iterator	op_begin () const

op_iterator	op_end ()

const_op_iterator	op_end () const

value_op_iterator	value_op_begin ()

value_op_iterator	value_op_end ()

void	dropAllReferences ()

void	replaceUsesOfWith (Value From, Value To)

Public Member Functions inherited from llvm::Value
virtual	~Value ()

void	dump () const
	dump - Support for debugging, callable in GDB: V->dump() More...

void	print (raw_ostream &O, AssemblyAnnotationWriter *AAW=0) const

Type *	getType () const

LLVMContext &	getContext () const
	All values hold a context through their type. More...

bool	hasName () const

ValueName *	getValueName () const

void	setValueName (ValueName *VN)

StringRef	getName () const

void	setName (const Twine &Name)

void	takeName (Value *V)

void	replaceAllUsesWith (Value *V)

bool	use_empty () const

use_iterator	use_begin ()

const_use_iterator	use_begin () const

use_iterator	use_end ()

const_use_iterator	use_end () const

User *	use_back ()

const User *	use_back () const

bool	hasOneUse () const

bool	hasNUses (unsigned N) const

bool	hasNUsesOrMore (unsigned N) const

bool	isUsedInBasicBlock (const BasicBlock *BB) const

unsigned	getNumUses () const

void	addUse (Use &U)

unsigned	getValueID () const

unsigned	getRawSubclassOptionalData () const

void	clearSubclassOptionalData ()

bool	hasSameSubclassOptionalData (const Value *V) const

void	intersectOptionalDataWith (const Value *V)

bool	hasValueHandle () const

Value *	stripPointerCasts ()
	Strips off any unneeded pointer casts, all-zero GEPs and aliases from the specified value, returning the original uncasted value. More...

const Value *	stripPointerCasts () const

Value *	stripPointerCastsNoFollowAliases ()
	Strips off any unneeded pointer casts and all-zero GEPs from the specified value, returning the original uncasted value. More...

const Value *	stripPointerCastsNoFollowAliases () const

Value *	stripInBoundsConstantOffsets ()
	Strips off unneeded pointer casts and all-constant GEPs from the specified value, returning the original pointer value. More...

const Value *	stripInBoundsConstantOffsets () const

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
	Strips like `stripInBoundsConstantOffsets` but also accumulates the constant offset stripped. More...

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const

Value *	stripInBoundsOffsets ()
	Strips off unneeded pointer casts and any in-bounds offsets from the specified value, returning the original pointer value. More...

const Value *	stripInBoundsOffsets () const

bool	isDereferenceablePointer () const

Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)

const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const

void	mutateType (Type *Ty)

Public Member Functions inherited from llvm::ilist_node< Instruction >
Instruction *	getPrevNode ()
	Get the previous node, or 0 for the list head. More...

const Instruction *	getPrevNode () const
	Get the previous node, or 0 for the list head. More...

Instruction *	getNextNode ()
	Get the next node, or 0 for the list tail. More...

const Instruction *	getNextNode () const
	Get the next node, or 0 for the list tail. More...

Static Public Member Functions
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 Public Member Functions inherited from llvm::CmpInst
static CmpInst *	Create (OtherOps Op, unsigned short predicate, Value S1, Value S2, const Twine &Name="", Instruction *InsertBefore=0)
	Create a CmpInst. More...

static CmpInst *	Create (OtherOps Op, unsigned short predicate, Value S1, Value S2, const Twine &Name, BasicBlock *InsertAtEnd)
	Create a CmpInst. More...

static bool	isFPPredicate (Predicate P)

static bool	isIntPredicate (Predicate P)

static Predicate	getInversePredicate (Predicate pred)
	Return the inverse of a given predicate. More...

static Predicate	getSwappedPredicate (Predicate pred)
	Return the predicate as if the operands were swapped. 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 Type *	makeCmpResultType (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)

static bool	isCommutative (unsigned op)

static bool	isIdempotent (unsigned op)

static bool	isNilpotent (unsigned op)

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
virtual FCmpInst *	clone_impl () const
	Clone an identical FCmpInst. 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=0)

	CmpInst (Type ty, Instruction::OtherOps op, unsigned short pred, Value LHS, Value RHS, const Twine &Name, BasicBlock InsertAtEnd)

virtual void	anchor () LLVM_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=0)

	Instruction (Type Ty, unsigned iType, Use Ops, unsigned NumOps, BasicBlock *InsertAtEnd)

Protected Member Functions inherited from llvm::User
void *	operator new (size_t s, unsigned Us)

	User (Type ty, unsigned vty, Use OpList, unsigned NumOps)

Use *	allocHungoffUses (unsigned) const

void	dropHungoffUses ()

template<int Idx>
Use &	Op ()

template<int Idx>
const Use &	Op () const

Protected Member Functions inherited from llvm::Value
virtual void	printCustom (raw_ostream &O) const

	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 ()

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 }

Public Types inherited from llvm::Instruction
enum	OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0, CompareUsingScalarTypes = 1<<1 }

enum	TermOps

enum	BinaryOps

enum	MemoryOps

enum	CastOps

enum	OtherOps

Public Types inherited from llvm::User
typedef Use *	op_iterator

typedef const Use *	const_op_iterator

Public Types inherited from llvm::Value
enum	ValueTy { ArgumentVal, BasicBlockVal, FunctionVal, GlobalAliasVal, GlobalVariableVal, UndefValueVal, BlockAddressVal, ConstantExprVal, ConstantAggregateZeroVal, ConstantDataArrayVal, ConstantDataVectorVal, ConstantIntVal, ConstantFPVal, ConstantArrayVal, ConstantStructVal, ConstantVectorVal, ConstantPointerNullVal, MDNodeVal, MDStringVal, InlineAsmVal, PseudoSourceValueVal, FixedStackPseudoSourceValueVal, InstructionVal, ConstantFirstVal = FunctionVal, ConstantLastVal = ConstantPointerNullVal }

typedef value_use_iterator< User >	use_iterator

typedef value_use_iterator < const User >	const_use_iterator

Static Public Attributes inherited from llvm::Value
static const unsigned	MaximumAlignment = 1u << 29

Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static Use &	OpFrom (const U *that)

Protected Attributes inherited from llvm::User
Use *	OperandList

unsigned	NumOperands

Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7

Detailed Description

Represents a floating point comparison operator.

This instruction compares its operands according to the predicate given to the constructor. It only operates on floating point values or packed vectors of floating point values. The operands must be identical types.

Definition at line 1055 of file Instructions.h.

Constructor & Destructor Documentation

llvm::FCmpInst::FCmpInst	(	Instruction *	InsertBefore,
		Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with insert-before-instruction semantics.

Parameters

InsertBefore	Where to insert
pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1061 of file Instructions.h.

References llvm::User::getOperand(), llvm::Value::getType(), and llvm::CmpInst::LAST_FCMP_PREDICATE.

Referenced by clone_impl().

llvm::FCmpInst::FCmpInst	(	BasicBlock &	InsertAtEnd,
		Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with insert-at-end semantics.

Parameters

InsertAtEnd	Block to insert into.
pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1080 of file Instructions.h.

References llvm::User::getOperand(), llvm::Value::getType(), and llvm::CmpInst::LAST_FCMP_PREDICATE.

llvm::FCmpInst::FCmpInst	(	Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with no-insertion semantics.

Parameters

pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1099 of file Instructions.h.

References llvm::User::getOperand(), llvm::Value::getType(), and llvm::CmpInst::LAST_FCMP_PREDICATE.

Member Function Documentation

static bool llvm::FCmpInst::classof ( const Instruction * I )

inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 1147 of file Instructions.h.

References llvm::Instruction::getOpcode().

Referenced by classof().

static bool llvm::FCmpInst::classof ( const Value * V )

inlinestatic

Definition at line 1150 of file Instructions.h.

References classof().

FCmpInst * FCmpInst::clone_impl ( ) const

protectedvirtual

Clone an identical FCmpInst.

Implements llvm::Instruction.

Definition at line 3519 of file Instructions.cpp.

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

bool llvm::FCmpInst::isCommutative ( ) const

inline

Determine if this is a commutative predicate.

Returns: true if the predicate of this instruction is commutative.

Definition at line 1124 of file Instructions.h.

References llvm::CmpInst::FCMP_FALSE, llvm::CmpInst::FCMP_ORD, llvm::CmpInst::FCMP_TRUE, llvm::CmpInst::FCMP_UNO, llvm::CmpInst::getPredicate(), and isEquality().

bool llvm::FCmpInst::isEquality ( ) const

inline

Determine if this is an equality predicate.

Returns: true if the predicate of this instruction is EQ or NE.

Definition at line 1117 of file Instructions.h.

References llvm::CmpInst::FCMP_OEQ, llvm::CmpInst::FCMP_ONE, llvm::CmpInst::FCMP_UEQ, llvm::CmpInst::FCMP_UNE, and llvm::CmpInst::getPredicate().

Referenced by isCommutative(), and isRelational().

bool llvm::FCmpInst::isRelational ( ) const

inline

Determine if this a relational predicate.

Returns: true if the predicate is relational (not EQ or NE).

Definition at line 1134 of file Instructions.h.

References isEquality().

void llvm::FCmpInst::swapOperands ( )

inline

Swap operands and adjust predicate.

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).

Definition at line 1141 of file Instructions.h.

References llvm::CmpInst::getSwappedPredicate(), llvm::CmpInst::setPredicate(), and llvm::swap().

Referenced by llvm::InstCombiner::visitFCmpInst().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation