llvm::APFloat Class Reference

#include "llvm/ADT/APFloat.h"

Inheritance diagram for llvm::APFloat:

Collaboration diagram for llvm::APFloat:

Public Member Functions
	APFloat (const fltSemantics &Semantics)
	APFloat (const fltSemantics &Semantics, StringRef S)
	APFloat (const fltSemantics &Semantics, integerPart I)
	APFloat (const fltSemantics &Semantics, uninitializedTag)
	APFloat (const fltSemantics &Semantics, const APInt &I)
	APFloat (double d)
	APFloat (float f)
	APFloat (const APFloat &RHS)=default
	APFloat (APFloat &&RHS)=default
	~APFloat ()=default
bool	needsCleanup () const
void	Profile (FoldingSetNodeID &NID) const
	Used to insert APFloat objects, or objects that contain APFloat objects, into FoldingSets. More...
opStatus	add (const APFloat &RHS, roundingMode RM)
opStatus	subtract (const APFloat &RHS, roundingMode RM)
opStatus	multiply (const APFloat &RHS, roundingMode RM)
opStatus	divide (const APFloat &RHS, roundingMode RM)
opStatus	remainder (const APFloat &RHS)
opStatus	mod (const APFloat &RHS)
opStatus	fusedMultiplyAdd (const APFloat &Multiplicand, const APFloat &Addend, roundingMode RM)
opStatus	roundToIntegral (roundingMode RM)
opStatus	next (bool nextDown)
APFloat	operator+ (const APFloat &RHS) const
	Add two APFloats, rounding ties to the nearest even. More...
APFloat	operator- (const APFloat &RHS) const
	Subtract two APFloats, rounding ties to the nearest even. More...
APFloat	operator* (const APFloat &RHS) const
	Multiply two APFloats, rounding ties to the nearest even. More...
APFloat	operator/ (const APFloat &RHS) const
	Divide the first APFloat by the second, rounding ties to the nearest even. More...
void	changeSign ()
void	clearSign ()
void	copySign (const APFloat &RHS)
opStatus	convert (const fltSemantics &ToSemantics, roundingMode RM, bool *losesInfo)
opStatus	convertToInteger (MutableArrayRef< integerPart > Input, unsigned int Width, bool IsSigned, roundingMode RM, bool *IsExact) const
opStatus	convertToInteger (APSInt &Result, roundingMode RM, bool *IsExact) const
opStatus	convertFromAPInt (const APInt &Input, bool IsSigned, roundingMode RM)
opStatus	convertFromSignExtendedInteger (const integerPart *Input, unsigned int InputSize, bool IsSigned, roundingMode RM)
opStatus	convertFromZeroExtendedInteger (const integerPart *Input, unsigned int InputSize, bool IsSigned, roundingMode RM)
opStatus	convertFromString (StringRef, roundingMode)
APInt	bitcastToAPInt () const
double	convertToDouble () const
float	convertToFloat () const
bool	operator== (const APFloat &) const =delete
cmpResult	compare (const APFloat &RHS) const
bool	bitwiseIsEqual (const APFloat &RHS) const
bool	isExactlyValue (double V) const
	We don't rely on operator== working on double values, as it returns true for things that are clearly not equal, like -0.0 and 0.0. More...
unsigned int	convertToHexString (char *DST, unsigned int HexDigits, bool UpperCase, roundingMode RM) const
bool	isZero () const
bool	isInfinity () const
bool	isNaN () const
bool	isNegative () const
bool	isDenormal () const
bool	isSignaling () const
bool	isNormal () const
bool	isFinite () const
fltCategory	getCategory () const
const fltSemantics &	getSemantics () const
bool	isNonZero () const
bool	isFiniteNonZero () const
bool	isPosZero () const
bool	isNegZero () const
bool	isSmallest () const
bool	isLargest () const
bool	isInteger () const
APFloat &	operator= (const APFloat &RHS)=default
APFloat &	operator= (APFloat &&RHS)=default
void	toString (SmallVectorImpl< char > &Str, unsigned FormatPrecision=0, unsigned FormatMaxPadding=3, bool TruncateZero=true) const
void	print (raw_ostream &) const
void	dump () const
bool	getExactInverse (APFloat *inv) const

Static Public Member Functions
static APFloat	getZero (const fltSemantics &Sem, bool Negative=false)
	Factory for Positive and Negative Zero. More...
static APFloat	getInf (const fltSemantics &Sem, bool Negative=false)
	Factory for Positive and Negative Infinity. More...
static APFloat	getNaN (const fltSemantics &Sem, bool Negative=false, uint64_t payload=0)
	Factory for NaN values. More...
static APFloat	getQNaN (const fltSemantics &Sem, bool Negative=false, const APInt *payload=nullptr)
	Factory for QNaN values. More...
