#include "llvm/ADT/APFloat.h"

Inheritance diagram for llvm::APFloat:

Collaboration diagram for llvm::APFloat:

[legend]

Public Member Functions
	APFloat (const fltSemantics &Semantics)

	APFloat (const fltSemantics &Semantics, StringRef S)

	APFloat (const fltSemantics &Semantics, integerPart I)

template<typename T , typename = std::enable_if_t<std::is_floating_point<T>::value>>
	APFloat (const fltSemantics &Semantics, T V)=delete

	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
	Negate an APFloat. More...

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)

Expected< opStatus >	convertFromString (StringRef, roundingMode)

APInt	bitcastToAPInt () const

double	convertToDouble () const
	Converts this APFloat to host double value. More...

float	convertToFloat () const
	Converts this APFloat to host float value. More...

bool	operator== (const APFloat &RHS) const

bool	operator!= (const APFloat &RHS) const

bool	operator< (const APFloat &RHS) const

bool	operator> (const APFloat &RHS) const

bool	operator<= (const APFloat &RHS) const

bool	operator>= (const APFloat &RHS) const

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

bool	isIEEE () 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 (const fltSemantics &Semantics, unsigned BitWidth)
	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 &	BFloat () 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	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 int32_t	ExponentType
	A signed type to represent a floating point numbers unbiased exponent. More...

using	roundingMode = llvm::RoundingMode
	IEEE-754R 4.3: Rounding-direction attributes. More...

enum	Semantics { S_IEEEhalf, S_BFloat, S_IEEEsingle, S_IEEEdouble, S_x87DoubleExtended, S_IEEEquad, S_PPCDoubleDouble }

Static Public Attributes inherited from llvm::APFloatBase
static constexpr unsigned	integerPartWidth = APInt::APINT_BITS_PER_WORD

static constexpr roundingMode	rmNearestTiesToEven

static constexpr roundingMode	rmTowardPositive = RoundingMode::TowardPositive

static constexpr roundingMode	rmTowardNegative = RoundingMode::TowardNegative

static constexpr roundingMode	rmTowardZero = RoundingMode::TowardZero

static constexpr roundingMode	rmNearestTiesToAway

Detailed Description

Definition at line 701 of file APFloat.h.

Constructor & Destructor Documentation

◆ APFloat() [1/10]

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

inline

Definition at line 863 of file APFloat.h.

◆ APFloat() [2/10]

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

Definition at line 4818 of file APFloat.cpp.

References assert(), llvm::consumeError(), convertFromString(), llvm::APFloatBase::rmNearestTiesToEven, and S.

◆ APFloat() [3/10]

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

inline

Definition at line 865 of file APFloat.h.

◆ APFloat() [4/10]

template<typename T , typename = std::enable_if_t<std::is_floating_point<T>::value>>

llvm::APFloat::APFloat	(	const fltSemantics &	Semantics,
		T	V
	)

delete

◆ APFloat() [5/10]

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

inline

Definition at line 870 of file APFloat.h.

◆ APFloat() [6/10]

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

inline

Definition at line 872 of file APFloat.h.

◆ APFloat() [7/10]

llvm::APFloat::APFloat ( double d )

inlineexplicit

Definition at line 873 of file APFloat.h.

◆ APFloat() [8/10]

llvm::APFloat::APFloat ( float f )

inlineexplicit

Definition at line 874 of file APFloat.h.

◆ APFloat() [9/10]

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

default

◆ APFloat() [10/10]

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 972 of file APFloat.h.

References assert(), getSemantics(), llvm_unreachable, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::ExecutionEngine::getConstantValue(), and llvm::detail::DoubleAPFloat::multiply().

◆ bitcastToAPInt()

APInt llvm::APFloat::bitcastToAPInt ( ) const

inline

Definition at line 1132 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

◆ bitwiseIsEqual()

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

inline

Definition at line 1182 of file APFloat.h.

References getSemantics(), and llvm_unreachable.

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

◆ changeSign()

void llvm::APFloat::changeSign ( )

inline

Definition at line 1088 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and changeSign().

Referenced by changeSign(), clearSign(), constantFoldFpUnary(), copySign(), llvm::PPCInstrInfo::finalizeInsInstrs(), llvm::TargetLowering::getNegatedExpression(), llvm::SelectionDAG::getNeutralElement(), llvm::SelectionDAG::getNode(), and llvm::X86TargetLowering::X86TargetLowering().

◆ clearSign()

void llvm::APFloat::clearSign ( )

inline

Definition at line 1089 of file APFloat.h.

