llvm::DenormalMode Struct Reference

Represent subnormal handling kind for floating point instruction inputs and outputs. More...

#include "llvm/ADT/FloatingPointMode.h"

Collaboration diagram for llvm::DenormalMode:

Public Types
enum	DenormalModeKind : int8_t { Invalid = -1 , IEEE , PreserveSign , PositiveZero }
	Represent handled modes for denormal (aka subnormal) modes in the floating point environment. More...

Public Member Functions
constexpr	DenormalMode ()=default
constexpr	DenormalMode (DenormalModeKind Out, DenormalModeKind In)
bool	operator== (DenormalMode Other) const
bool	operator!= (DenormalMode Other) const
bool	isSimple () const
bool	isValid () const
void	print (raw_ostream &OS) const
std::string	str () const

Static Public Member Functions
static constexpr DenormalMode	getInvalid ()
static constexpr DenormalMode	getIEEE ()
static constexpr DenormalMode	getPreserveSign ()
static constexpr DenormalMode	getPositiveZero ()

Public Attributes
DenormalModeKind	Output = DenormalModeKind::Invalid
	Denormal flushing mode for floating point instruction results in the default floating point environment.
DenormalModeKind	Input = DenormalModeKind::Invalid
	Denormal treatment kind for floating point instruction inputs in the default floating-point environment.

Detailed Description

Represent subnormal handling kind for floating point instruction inputs and outputs.

Definition at line 69 of file FloatingPointMode.h.

Member Enumeration Documentation

DenormalModeKind

enum llvm::DenormalMode::DenormalModeKind : int8_t

Represent handled modes for denormal (aka subnormal) modes in the floating point environment.

Enumerator
Invalid
IEEE	IEEE-754 denormal numbers preserved.
PreserveSign	The sign of a flushed-to-zero number is preserved in the sign of 0.
PositiveZero	Denormals are flushed to positive zero.

Definition at line 72 of file FloatingPointMode.h.

Constructor & Destructor Documentation

DenormalMode() [1/2]

constexpr llvm::DenormalMode::DenormalMode ( )

constexprdefault

Referenced by getIEEE(), getInvalid(), getPositiveZero(), and getPreserveSign().

DenormalMode() [2/2]

constexpr llvm::DenormalMode::DenormalMode ( DenormalModeKind  Out, DenormalModeKind  In  )

inlineconstexpr

Definition at line 95 of file FloatingPointMode.h.

Member Function Documentation

getIEEE()

static constexpr DenormalMode llvm::DenormalMode::getIEEE ( )

inlinestaticconstexpr

Definition at line 103 of file FloatingPointMode.h.

References DenormalMode(), and IEEE.

Referenced by llvm::AMDGPU::SIModeRegisterDefaults::allFP32Denormals(), llvm::AMDGPU::SIModeRegisterDefaults::allFP64FP16Denormals(), and fpModeMatchesGlobalFPAtomicMode().

getInvalid()

static constexpr DenormalMode llvm::DenormalMode::getInvalid ( )

inlinestaticconstexpr

Definition at line 99 of file FloatingPointMode.h.

References DenormalMode(), and Invalid.

getPositiveZero()

static constexpr DenormalMode llvm::DenormalMode::getPositiveZero ( )

inlinestaticconstexpr

Definition at line 112 of file FloatingPointMode.h.

References DenormalMode(), and PositiveZero.

getPreserveSign()

static constexpr DenormalMode llvm::DenormalMode::getPreserveSign ( )

inlinestaticconstexpr

Definition at line 107 of file FloatingPointMode.h.

References DenormalMode(), and PreserveSign.

Referenced by llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeDPValue(), llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeSPValue(), and fpModeMatchesGlobalFPAtomicMode().

isSimple()

bool llvm::DenormalMode::isSimple ( ) const

inline

Definition at line 125 of file FloatingPointMode.h.

References Input, and Output.

isValid()

bool llvm::DenormalMode::isValid ( ) const

inline

Definition at line 129 of file FloatingPointMode.h.

References Input, Invalid, and Output.

operator!=()

bool llvm::DenormalMode::operator!= ( DenormalMode  Other ) const

inline

Definition at line 121 of file FloatingPointMode.h.

References llvm::Other.

operator==()

bool llvm::DenormalMode::operator== ( DenormalMode  Other ) const

inline

Definition at line 117 of file FloatingPointMode.h.

References Input, llvm::Other, and Output.

print()

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

inline

Definition at line 191 of file FloatingPointMode.h.

References llvm::denormalModeKindName(), Input, and Output.

Referenced by str().

str()

std::string llvm::DenormalMode::str ( ) const

inline

Definition at line 136 of file FloatingPointMode.h.

References print(), and llvm::raw_string_ostream::str().

Member Data Documentation

Input

DenormalModeKind llvm::DenormalMode::Input = DenormalModeKind::Invalid

Denormal treatment kind for floating point instruction inputs in the default floating-point environment.

If this is not DenormalModeKind::IEEE, floating-point instructions implicitly treat the input value as 0.

Definition at line 92 of file FloatingPointMode.h.

Referenced by llvm::FlushFPConstant(), llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeDPValue(), llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeSPValue(), llvm::AMDGPU::SIModeRegisterDefaults::isInlineCompatible(), isSimple(), isValid(), operator==(), llvm::GCNTargetMachine::parseMachineFunctionInfo(), and print().

Output

DenormalModeKind llvm::DenormalMode::Output = DenormalModeKind::Invalid

Denormal flushing mode for floating point instruction results in the default floating point environment.

Definition at line 87 of file FloatingPointMode.h.

Referenced by llvm::FlushFPConstant(), llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeDPValue(), llvm::AMDGPU::SIModeRegisterDefaults::fpDenormModeSPValue(), llvm::AMDGPU::SIModeRegisterDefaults::isInlineCompatible(), isSimple(), isValid(), operator==(), llvm::GCNTargetMachine::parseMachineFunctionInfo(), print(), and llvm::NVPTXTargetLowering::useF32FTZ().

---

The documentation for this struct was generated from the following file:

• include/llvm/ADT/FloatingPointMode.h