static APFloat	getSNaN (const fltSemantics &Sem, bool Negative=false, const APInt *payload=nullptr)
	Factory for SNaN values. More...
static APFloat	getLargest (const fltSemantics &Sem, bool Negative=false)
	Returns the largest finite number in the given semantics. More...
static APFloat	getSmallest (const fltSemantics &Sem, bool Negative=false)
	Returns the smallest (by magnitude) finite number in the given semantics. More...
static APFloat	getSmallestNormalized (const fltSemantics &Sem, bool Negative=false)
	Returns the smallest (by magnitude) normalized finite number in the given semantics. More...
static APFloat	getAllOnesValue (unsigned BitWidth, bool isIEEE=false)
	Returns a float which is bitcasted from an all one value int. More...
static APFloat	copySign (APFloat Value, const APFloat &Sign)
	A static helper to produce a copy of an APFloat value with its sign copied from some other APFloat. More...
Static Public Member Functions inherited from llvm::APFloatBase
static unsigned int	semanticsPrecision (const fltSemantics &)
static ExponentType	semanticsMinExponent (const fltSemantics &)
static ExponentType	semanticsMaxExponent (const fltSemantics &)
static unsigned int	semanticsSizeInBits (const fltSemantics &)
static unsigned	getSizeInBits (const fltSemantics &Sem)
	Returns the size of the floating point number (in bits) in the given semantics. More...
static const llvm::fltSemantics &	EnumToSemantics (Semantics S)
static Semantics	SemanticsToEnum (const llvm::fltSemantics &Sem)
static const fltSemantics &	IEEEhalf () LLVM_READNONE
static const fltSemantics &	IEEEsingle () LLVM_READNONE
static const fltSemantics &	IEEEdouble () LLVM_READNONE
static const fltSemantics &	IEEEquad () LLVM_READNONE
static const fltSemantics &	PPCDoubleDouble () LLVM_READNONE
static const fltSemantics &	x87DoubleExtended () LLVM_READNONE
static const fltSemantics &	Bogus () LLVM_READNONE
	A Pseudo fltsemantic used to construct APFloats that cannot conflict with anything real. More...

Public Attributes
friend	IEEEFloat
friend	DoubleAPFloat

Friends
hash_code	hash_value (const APFloat &Arg)
	See friend declarations above. More...
int	ilogb (const APFloat &Arg)
APFloat	scalbn (APFloat X, int Exp, roundingMode RM)
APFloat	frexp (const APFloat &X, int &Exp, roundingMode RM)

Additional Inherited Members
Public Types inherited from llvm::APFloatBase
enum	cmpResult { cmpLessThan, cmpEqual, cmpGreaterThan, cmpUnordered }
	IEEE-754R 5.11: Floating Point Comparison Relations. More...
enum	roundingMode {   rmNearestTiesToEven, rmTowardPositive, rmTowardNegative, rmTowardZero,   rmNearestTiesToAway }
	IEEE-754R 4.3: Rounding-direction attributes. More...
enum	opStatus {   opOK = 0x00, opInvalidOp = 0x01, opDivByZero = 0x02, opOverflow = 0x04,   opUnderflow = 0x08, opInexact = 0x10 }
	IEEE-754R 7: Default exception handling. More...
enum	fltCategory { fcInfinity, fcNaN, fcNormal, fcZero }
	Category of internally-represented number. More...
enum	uninitializedTag { uninitialized }
	Convenience enum used to construct an uninitialized APFloat. More...
enum	IlogbErrorKinds { IEK_Zero = INT_MIN + 1, IEK_NaN = INT_MIN, IEK_Inf = INT_MAX }
	Enumeration of ilogb error results. More...
typedef APInt::WordType	integerPart
typedef signed short	ExponentType
	A signed type to represent a floating point numbers unbiased exponent. More...
enum	Semantics {   S_IEEEhalf, S_IEEEsingle, S_IEEEdouble, S_x87DoubleExtended,   S_IEEEquad, S_PPCDoubleDouble }
Static Public Attributes inherited from llvm::APFloatBase
static const unsigned	integerPartWidth = APInt::APINT_BITS_PER_WORD

Detailed Description

Definition at line 684 of file APFloat.h.

Constructor & Destructor Documentation

APFloat() [1/9]

llvm::APFloat::APFloat ( const fltSemantics &  Semantics )

inline

Definition at line 846 of file APFloat.h.

References llvm::lltok::APFloat.

APFloat() [2/9]

llvm::APFloat::APFloat	(	const fltSemantics &	Semantics,
		StringRef	S
	)

Definition at line 4478 of file APFloat.cpp.

References convertFromString(), and llvm::APFloatBase::rmNearestTiesToEven.

APFloat() [3/9]