References changeSign(), and isNegative().

Referenced by constantFoldFpUnary(), llvm::SelectionDAG::getNode(), LowerFCOPYSIGN(), and llvm::InstCombinerImpl::visitFCmpInst().

◆ compare()

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

inline

Definition at line 1172 of file APFloat.h.

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

Referenced by llvm::ConstantFoldCompareInstruction(), fmed3AMDGCN(), operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

◆ convert()

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

Definition at line 4825 of file APFloat.cpp.

References assert(), llvm::detail::IEEEFloat::convert(), getSemantics(), llvm_unreachable, move, llvm::APFloatBase::opOK, llvm::MipsISD::Ret, llvm::AArch64::RM, llvm::semPPCDoubleDouble, and llvm::semPPCDoubleDoubleLegacy.

Referenced by canSafelyConvertTo16Bit(), llvm::checkConvertToNonDenormSingle(), llvm::ConstantFoldCastInstruction(), constantFoldFpUnary(), convertToDouble(), llvm::APFixedPoint::convertToFloat(), convertToFloat(), llvm::convertToNonDenormSingle(), emitDebugValueComment(), llvm::ConstantFP::get(), llvm::getAPFloatFromSize(), llvm::SelectionDAG::getConstantFP(), llvm::APFixedPoint::getFromFloatValue(), llvm::SelectionDAG::getNode(), llvm::GCNTTIImpl::instCombineIntrinsic(), llvm::ConstantFP::isExactlyValue(), isExactlyValue(), llvm::ConstantFP::isValueValidForType(), llvm::ConstantFPSDNode::isValueValidForType(), LLVMConstRealGetDouble(), LowerFROUND(), llvm::ARMAsmPrinter::lowerOperand(), llvm::NVPTXFloatMCExpr::printImpl(), llvm::InstCombinerImpl::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 1115 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldCastInstruction(), llvm::ConstantFoldIntToFloat(), llvm::detail::DoubleAPFloat::convertFromAPInt(), llvm::APFixedPoint::convertToFloat(), llvm::ExecutionEngine::getConstantValue(), llvm::SelectionDAG::getNode(), and llvm::LegalizerHelper::lowerFPTOUI().

◆ convertFromSignExtendedInteger()

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

inline

Definition at line 1119 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

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

◆ convertFromString()

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

Definition at line 4805 of file APFloat.cpp.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

Referenced by APFloat(), and llvm::detail::DoubleAPFloat::convertFromString().

◆ convertFromZeroExtendedInteger()

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

inline

Definition at line 1125 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

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

◆ convertToDouble()

double llvm::APFloat::convertToDouble ( ) const

Converts this APFloat to host double value.

Precondition: The APFloat must be built using semantics, that can be represented by the host double type without loss of precision. It can be IEEEdouble and shorter semantics, like IEEEsingle and others.

Definition at line 4885 of file APFloat.cpp.

References assert(), convert(), llvm::detail::IEEEFloat::convertToDouble(), getSemantics(), llvm::APFloatBase::opInexact, llvm::APFloatBase::rmNearestTiesToEven, and llvm::semIEEEdouble.

Referenced by constantFoldFpUnary(), emitDebugValueComment(), getBranchWeight(), LLVMConstRealGetDouble(), llvm::ARMAsmPrinter::lowerOperand(), and WriteConstantInternal().

◆ convertToFloat()

float llvm::APFloat::convertToFloat ( ) const

Converts this APFloat to host float value.

Precondition: The APFloat must be built using semantics, that can be represented by the host float type without loss of precision. It can be IEEEsingle and shorter semantics, like IEEEhalf.

Definition at line 4898 of file APFloat.cpp.

References assert(), convert(), llvm::detail::IEEEFloat::convertToFloat(), getSemantics(), llvm::APFloatBase::opInexact, llvm::APFloatBase::rmNearestTiesToEven, and llvm::semIEEEsingle.

Referenced by llvm::FPMathOperator::getFPAccuracy().

◆ convertToHexString()

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

inline

Definition at line 1207 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

◆ convertToInteger() [1/2]

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

Definition at line 4873 of file APFloat.cpp.

References llvm::BitmaskEnumDetail::bitWidth(), convertToInteger(), result, and llvm::sys::fs::status().

◆ convertToInteger() [2/2]

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

inline

Definition at line 1107 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldCastInstruction(), convertToInteger(), ConvertToSInt(), llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::BuildVectorSDNode::getConstantFPSplatPow2ToLog2Int(), llvm::ExecutionEngine::getConstantValue(), llvm::APFixedPoint::getFromFloatValue(), and llvm::SelectionDAG::getNode().

