LLVM  13.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::ScalableVectorType Class Reference

Class to represent scalable SIMD vectors. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::ScalableVectorType:
Inheritance graph
[legend]
Collaboration diagram for llvm::ScalableVectorType:
Collaboration graph
[legend]

Public Member Functions

uint64_t getMinNumElements () const
 Get the minimum number of elements in this vector. More...
 
- Public Member Functions inherited from llvm::VectorType
 VectorType (const VectorType &)=delete
 
VectorTypeoperator= (const VectorType &)=delete
 
TypegetElementType () const
 
ElementCount getElementCount () const
 Return an ElementCount instance to represent the (possibly scalable) number of elements in the vector. More...
 
- Public Member Functions inherited from llvm::Type
void print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
 Print the current type. More...
 
void dump () const
 
LLVMContextgetContext () const
 Return the LLVMContext in which this type was uniqued. More...
 
TypeID getTypeID () const
 Return the type id for the type. More...
 
bool isVoidTy () const
 Return true if this is 'void'. More...
 
bool isHalfTy () const
 Return true if this is 'half', a 16-bit IEEE fp type. More...
 
bool isBFloatTy () const
 Return true if this is 'bfloat', a 16-bit bfloat type. More...
 
bool isFloatTy () const
 Return true if this is 'float', a 32-bit IEEE fp type. More...
 
bool isDoubleTy () const
 Return true if this is 'double', a 64-bit IEEE fp type. More...
 
bool isX86_FP80Ty () const
 Return true if this is x86 long double. More...
 
bool isFP128Ty () const
 Return true if this is 'fp128'. More...
 
bool isPPC_FP128Ty () const
 Return true if this is powerpc long double. More...
 
bool isFloatingPointTy () const
 Return true if this is one of the six floating-point types. More...
 
const fltSemanticsgetFltSemantics () const
 
bool isX86_MMXTy () const
 Return true if this is X86 MMX. More...
 
bool isX86_AMXTy () const
 Return true if this is X86 AMX. More...
 
bool isFPOrFPVectorTy () const
 Return true if this is a FP type or a vector of FP. More...
 
bool isLabelTy () const
 Return true if this is 'label'. More...
 
bool isMetadataTy () const
 Return true if this is 'metadata'. More...
 
bool isTokenTy () const
 Return true if this is 'token'. More...
 
bool isIntegerTy () const
 True if this is an instance of IntegerType. More...
 
bool isIntegerTy (unsigned Bitwidth) const
 Return true if this is an IntegerType of the given width. More...
 
bool isIntOrIntVectorTy () const
 Return true if this is an integer type or a vector of integer types. More...
 
bool isIntOrIntVectorTy (unsigned BitWidth) const
 Return true if this is an integer type or a vector of integer types of the given width. More...
 
bool isIntOrPtrTy () const
 Return true if this is an integer type or a pointer type. More...
 
bool isFunctionTy () const
 True if this is an instance of FunctionType. More...
 
bool isStructTy () const
 True if this is an instance of StructType. More...
 
bool isArrayTy () const
 True if this is an instance of ArrayType. More...
 
bool isPointerTy () const
 True if this is an instance of PointerType. More...
 
bool isPtrOrPtrVectorTy () const
 Return true if this is a pointer type or a vector of pointer types. More...
 
bool isVectorTy () const
 True if this is an instance of VectorType. More...
 
bool canLosslesslyBitCastTo (Type *Ty) const
 Return true if this type could be converted with a lossless BitCast to type 'Ty'. More...
 
bool isEmptyTy () const
 Return true if this type is empty, that is, it has no elements or all of its elements are empty. More...
 
bool isFirstClassType () const
 Return true if the type is "first class", meaning it is a valid type for a Value. More...
 
bool isSingleValueType () const
 Return true if the type is a valid type for a register in codegen. More...
 
bool isAggregateType () const
 Return true if the type is an aggregate type. More...
 
bool isSized (SmallPtrSetImpl< Type * > *Visited=nullptr) const
 Return true if it makes sense to take the size of this type. More...
 
TypeSize getPrimitiveSizeInBits () const LLVM_READONLY
 Return the basic size of this type if it is a primitive type. More...
 
unsigned getScalarSizeInBits () const LLVM_READONLY
 If this is a vector type, return the getPrimitiveSizeInBits value for the element type. More...
 
int getFPMantissaWidth () const
 Return the width of the mantissa of this type. More...
 
bool isIEEE () const
 Return whether the type is IEEE compatible, as defined by the eponymous method in APFloat. More...
 
TypegetScalarType () const
 If this is a vector type, return the element type, otherwise return 'this'. More...
 
subtype_iterator subtype_begin () const
 
subtype_iterator subtype_end () const
 
ArrayRef< Type * > subtypes () const
 