llvm::APFloat::APFloat ( const fltSemantics &  Semantics, integerPart  I  )

inline

Definition at line 848 of file APFloat.h.

APFloat() [4/9]

llvm::APFloat::APFloat ( const fltSemantics &  Semantics, uninitializedTag    )

inline

Definition at line 850 of file APFloat.h.

APFloat() [5/9]

llvm::APFloat::APFloat ( const fltSemantics &  Semantics, const APInt &  I  )

inline

Definition at line 852 of file APFloat.h.

APFloat() [6/9]

llvm::APFloat::APFloat ( double  d )

inlineexplicit

Definition at line 853 of file APFloat.h.

APFloat() [7/9]

llvm::APFloat::APFloat ( float  f )

inlineexplicit

Definition at line 854 of file APFloat.h.

References llvm::lltok::APFloat.

APFloat() [8/9]

llvm::APFloat::APFloat ( const APFloat &  RHS )

default

APFloat() [9/9]

llvm::APFloat::APFloat ( APFloat &&  RHS )

default

~APFloat()

llvm::APFloat::~APFloat ( )

default

Member Function Documentation

add()

opStatus llvm::APFloat::add ( const APFloat &  RHS, roundingMode  RM  )

inline

Definition at line 951 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::SelectionDAG::foldConstantFPMath(), llvm::ExecutionEngine::getConstantValue(), getSqrtCall(), llvm::detail::DoubleAPFloat::multiply(), operator+(), and llvm::detail::DoubleAPFloat::operator=().

bitcastToAPInt()

APInt llvm::APFloat::bitcastToAPInt ( ) const

inline

Definition at line 1104 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::DwarfUnit::addConstantFPValue(), llvm::SparcTargetLowering::bitcastConstantFPToInt(), llvm::canConstantFoldCallTo(), CC_MipsO32_FP64(), changeFCMPPredToAArch64CC(), llvm::FunctionComparator::cmpAPFloats(), ConvertDoubleToBytes(), llvm::detail::DoubleAPFloat::convertFromAPInt(), llvm::detail::DoubleAPFloat::convertFromSignExtendedInteger(), llvm::detail::DoubleAPFloat::convertFromString(), llvm::detail::DoubleAPFloat::convertFromZeroExtendedInteger(), llvm::detail::DoubleAPFloat::divide(), emitDebugLocValue(), emitGlobalConstantFP(), llvm::R600TargetLowering::EmitInstrWithCustomInserter(), llvm::detail::DoubleAPFloat::fusedMultiplyAdd(), llvm::ExecutionEngine::getConstantValue(), llvm::detail::DoubleAPFloat::getExactInverse(), llvm::AArch64_AM::getFP16Imm(), llvm::ARM_AM::getFP16Imm(), llvm::AArch64_AM::getFP32Imm(), llvm::ARM_AM::getFP32Imm(), llvm::AArch64_AM::getFP64Imm(), llvm::ARM_AM::getFP64Imm(), GetFPLibCall(), getImplicitScaleFactor(), llvm::SelectionDAG::getNode(), getOpenCLAlignment(), GetPromotionOpcode(), getSplatConstantFP(), llvm::HexagonLowerToMC(), llvm::SITargetLowering::isCanonicalized(), llvm::AArch64TargetLowering::isFPImmLegal(), llvm::ARMLegalizerInfo::legalizeCustom(), llvm::HexagonTargetLowering::LowerBITCAST(), llvm::detail::DoubleAPFloat::mod(), llvm::detail::DoubleAPFloat::next(), nextReg(), parseHexOcta(), llvm::R600TargetLowering::PerformDAGCombine(), llvm::NVPTXFloatMCExpr::printImpl(), Profile(), llvm::detail::DoubleAPFloat::remainder(), llvm::detail::DoubleAPFloat::roundToIntegral(), llvm::HexagonDAGToDAGISel::SelectConstantFP(), ShrinkLoadReplaceStoreWithStore(), llvm::SystemZVectorConstantInfo::SystemZVectorConstantInfo(), toString(), and WriteConstantInternal().

bitwiseIsEqual()

bool llvm::APFloat::bitwiseIsEqual ( const APFloat &  RHS ) const

inline

Definition at line 1122 of file APFloat.h.

References getSemantics(), and llvm_unreachable.

Referenced by llvm::DenseMapAPFloatKeyInfo::isEqual(), llvm::X86TargetLowering::isFPImmLegal(), isInv2Pi(), and toString().

changeSign()

void llvm::APFloat::changeSign ( )

inline

Definition at line 1060 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and changeSign().