◆ copySign() [1/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 1100 of file APFloat.h.

◆ copySign() [2/2]

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

inline

Definition at line 1093 of file APFloat.h.

References changeSign(), and isNegative().

◆ divide()

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

inline

Definition at line 999 of file APFloat.h.

References assert(), getSemantics(), llvm_unreachable, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::detail::DoubleAPFloat::divide(), llvm::ExecutionEngine::getConstantValue(), and llvm::GCNTTIImpl::instCombineIntrinsic().

◆ dump()

LLVM_DUMP_METHOD void llvm::APFloat::dump ( ) const

Definition at line 4862 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 1026 of file APFloat.h.

References assert(), getSemantics(), llvm_unreachable, and llvm::AArch64::RM.

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

◆ getAllOnesValue()

APFloat llvm::APFloat::getAllOnesValue	(	const fltSemantics &	Semantics,
		unsigned	BitWidth
	)

static

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

Parameters

Semantics	- type float semantics
BitWidth	- Select float type

Definition at line 4850 of file APFloat.cpp.

References llvm::BitWidth, and llvm::APInt::getAllOnesValue().

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

◆ getCategory()

fltCategory llvm::APFloat::getCategory ( ) const

inline

Definition at line 1224 of file APFloat.h.

References llvm::detail::IEEEFloat::getCategory().

Referenced by isInfinity(), isNaN(), and isZero().

◆ getExactInverse()

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

inline

Definition at line 1247 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

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 894 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ConstantFP::getInfinity(), and llvm::SelectionDAG::getNeutralElement().

◆ 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 934 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::SelectionDAG::getNeutralElement(), llvm::isKnownNeverInfinity(), llvm::AMDGPULegalizerInfo::legalizeRsqClampIntrinsic(), and llvm::fuzzerop::makeConstantsWithType().

◆ 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 905 of file APFloat.h.

References getQNaN().

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

◆ getQNaN()

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

inlinestatic

Factory for QNaN values.

Definition at line 916 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by getNaN(), llvm::SelectionDAG::getNeutralElement(), llvm::ConstantFP::getQNaN(), llvm::GCNTTIImpl::instCombineIntrinsic(), and toString().

◆ getSemantics()

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

inline

◆ 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 944 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 954 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::TargetLowering::getSqrtInputTest(), and llvm::InstCombinerImpl::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 924 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by llvm::ConstantFP::getSNaN(), and WriteConstantInternal().

◆ 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 885 of file APFloat.h.

References llvm::APFloatBase::uninitialized.

Referenced by cannotBeOrderedLessThanZeroImpl(), fixFuncEntryCount(), llvm::ExecutionEngine::getConstantValue(), llvm::ConstantFP::getNegativeZero(), llvm::Constant::getNullValue(), llvm::Type::isIEEE(), llvm::fuzzerop::makeConstantsWithType(), llvm::pdb::Variant::toAPFloat(), and llvm::X86TargetLowering::X86TargetLowering().

◆ isDenormal()

bool llvm::APFloat::isDenormal ( ) const

inline

Definition at line 1218 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isDenormal().

Referenced by llvm::checkConvertToNonDenormSingle(), llvm::convertToNonDenormSingle(), llvm::GCNTTIImpl::instCombineIntrinsic(), isDenormal(), and isNormal().

◆ 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 1200 of file APFloat.h.

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

Referenced by llvm::SelectionDAG::simplifyFPBinop().

◆ isFinite()

bool llvm::APFloat::isFinite ( ) const

inline

Definition at line 1222 of file APFloat.h.

References isInfinity(), and isNaN().

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

◆ isFiniteNonZero()

bool llvm::APFloat::isFiniteNonZero ( ) const

inline

Definition at line 1227 of file APFloat.h.

References isFinite(), and isZero().

Referenced by isNormal().

◆ isIEEE()

bool llvm::APFloat::isIEEE ( ) const

inline

Definition at line 1233 of file APFloat.h.

References getSemantics().

Referenced by llvm::Type::isIEEE().

◆ isInfinity()

bool llvm::APFloat::isInfinity ( ) const

inline

Definition at line 1214 of file APFloat.h.

References llvm::APFloatBase::fcInfinity, and getCategory().

Referenced by llvm::GCNTTIImpl::instCombineIntrinsic(), isFinite(), llvm::ConstantFP::isInfinity(), llvm::isMathLibCallNoop(), llvm::SelectionDAG::simplifyFPBinop(), visitFMinMax(), and WriteConstantInternal().

◆ isInteger()

bool llvm::APFloat::isInteger ( ) const

inline

Definition at line 1232 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isInteger().

Referenced by isInteger().

◆ isLargest()

bool llvm::APFloat::isLargest ( ) const

inline

Definition at line 1231 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isLargest().

Referenced by isLargest(), and visitFMinMax().

◆ isNaN()

bool llvm::APFloat::isNaN ( ) const

inline

Definition at line 1215 of file APFloat.h.

References llvm::APFloatBase::fcNaN, and getCategory().

Referenced by llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::GCNTTIImpl::instCombineIntrinsic(), isFinite(), llvm::isMathLibCallNoop(), llvm::ConstantFP::isNaN(), llvm::SelectionDAG::simplifyFPBinop(), visitFMinMax(), and WriteConstantInternal().

◆ isNegative()

bool llvm::APFloat::isNegative ( ) const

inline

Definition at line 1217 of file APFloat.h.

References llvm::detail::IEEEFloat::isNegative().

Referenced by clearSign(), copySign(), llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::GCNTTIImpl::instCombineIntrinsic(), llvm::ConstantFP::isNegative(), isNegZero(), isPosZero(), visitFMinMax(), and WriteConstantInternal().

◆ isNegZero()

bool llvm::APFloat::isNegZero ( ) const

inline

Definition at line 1229 of file APFloat.h.

References isNegative(), and isZero().

Referenced by llvm::RISCVTargetLowering::isFPImmLegal(), llvm::SystemZTargetLowering::isFPImmLegal(), and llvm::SelectionDAG::simplifyFPBinop().

◆ isNonZero()

bool llvm::APFloat::isNonZero ( ) const

inline

Definition at line 1226 of file APFloat.h.

References isZero().

◆ isNormal()

bool llvm::APFloat::isNormal ( ) const

inline

Definition at line 1221 of file APFloat.h.

References isDenormal(), and isFiniteNonZero().

Referenced by llvm::GCNTTIImpl::instCombineIntrinsic().

◆ isPosZero()

bool llvm::APFloat::isPosZero ( ) const

inline

Definition at line 1228 of file APFloat.h.

References isNegative(), and isZero().

Referenced by llvm::AArch64TargetLowering::isFPImmLegal(), llvm::PPCTargetLowering::isFPImmLegal(), and llvm::SelectionDAG::simplifyFPBinop().

◆ isSignaling()

bool llvm::APFloat::isSignaling ( ) const

inline

Definition at line 1219 of file APFloat.h.

References llvm::detail::IEEEFloat::isSignaling().

Referenced by llvm::GCNTTIImpl::instCombineIntrinsic(), and WriteConstantInternal().

◆ isSmallest()

bool llvm::APFloat::isSmallest ( ) const

inline

Definition at line 1230 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and isSmallest().

Referenced by isSmallest().

◆ isZero()

bool llvm::APFloat::isZero ( ) const

inline

Definition at line 1213 of file APFloat.h.

References llvm::APFloatBase::fcZero, and getCategory().

Referenced by llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::GCNTTIImpl::instCombineIntrinsic(), isFiniteNonZero(), llvm::RISCVTargetLowering::isFPImmLegal(), llvm::SystemZTargetLowering::isFPImmLegal(), llvm::isMathLibCallNoop(), isNegZero(), isNonZero(), isPosZero(), llvm::ConstantFP::isZero(), llvm::SelectionDAG::simplifyFPBinop(), and llvm::InstCombinerImpl::visitFCmpInst().

◆ mod()

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

inline

Definition at line 1017 of file APFloat.h.

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

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

◆ multiply()

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

inline

Definition at line 990 of file APFloat.h.

References assert(), getSemantics(), llvm_unreachable, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldBinaryInstruction(), llvm::APFixedPoint::convertToFloat(), llvm::ExecutionEngine::getConstantValue(), llvm::APFixedPoint::getFromFloatValue(), and llvm::detail::DoubleAPFloat::multiply().

◆ needsCleanup()

bool llvm::APFloat::needsCleanup ( ) const

inline

Definition at line 880 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 1045 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by LowerFROUND(), and llvm::detail::DoubleAPFloat::next().

◆ operator!=()

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

inline

Definition at line 1152 of file APFloat.h.

References llvm::APFloatBase::cmpEqual, and compare().

◆ 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 1074 of file APFloat.h.

References 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 1058 of file APFloat.h.

References llvm::APFloatBase::rmNearestTiesToEven.

◆ operator-() [1/2]

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

inline

Negate an APFloat.

Definition at line 1050 of file APFloat.h.

◆ operator-() [2/2]

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

inline

Subtract two APFloats, rounding ties to the nearest even.

No error checking.

Definition at line 1066 of file APFloat.h.

References llvm::APFloatBase::rmNearestTiesToEven.

◆ 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 1082 of file APFloat.h.

References llvm::APFloatBase::rmNearestTiesToEven.

◆ operator<()

bool llvm::APFloat::operator< ( const APFloat & RHS ) const

inline

Definition at line 1154 of file APFloat.h.

References llvm::APFloatBase::cmpLessThan, and compare().

◆ operator<=()

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

inline

Definition at line 1162 of file APFloat.h.

References llvm::APFloatBase::cmpEqual, llvm::APFloatBase::cmpLessThan, and compare().

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

default

◆ operator==()

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

inline

Definition at line 1150 of file APFloat.h.

References llvm::APFloatBase::cmpEqual, and compare().

◆ operator>()

bool llvm::APFloat::operator> ( const APFloat & RHS ) const

inline

Definition at line 1158 of file APFloat.h.

References llvm::APFloatBase::cmpGreaterThan, and compare().

◆ operator>=()

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

inline

Definition at line 1167 of file APFloat.h.

References llvm::APFloatBase::cmpEqual, llvm::APFloatBase::cmpGreaterThan, and compare().

◆ print()

void llvm::APFloat::print ( raw_ostream & OS ) const

Definition at line 4855 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 4865 of file APFloat.cpp.

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

◆ remainder()

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

inline

Definition at line 1008 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 1039 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS, and llvm::AArch64::RM.

Referenced by llvm::InstCombinerImpl::foldFCmpIntToFPConst(), llvm::APFixedPoint::getFromFloatValue(), llvm::SelectionDAG::getNode(), and llvm::detail::DoubleAPFloat::roundToIntegral().

◆ subtract()

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

inline

Definition at line 981 of file APFloat.h.

References assert(), getSemantics(), llvm_unreachable, and llvm::AArch64::RM.

Referenced by llvm::ConstantFoldBinaryInstruction(), and llvm::ExecutionEngine::getConstantValue().

◆ toString()

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

inline

Definition at line 1238 of file APFloat.h.

References APFLOAT_DISPATCH_ON_SEMANTICS.

Referenced by emitGlobalConstantFP(), print(), printConstant(), 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 4810 of file APFloat.cpp.

◆ ilogb

int ilogb ( const APFloat & Arg )

friend

Definition at line 1252 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 1256 of file APFloat.h.

◆ IEEEFloat

friend llvm::APFloat::IEEEFloat

Definition at line 1255 of file APFloat.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ APFloat() [1/10]

◆ APFloat() [2/10]

◆ APFloat() [3/10]

◆ APFloat() [4/10]

◆ APFloat() [5/10]

◆ APFloat() [6/10]

◆ APFloat() [7/10]

◆ APFloat() [8/10]

◆ APFloat() [9/10]

◆ APFloat() [10/10]

◆ ~APFloat()

Member Function Documentation

◆ add()

◆ bitcastToAPInt()

◆ bitwiseIsEqual()

◆ changeSign()

◆ clearSign()

◆ compare()

◆ convert()

◆ convertFromAPInt()

◆ convertFromSignExtendedInteger()

◆ convertFromString()

◆ convertFromZeroExtendedInteger()

◆ convertToDouble()

◆ convertToFloat()

◆ convertToHexString()

◆ convertToInteger() [1/2]

◆ convertToInteger() [2/2]

◆ copySign() [1/2]

◆ copySign() [2/2]

◆ divide()

◆ dump()

◆ fusedMultiplyAdd()

◆ getAllOnesValue()

◆ getCategory()

◆ getExactInverse()

◆ getInf()

◆ getLargest()

◆ getNaN()

◆ getQNaN()

◆ getSemantics()

◆ getSmallest()

◆ getSmallestNormalized()

◆ getSNaN()

◆ getZero()

◆ isDenormal()

◆ isExactlyValue()

◆ isFinite()

◆ isFiniteNonZero()

◆ isIEEE()

◆ isInfinity()

◆ isInteger()

◆ isLargest()

◆ isNaN()

◆ isNegative()

◆ isNegZero()

◆ isNonZero()

◆ isNormal()

◆ isPosZero()

◆ isSignaling()

◆ isSmallest()

◆ isZero()

◆ mod()

◆ multiply()

◆ needsCleanup()

◆ next()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator/()

◆ operator<()