subtype_reverse_iterator subtype_rbegin () const
 
subtype_reverse_iterator subtype_rend () const
 
TypegetContainedType (unsigned i) const
 This method is used to implement the type iterator (defined at the end of the file). More...
 
unsigned getNumContainedTypes () const
 Return the number of types in the derived type. More...
 
unsigned getIntegerBitWidth () const
 
TypegetFunctionParamType (unsigned i) const
 
unsigned getFunctionNumParams () const
 
bool isFunctionVarArg () const
 
StringRef getStructName () const
 
unsigned getStructNumElements () const
 
TypegetStructElementType (unsigned N) const
 
uint64_t getArrayNumElements () const
 
TypegetArrayElementType () const
 
TypegetPointerElementType () const
 
TypegetWithNewType (Type *EltTy) const
 Given vector type, change the element type, whilst keeping the old number of elements. More...
 
TypegetWithNewBitWidth (unsigned NewBitWidth) const
 Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes. More...
 
TypegetExtendedType () const
 Given scalar/vector integer type, returns a type with elements twice as wide as in the original type. More...
 
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
 
PointerTypegetPointerTo (unsigned AddrSpace=0) const
 Return a pointer to the current type. More...
 

Static Public Member Functions

static ScalableVectorTypeget (Type *ElementType, unsigned MinNumElts)
 
static ScalableVectorTypeget (Type *ElementType, const ScalableVectorType *SVTy)
 
static ScalableVectorTypegetInteger (ScalableVectorType *VTy)
 
static ScalableVectorTypegetExtendedElementVectorType (ScalableVectorType *VTy)
 
static ScalableVectorTypegetTruncatedElementVectorType (ScalableVectorType *VTy)
 
static ScalableVectorTypegetSubdividedVectorType (ScalableVectorType *VTy, int NumSubdivs)
 
static ScalableVectorTypegetHalfElementsVectorType (ScalableVectorType *VTy)
 
static ScalableVectorTypegetDoubleElementsVectorType (ScalableVectorType *VTy)
 
static bool classof (const Type *T)
 
- Static Public Member Functions inherited from llvm::VectorType
static VectorTypeget (Type *ElementType, ElementCount EC)
 This static method is the primary way to construct an VectorType. More...
 
static VectorTypeget (Type *ElementType, unsigned NumElements, bool Scalable)
 
static VectorTypeget (Type *ElementType, const VectorType *Other)
 
static VectorTypegetInteger (VectorType *VTy)
 This static method gets a VectorType with the same number of elements as the input type, and the element type is an integer type of the same width as the input element type. More...
 
static VectorTypegetExtendedElementVectorType (VectorType *VTy)
 This static method is like getInteger except that the element types are twice as wide as the elements in the input type. More...
 
static VectorTypegetTruncatedElementVectorType (VectorType *VTy)
 
static VectorTypegetSubdividedVectorType (VectorType *VTy, int NumSubdivs)
 
static VectorTypegetHalfElementsVectorType (VectorType *VTy)
 This static method returns a VectorType with half as many elements as the input type and the same element type. More...
 
static VectorTypegetDoubleElementsVectorType (VectorType *VTy)
 This static method returns a VectorType with twice as many elements as the input type and the same element type. More...
 
static bool isValidElementType (Type *ElemTy)
 Return true if the specified type is valid as a element type. More...
 
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::Type
static TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 Return a type based on an identifier. More...
 
static TypegetVoidTy (LLVMContext &C)
 
static TypegetLabelTy (LLVMContext &C)
 
static TypegetHalfTy (LLVMContext &C)
 
static TypegetBFloatTy (LLVMContext &C)
 
static TypegetFloatTy (LLVMContext &C)
 
static TypegetDoubleTy (LLVMContext &C)
 
static TypegetMetadataTy (LLVMContext &C)
 
static TypegetX86_FP80Ty (LLVMContext &C)
 
static TypegetFP128Ty (LLVMContext &C)
 
static TypegetPPC_FP128Ty (LLVMContext &C)
 
static TypegetX86_MMXTy (LLVMContext &C)
 
static TypegetX86_AMXTy (LLVMContext &C)
 
static TypegetTokenTy (LLVMContext &C)
 
static IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
 
static IntegerTypegetInt1Ty (LLVMContext &C)
 
static IntegerTypegetInt8Ty (LLVMContext &C)
 
static IntegerTypegetInt16Ty (LLVMContext &C)
 
static IntegerTypegetInt32Ty (LLVMContext &C)
 
static IntegerTypegetInt64Ty (LLVMContext &C)
 
static IntegerTypegetInt128Ty (LLVMContext &C)
 
template<typename ScalarTy >
static TypegetScalarTy (LLVMContext &C)
 