Referenced by buildMultiplyTree(), changeSign(), EmitAddTreeOfValues(), FoldIntToFPToInt(), GetNegatedExpression(), llvm::SelectionDAG::getNode(), INITIALIZE_PASS(), matchSVEPredicateVectorRegName(), llvm::detail::DoubleAPFloat::multiply(), llvm::neg(), llvm::detail::DoubleAPFloat::operator=(), parseHexOcta(), and llvm::X86TargetLowering::X86TargetLowering().

clearSign()

void llvm::APFloat::clearSign ( )

inline

Definition at line 1061 of file APFloat.h.

Referenced by llvm::abs(), llvm::SelectionDAG::getNode(), LowerFCOPYSIGN(), and llvm::InstCombiner::visitFCmpInst().

compare()

cmpResult llvm::APFloat::compare ( const APFloat &  RHS ) const

inline

Definition at line 1112 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldCompareInstruction(), EmitAddTreeOfValues(), fmed3AMDGCN(), llvm::MDNode::getMostGenericFPMath(), getSplatConstantFP(), getSqrtCall(), llvm::isMathLibCallNoop(), mapBinOpcode(), matchFastFloatClamp(), llvm::maximum(), llvm::maxnum(), llvm::minimum(), llvm::minnum(), SimplifyFCmpInst(), and llvm::InstCombiner::visitFCmpInst().

convert()

APFloat::opStatus llvm::APFloat::convert	(	const fltSemantics &	ToSemantics,
		roundingMode	RM,
		bool *	losesInfo
	)

Definition at line 4483 of file APFloat.cpp.

References assert(), llvm::detail::IEEEFloat::convert(), getSemantics(), llvm_unreachable, llvm::APFloatBase::opOK, and llvm::MipsISD::Ret.

Referenced by llvm::canConstantFoldCallTo(), llvm::ConstantFoldCastInstruction(), emitDebugValueComment(), fitsInFPType(), llvm::SelectionDAG::foldConstantFPMath(), FunctionNumber(), llvm::ConstantFP::get(), llvm::getAPFloatFromSize(), llvm::SelectionDAG::getConstantFP(), llvm::SelectionDAG::getNode(), getOpenCLAlignment(), getPow(), getSqrtCall(), llvm::ConstantFP::isExactlyValue(), isExactlyValue(), llvm::ConstantFP::isValueValidForType(), LLVMConstRealGetDouble(), llvm::ARMAsmPrinter::lowerOperand(), lowerUINT_TO_FP_vec(), llvm::NVPTXFloatMCExpr::printImpl(), valueHasFloatPrecision(), llvm::InstCombiner::visitFCmpInst(), llvm::LegalizerHelper::widenScalar(), WriteConstantInternal(), and llvm::X86TargetLowering::X86TargetLowering().

convertFromAPInt()

opStatus llvm::APFloat::convertFromAPInt ( const APInt &  Input, bool  IsSigned, roundingMode  RM  )

inline

Definition at line 1087 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::ConstantFoldCastInstruction(), llvm::detail::DoubleAPFloat::convertFromAPInt(), llvm::ExecutionEngine::getConstantValue(), and llvm::SelectionDAG::getNode().

convertFromSignExtendedInteger()

opStatus llvm::APFloat::convertFromSignExtendedInteger ( const integerPart *  Input, unsigned int  InputSize, bool  IsSigned, roundingMode  RM  )

inline

Definition at line 1091 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::detail::DoubleAPFloat::convertFromSignExtendedInteger().

convertFromString()

APFloat::opStatus llvm::APFloat::convertFromString	(	StringRef	Str,
		roundingMode	RM
	)

Definition at line 4466 of file APFloat.cpp.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::detail::DoubleAPFloat::convertFromString().

Referenced by APFloat(), llvm::detail::DoubleAPFloat::convertFromString(), llvm::StringRef::getAsDouble(), matchSVEPredicateVectorRegName(), and parseHexOcta().

convertFromZeroExtendedInteger()

opStatus llvm::APFloat::convertFromZeroExtendedInteger ( const integerPart *  Input, unsigned int  InputSize, bool  IsSigned, roundingMode  RM  )

inline

Definition at line 1097 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::detail::DoubleAPFloat::convertFromZeroExtendedInteger().

convertToDouble()

double llvm::APFloat::convertToDouble ( ) const

inline

Definition at line 1107 of file APFloat.h.

Referenced by llvm::canConstantFoldCallTo(), ConvertDoubleToBytes(), emitDebugValueComment(), llvm::StringRef::getAsDouble(), getSqrtCall(), LLVMConstRealGetDouble(), llvm::log2(), llvm::WebAssemblyMCInstLower::lower(), llvm::ARMAsmPrinter::lowerOperand(), and WriteConstantInternal().

convertToFloat()

float llvm::APFloat::convertToFloat ( ) const

inline

Definition at line 1108 of file APFloat.h.

References llvm::operator==().

Referenced by llvm::canConstantFoldCallTo(), ConvertDoubleToBytes(), emitDebugValueComment(), llvm::FPMathOperator::getFPAccuracy(), LLVMConstRealGetDouble(), llvm::log2(), llvm::WebAssemblyMCInstLower::lower(), llvm::R600TargetLowering::PerformDAGCombine(), and WriteConstantInternal().

convertToHexString()

unsigned int llvm::APFloat::convertToHexString ( char *  DST, unsigned int  HexDigits, bool  UpperCase, roundingMode  RM  ) const

inline

Definition at line 1147 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by toString().

convertToInteger() [1/2]

opStatus llvm::APFloat::convertToInteger ( MutableArrayRef< integerPart >  Input, unsigned int  Width, bool  IsSigned, roundingMode  RM, bool *  IsExact  ) const

inline

Definition at line 1079 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::canConstantFoldCallTo(), llvm::ConstantFoldCastInstruction(), convertToInteger(), ConvertToSInt(), llvm::BuildVectorSDNode::getConstantFPSplatPow2ToLog2Int(), llvm::ExecutionEngine::getConstantValue(), llvm::SelectionDAG::getNode(), getPow(), llvm::FastISel::getRegForValue(), and tryBitfieldInsertOpFromOr().

convertToInteger() [2/2]

APFloat::opStatus llvm::APFloat::convertToInteger	(	APSInt &	Result,
		roundingMode	RM,
		bool *	IsExact
	)		const

Definition at line 4548 of file APFloat.cpp.

References convertToInteger(), llvm::APInt::getBitWidth(), llvm::APInt::getNumWords(), llvm::APSInt::isSigned(), and llvm::sys::fs::status().

copySign() [1/2]

void llvm::APFloat::copySign ( const APFloat &  RHS )

inline

Definition at line 1065 of file APFloat.h.

References isNegative().

Referenced by llvm::canConstantFoldCallTo(), copySign(), and llvm::SelectionDAG::foldConstantFPMath().

copySign() [2/2]

static APFloat llvm::APFloat::copySign ( APFloat  Value, const APFloat &  Sign  )

inlinestatic

A static helper to produce a copy of an APFloat value with its sign copied from some other APFloat.

Definition at line 1072 of file APFloat.h.

References copySign(), and llvm::NVPTX::PTXCvtMode::RM.

divide()

opStatus llvm::APFloat::divide ( const APFloat &  RHS, roundingMode  RM  )

inline

Definition at line 978 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::detail::DoubleAPFloat::divide(), llvm::SelectionDAG::foldConstantFPMath(), llvm::ExecutionEngine::getConstantValue(), and operator/().

dump()

LLVM_DUMP_METHOD void llvm::APFloat::dump

(

)

const

Definition at line 4537 of file APFloat.cpp.

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

Referenced by llvm::AArch64TargetLowering::isFPImmLegal().

fusedMultiplyAdd()

opStatus llvm::APFloat::fusedMultiplyAdd ( const APFloat &  Multiplicand, const APFloat &  Addend, roundingMode  RM  )

inline

Definition at line 1005 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::canConstantFoldCallTo(), llvm::detail::DoubleAPFloat::fusedMultiplyAdd(), llvm::SelectionDAG::getNode(), and llvm::detail::DoubleAPFloat::multiply().

getAllOnesValue()

APFloat llvm::APFloat::getAllOnesValue ( unsigned  BitWidth, bool  isIEEE = false  )

static

Returns a float which is bitcasted from an all one value int.

Parameters

BitWidth	- Select float type
isIEEE	- If 128 bit number, select between PPC and IEEE

Definition at line 4508 of file APFloat.cpp.

References assert(), llvm::APInt::getAllOnesValue(), and llvm_unreachable.

Referenced by llvm::Constant::getAllOnesValue(), and lowerShuffleAsBitMask().

getCategory()

fltCategory llvm::APFloat::getCategory ( ) const

inline

Definition at line 1164 of file APFloat.h.

getExactInverse()

bool llvm::APFloat::getExactInverse ( APFloat *  inv ) const

inline

Definition at line 1186 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, Arg, and llvm::hash_value().

Referenced by llvm::detail::DoubleAPFloat::getExactInverse().

getInf()

static APFloat llvm::APFloat::getInf ( const fltSemantics &  Sem, bool  Negative = false  )

inlinestatic

Factory for Positive and Negative Infinity.

Parameters

Negative

True iff the number should be negative.

Definition at line 874 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ConstantFP::getInfinity(), and parseHexOcta().

getLargest()

static APFloat llvm::APFloat::getLargest ( const fltSemantics &  Sem, bool  Negative = false  )

inlinestatic

Returns the largest finite number in the given semantics.

Parameters

Negative