static TypegetFloatingPointTy (LLVMContext &C, const fltSemantics &S)
 
static PointerTypegetHalfPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetBFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetDoublePtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_AMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
 
static PointerTypegetInt1PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt8PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt16PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt32PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt64PtrTy (LLVMContext &C, unsigned AS=0)
 

Protected Member Functions

 ScalableVectorType (Type *ElTy, unsigned MinNumElts)
 
- Protected Member Functions inherited from llvm::VectorType
 VectorType (Type *ElType, unsigned EQ, Type::TypeID TID)
 
- Protected Member Functions inherited from llvm::Type
 Type (LLVMContext &C, TypeID tid)
 
 ~Type ()=default
 
unsigned getSubclassData () const
 
void setSubclassData (unsigned val)
 

Additional Inherited Members

- Public Types inherited from llvm::Type
enum  TypeID {
  HalfTyID = 0, BFloatTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, VoidTyID,
  LabelTyID, MetadataTyID, X86_MMXTyID, X86_AMXTyID,
  TokenTyID, IntegerTyID, FunctionTyID, PointerTyID,
  StructTyID, ArrayTyID, FixedVectorTyID, ScalableVectorTyID
}
 Definitions of all of the base types for the Type system. More...
 
using subtype_iterator = Type *const *
 
using subtype_reverse_iterator = std::reverse_iterator< subtype_iterator >
 
- Protected Attributes inherited from llvm::VectorType
const unsigned ElementQuantity
 The element quantity of this vector. More...
 
- Protected Attributes inherited from llvm::Type
unsigned NumContainedTys = 0
 Keeps track of how many Type*'s there are in the ContainedTys list. More...
 
Type *constContainedTys = nullptr
 A pointer to the array of Types contained by this Type. More...
 

Detailed Description

Class to represent scalable SIMD vectors.

Definition at line 574 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ ScalableVectorType()

llvm::ScalableVectorType::ScalableVectorType ( Type ElTy,
unsigned  MinNumElts 
)
inlineprotected

Definition at line 576 of file DerivedTypes.h.

Member Function Documentation

◆ classof()

static bool llvm::ScalableVectorType::classof ( const Type T)
inlinestatic

Definition at line 624 of file DerivedTypes.h.

References llvm::Type::ScalableVectorTyID, and T.

◆ get() [1/2]

static ScalableVectorType* llvm::ScalableVectorType::get ( Type ElementType,
const ScalableVectorType SVTy 
)
inlinestatic

Definition at line 582 of file DerivedTypes.h.

References get(), and getMinNumElements().

◆ get() [2/2]

ScalableVectorType * ScalableVectorType::get ( Type ElementType,
unsigned  MinNumElts 
)
static

◆ getDoubleElementsVectorType()

static ScalableVectorType* llvm::ScalableVectorType::getDoubleElementsVectorType ( ScalableVectorType VTy)
inlinestatic

Definition at line 615 of file DerivedTypes.h.

References llvm::VectorType::getDoubleElementsVectorType().

◆ getExtendedElementVectorType()

static ScalableVectorType* llvm::ScalableVectorType::getExtendedElementVectorType ( ScalableVectorType VTy)
inlinestatic

Definition at line 592 of file DerivedTypes.h.

References llvm::VectorType::getExtendedElementVectorType().

◆ getHalfElementsVectorType()

static ScalableVectorType* llvm::ScalableVectorType::getHalfElementsVectorType ( ScalableVectorType VTy)
inlinestatic

Definition at line 610 of file DerivedTypes.h.

References llvm::VectorType::getHalfElementsVectorType().

◆ getInteger()

static ScalableVectorType* llvm::ScalableVectorType::getInteger ( ScalableVectorType VTy)
inlinestatic

Definition at line 587 of file DerivedTypes.h.

References llvm::VectorType::getInteger().

◆ getMinNumElements()

uint64_t llvm::ScalableVectorType::getMinNumElements ( ) const
inline

Get the minimum number of elements in this vector.

The actual number of elements in the vector is an integer multiple of this value.

Definition at line 622 of file DerivedTypes.h.

References llvm::VectorType::ElementQuantity.

Referenced by get().

◆ getSubdividedVectorType()

static ScalableVectorType* llvm::ScalableVectorType::getSubdividedVectorType ( ScalableVectorType VTy,
int  NumSubdivs 
)
inlinestatic

Definition at line 603 of file DerivedTypes.h.

References llvm::VectorType::getSubdividedVectorType().

◆ getTruncatedElementVectorType()

static ScalableVectorType* llvm::ScalableVectorType::getTruncatedElementVectorType ( ScalableVectorType VTy)
inlinestatic

Definition at line 598 of file DerivedTypes.h.

References llvm::VectorType::getTruncatedElementVectorType().


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