- True iff the number should be negative

Definition at line 914 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::fuzzerop::makeConstantsWithType(), and parseTexFail().

getNaN()

static APFloat llvm::APFloat::getNaN ( const fltSemantics &  Sem, bool  Negative = false, uint64_t  payload = 0  )

inlinestatic

Factory for NaN values.

Parameters

Negative	- True iff the NaN generated should be negative.
payload	- The unspecified fill bits for creating the NaN, 0 by default. The value is truncated as necessary.

Definition at line 885 of file APFloat.h.

Referenced by llvm::SelectionDAG::foldConstantFPMath(), llvm::ConstantFP::getNaN(), and parseHexOcta().

getQNaN()

static APFloat llvm::APFloat::getQNaN ( const fltSemantics &  Sem, bool  Negative = false, const APInt *  payload = nullptr  )

inlinestatic

Factory for QNaN values.

Definition at line 896 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ConstantFP::getQNaN(), llvm::SITargetLowering::isCanonicalized(), toString(), and vectorEltWillFoldAway().

getSemantics()

const fltSemantics& llvm::APFloat::getSemantics ( ) const

inline

Definition at line 1165 of file APFloat.h.

Referenced by add(), bitwiseIsEqual(), llvm::MachineIRBuilder::buildFConstant(), llvm::FunctionComparator::cmpAPFloats(), compare(), convert(), divide(), llvm::frexp(), FunctionNumber(), fusedMultiplyAdd(), llvm::ConstantFP::get(), llvm::ConstantFP::getInfinity(), getParentPad(), getPow(), getSqrtCall(), llvm::hash_value(), llvm::SITargetLowering::isCanonicalized(), llvm::ConstantFP::isExactlyValue(), llvm::isMathLibCallNoop(), llvm::ConstantFP::isValueValidForType(), mod(), multiply(), llvm::AMDGPUTargetLowering::performRcpCombine(), remainder(), llvm::scalbn(), subtract(), llvm::SystemZVectorConstantInfo::SystemZVectorConstantInfo(), toString(), and WriteConstantInternal().

getSmallest()

static APFloat llvm::APFloat::getSmallest ( const fltSemantics &  Sem, bool  Negative = false  )

inlinestatic

Returns the smallest (by magnitude) finite number in the given semantics.

Might be denormalized, which implies a relative loss of precision.

Parameters

Negative

- True iff the number should be negative

Definition at line 924 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::fuzzerop::makeConstantsWithType().

getSmallestNormalized()

static APFloat llvm::APFloat::getSmallestNormalized ( const fltSemantics &  Sem, bool  Negative = false  )

inlinestatic

Returns the smallest (by magnitude) normalized finite number in the given semantics.

Parameters

Negative

- True iff the number should be negative

Definition at line 934 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by INITIALIZE_PASS(), and llvm::InstCombiner::visitFCmpInst().

getSNaN()

static APFloat llvm::APFloat::getSNaN ( const fltSemantics &  Sem, bool  Negative = false, const APInt *  payload = nullptr  )

inlinestatic

Factory for SNaN values.

Definition at line 904 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ConstantFP::getSNaN().

getZero()

static APFloat llvm::APFloat::getZero ( const fltSemantics &  Sem, bool  Negative = false  )

inlinestatic

Factory for Positive and Negative Zero.

Parameters

Negative

True iff the number should be negative.

Definition at line 865 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ExecutionEngine::getConstantValue(), llvm::ConstantFP::getNegativeZero(), llvm::Constant::getNullValue(), llvm::fuzzerop::makeConstantsWithType(), and llvm::X86TargetLowering::X86TargetLowering().

isDenormal()

bool llvm::APFloat::isDenormal ( ) const

inline

Definition at line 1158 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isDenormal().

Referenced by llvm::SITargetLowering::isCanonicalized(), and isDenormal().

isExactlyValue()

bool llvm::APFloat::isExactlyValue ( double  V ) const

inline

We don't rely on operator== working on double values, as it returns true for things that are clearly not equal, like -0.0 and 0.0.

As such, this method can be used to do an exact bit-for-bit comparison of two floating point values.

We leave the version with the double argument here because it's just so convenient to write "2.0" and the like. Without this function we'd have to duplicate its logic everywhere it's called.

Definition at line 1140 of file APFloat.h.

References convert(), and llvm::APFloatBase::rmNearestTiesToEven.

Referenced by CanCombineFCOPYSIGN_EXTEND_ROUND(), changeFCMPPredToAArch64CC(), getSqrtCall(), llvm::ConstantFPSDNode::isExactlyValue(), and llvm::SelectionDAG::simplifyFPBinop().

isFinite()

bool llvm::APFloat::isFinite ( ) const

inline

Definition at line 1162 of file APFloat.h.

Referenced by mapBinOpcode(), matchFastFloatClamp(), llvm::detail::DoubleAPFloat::multiply(), and llvm::detail::DoubleAPFloat::operator=().

isFiniteNonZero()

bool llvm::APFloat::isFiniteNonZero ( ) const

inline

Definition at line 1167 of file APFloat.h.

References isZero().

Referenced by getParentPad(), and llvm::detail::DoubleAPFloat::multiply().

isInfinity()

bool llvm::APFloat::isInfinity ( ) const

inline

Definition at line 1154 of file APFloat.h.

References llvm::APFloatBase::fcInfinity.

Referenced by llvm::ConstantFP::isInfinity(), llvm::isMathLibCallNoop(), llvm::detail::DoubleAPFloat::operator=(), simplifyBinaryIntrinsic(), SimplifyFCmpInst(), and WriteConstantInternal().

isInteger()

bool llvm::APFloat::isInteger ( ) const

inline

Definition at line 1172 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isInteger().

Referenced by getPow(), getSqrtCall(), and isInteger().

isLargest()

bool llvm::APFloat::isLargest ( ) const

inline

Definition at line 1171 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isLargest().

Referenced by isLargest().

isNaN()

bool llvm::APFloat::isNaN ( ) const

inline

Definition at line 1155 of file APFloat.h.

References llvm::APFloatBase::fcNaN.

Referenced by llvm::SITargetLowering::isCanonicalized(), llvm::isMathLibCallNoop(), llvm::ConstantFP::isNaN(), llvm::PatternMatch::is_nan::isValue(), llvm::maximum(), llvm::maxnum(), llvm::minimum(), llvm::minnum(), SimplifyFCmpInst(), toString(), and WriteConstantInternal().

isNegative()

bool llvm::APFloat::isNegative ( ) const

inline

Definition at line 1157 of file APFloat.h.

Referenced by CanCombineFCOPYSIGN_EXTEND_ROUND(), copySign(), foldFCmpReciprocalAndZero(), getParentPad(), getSqrtCall(), llvm::isMathLibCallNoop(), llvm::ConstantFP::isNegative(), mapBinOpcode(), llvm::maximum(), llvm::minimum(), simplifyBinaryIntrinsic(), and SimplifyFCmpInst().

isNegZero()

bool llvm::APFloat::isNegZero ( ) const

inline

Definition at line 1169 of file APFloat.h.

References isZero().

Referenced by llvm::SystemZTargetLowering::isFPImmLegal(), llvm::PatternMatch::is_neg_zero_fp::isValue(), SimplifyFCmpInst(), and llvm::SelectionDAG::simplifyFPBinop().

isNonZero()

bool llvm::APFloat::isNonZero ( ) const

inline

Definition at line 1166 of file APFloat.h.

References isZero().

isNormal()

bool llvm::APFloat::isNormal ( ) const

inline

Definition at line 1161 of file APFloat.h.

Referenced by factorizeFAddFSub().

isPosZero()

bool llvm::APFloat::isPosZero ( ) const

inline

Definition at line 1168 of file APFloat.h.

References isZero().

Referenced by llvm::AArch64TargetLowering::isFPImmLegal(), llvm::PPCTargetLowering::isFPImmLegal(), llvm::PatternMatch::is_pos_zero_fp::isValue(), matchSVEPredicateVectorRegName(), and llvm::SelectionDAG::simplifyFPBinop().

isSignaling()

bool llvm::APFloat::isSignaling ( ) const

inline

Definition at line 1159 of file APFloat.h.

Referenced by llvm::SITargetLowering::isCanonicalized().

isSmallest()

bool llvm::APFloat::isSmallest ( ) const

inline

Definition at line 1170 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isSmallest().

Referenced by isSmallest().

isZero()

bool llvm::APFloat::isZero ( ) const

inline

Definition at line 1153 of file APFloat.h.

References llvm::APFloatBase::fcZero.

Referenced by foldFCmpReciprocalAndZero(), llvm::SystemZTargetLowering::isFPImmLegal(), llvm::isMathLibCallNoop(), llvm::PatternMatch::is_any_zero_fp::isValue(), llvm::ConstantFP::isZero(), mapBinOpcode(), llvm::maximum(), llvm::minimum(), and llvm::InstCombiner::visitFCmpInst().

mod()

opStatus llvm::APFloat::mod ( const APFloat &  RHS )

inline

Definition at line 996 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::SelectionDAG::foldConstantFPMath(), llvm::ExecutionEngine::getConstantValue(), and llvm::detail::DoubleAPFloat::mod().

multiply()

opStatus llvm::APFloat::multiply ( const APFloat &  RHS, roundingMode  RM  )

inline

Definition at line 969 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::SelectionDAG::foldConstantFPMath(), llvm::ExecutionEngine::getConstantValue(), llvm::detail::DoubleAPFloat::multiply(), and operator*().

needsCleanup()

bool llvm::APFloat::needsCleanup ( ) const

inline

Definition at line 860 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and needsCleanup().

Referenced by needsCleanup().

next()

opStatus llvm::APFloat::next ( bool  nextDown )

inline

Definition at line 1024 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::detail::DoubleAPFloat::next().

operator*()

APFloat llvm::APFloat::operator* ( const APFloat &  RHS ) const

inline

Multiply two APFloats, rounding ties to the nearest even.

No error checking.

Definition at line 1046 of file APFloat.h.

References multiply(), and llvm::APFloatBase::rmNearestTiesToEven.

operator+()

APFloat llvm::APFloat::operator+ ( const APFloat &  RHS ) const

inline

Add two APFloats, rounding ties to the nearest even.

No error checking.

Definition at line 1030 of file APFloat.h.

References add(), and llvm::APFloatBase::rmNearestTiesToEven.

operator-()

APFloat llvm::APFloat::operator- ( const APFloat &  RHS ) const

inline

Subtract two APFloats, rounding ties to the nearest even.

No error checking.

Definition at line 1038 of file APFloat.h.

References llvm::APFloatBase::rmNearestTiesToEven, and subtract().

operator/()

APFloat llvm::APFloat::operator/ ( const APFloat &  RHS ) const

inline

Divide the first APFloat by the second, rounding ties to the nearest even.

No error checking.

Definition at line 1054 of file APFloat.h.

References divide(), and llvm::APFloatBase::rmNearestTiesToEven.

operator=() [1/2]

APFloat& llvm::APFloat::operator= ( const APFloat &  RHS )

default

operator=() [2/2]

APFloat& llvm::APFloat::operator= ( APFloat &&  RHS )

default

operator==()

bool llvm::APFloat::operator== ( const APFloat &  ) const

delete

print()

void llvm::APFloat::print

(

raw_ostream &

OS

)

const

Definition at line 4530 of file APFloat.cpp.

References toString().

Referenced by dump().

Profile()

void llvm::APFloat::Profile

(

FoldingSetNodeID &

NID

)

const

Used to insert APFloat objects, or objects that contain APFloat objects, into FoldingSets.

Definition at line 4540 of file APFloat.cpp.

References llvm::FoldingSetNodeID::Add(), and bitcastToAPInt().

remainder()

opStatus llvm::APFloat::remainder ( const APFloat &  RHS )

inline

Definition at line 987 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::detail::DoubleAPFloat::remainder().

roundToIntegral()

opStatus llvm::APFloat::roundToIntegral ( roundingMode  RM )

inline

Definition at line 1018 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by llvm::canConstantFoldCallTo(), llvm::SelectionDAG::getNode(), mapBinOpcode(), and llvm::detail::DoubleAPFloat::roundToIntegral().

subtract()

opStatus llvm::APFloat::subtract ( const APFloat &  RHS, roundingMode  RM  )

inline

Definition at line 960 of file APFloat.h.

References assert(), getSemantics(), and llvm_unreachable.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::SelectionDAG::foldConstantFPMath(), llvm::ExecutionEngine::getConstantValue(), llvm::detail::DoubleAPFloat::multiply(), operator-(), and llvm::detail::DoubleAPFloat::operator=().

toString()

void llvm::APFloat::toString ( SmallVectorImpl< char > &  Str, unsigned  FormatPrecision = 0, unsigned  FormatMaxPadding = 3, bool  TruncateZero = true  ) const

inline

Definition at line 1177 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, llvm::dump(), print(), and llvm::toString().

Referenced by emitGlobalConstantFP(), print(), printConstant(), toStringAPFloat(), and WriteConstantInternal().

Friends And Related Function Documentation

frexp

APFloat frexp ( const APFloat &  X, int &  Exp, roundingMode  RM  )

friend

hash_value

hash_code hash_value ( const APFloat &  Arg )

friend

See friend declarations above.

These additional declarations are required in order to compile LLVM with IBM xlC compiler.

Definition at line 4470 of file APFloat.cpp.

ilogb

int ilogb ( const APFloat &  Arg )

friend

Definition at line 1191 of file APFloat.h.

scalbn

APFloat scalbn ( APFloat  X, int  Exp, roundingMode  RM  )

friend

Member Data Documentation

DoubleAPFloat

friend llvm::APFloat::DoubleAPFloat

Definition at line 1195 of file APFloat.h.

IEEEFloat

friend llvm::APFloat::IEEEFloat

Definition at line 1194 of file APFloat.h.

---

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

• include/llvm/ADT/APFloat.h
• lib/Support/APFloat.cpp