#include <Types.h>

Inheritance diagram for mlir::Type:

[legend]

Collaboration diagram for mlir::Type:

Public Types
enum	Kind { Function, Opaque, LAST_BUILTIN_TYPE = Opaque, DEFINE_SYM_KIND_RANGE, DEFINE_SYM_KIND_RANGE }

template<typename ConcreteType , typename BaseType , typename StorageType = DefaultTypeStorage>
using	TypeBase = detail::StorageUserBase< ConcreteType, BaseType, StorageType, detail::TypeUniquer >
	Utility class for implementing types. More...

using	ImplType = TypeStorage

Public Member Functions
	Type ()

	Type (const ImplType *impl)

	Type (const Type &other)=default

Type &	operator= (const Type &other)=default

bool	operator== (Type other) const

bool	operator!= (Type other) const

	operator bool () const

bool	operator! () const

template<typename U >
bool	isa () const

template<typename U >
U	dyn_cast () const

template<typename U >
U	dyn_cast_or_null () const

template<typename U >
U	cast () const

unsigned	getKind () const
	Return the classification for this type. More...

MLIRContext *	getContext () const
	Return the LLVMContext in which this type was uniqued. More...

Dialect &	getDialect () const
	Get the dialect this type is registered to. More...

bool	isIndex ()

bool	isBF16 ()

bool	isF16 ()

bool	isF32 ()

bool	isF64 ()

bool	isInteger (unsigned width)
	Return true if this is an integer type with the specified width. More...

unsigned	getIntOrFloatBitWidth ()

bool	isIntOrIndex ()
	Return true if this is an integer or index type. More...

bool	isIntOrIndexOrFloat ()
	Return true if this is an integer, index, or float type. More...

bool	isIntOrFloat ()
	Return true of this is an integer or a float type. More...

void	print (raw_ostream &os)
	Print the current type. More...

void	dump ()

unsigned	getSubclassData () const

void	setSubclassData (unsigned val)

const void *	getAsOpaquePointer () const
	Methods for supporting PointerLikeTypeTraits. More...

Static Public Member Functions
static bool	classof (Type)

static Type	getFromOpaquePointer (const void *pointer)

Protected Attributes
ImplType *	impl

Friends
::llvm::hash_code	hash_value (Type arg)

Detailed Description

Instances of the Type class are immutable and uniqued. They wrap a pointer to the storage object owned by MLIRContext. Therefore, instances of Type are passed around by value.

Some types are "primitives" meaning they do not have any parameters, for example the Index type. Parametric types have additional information that differentiates the types of the same kind between them, for example the Integer type has bitwidth, making i8 and i16 belong to the same kind by be different instances of the IntegerType.

Types are constructed and uniqued via the 'detail::TypeUniquer' class.

Derived type classes are expected to implement several required implementation hooks:

Required:
- static bool kindof(unsigned kind);
  - Returns if the provided type kind corresponds to an instance of the current type. Used for isa/dyn_cast casting functionality.
Optional:
- static LogicalResult verifyConstructionInvariants( Optional<Location> loc, MLIRContext *context, Args... args)
  - This method is invoked when calling the 'TypeBase::get/getChecked' methods to ensure that the arguments passed in are valid to construct a type instance with.
  - This method is expected to return failure if a type cannot be constructed with 'args', success otherwise.
  - 'args' must correspond with the arguments passed into the 'TypeBase::get' call after the type kind.

Type storage objects inherit from TypeStorage and contain the following:

The type kind (for LLVM-style RTTI).
The dialect that defined the type.
Any parameters of the type. For non-parametric types, a convenience DefaultTypeStorage is provided. Parametric storage types must derive TypeStorage and respect the following:
Define a type alias, KeyTy, to a type that uniquely identifies the instance of the type within its kind.
- The key type must be constructible from the values passed into the detail::TypeUniquer::get call after the type kind.
- If the KeyTy does not have an llvm::DenseMapInfo specialization, the storage class must define a hashing method: 'static unsigned hashKey(const KeyTy &)'
Provide a method, 'bool operator==(const KeyTy &) const', to compare the storage instance against an instance of the key type.
Provide a construction method: 'DerivedStorage *construct(TypeStorageAllocator &, const KeyTy &key)' that builds a unique instance of the derived storage. The arguments to this function are an allocator to store any uniqued data within the context and the key type for this storage.

Member Typedef Documentation

◆ ImplType

using mlir::Type::ImplType = TypeStorage

◆ TypeBase

template<typename ConcreteType , typename BaseType , typename StorageType = DefaultTypeStorage>

using mlir::Type::TypeBase = detail::StorageUserBase<ConcreteType, BaseType, StorageType, detail::TypeUniquer>

Utility class for implementing types.

Member Enumeration Documentation

◆ Kind

enum mlir::Type::Kind

Integer identifier for all the concrete type kinds. Note: This is not an enum class as each dialect will likely define a separate enumeration for the specific types that they define. Not being an enum class also simplifies the handling of type kinds by not requiring casts for each use.

Enumerator
Function
Opaque
LAST_BUILTIN_TYPE
DEFINE_SYM_KIND_RANGE
DEFINE_SYM_KIND_RANGE

Constructor & Destructor Documentation

◆ Type() [1/3]

mlir::Type::Type ( )

inline

◆ Type() [2/3]

mlir::Type::Type ( const ImplType * impl )

inline

◆ Type() [3/3]

mlir::Type::Type ( const Type & other )

default

Member Function Documentation

◆ cast()

template<typename U >

U mlir::Type::cast ( ) const

◆ classof()

static bool mlir::Type::classof ( Type )

inlinestatic

◆ dump()

void Type::dump ( )

◆ dyn_cast()

template<typename U >

U mlir::Type::dyn_cast ( ) const

◆ dyn_cast_or_null()

template<typename U >

U mlir::Type::dyn_cast_or_null ( ) const

◆ getAsOpaquePointer()

const void* mlir::Type::getAsOpaquePointer ( ) const

inline

Methods for supporting PointerLikeTypeTraits.

◆ getContext()

MLIRContext * Type::getContext ( ) const

Return the LLVMContext in which this type was uniqued.

◆ getDialect()

Dialect Type::getDialect ( ) const

Get the dialect this type is registered to.

◆ getFromOpaquePointer()

static Type mlir::Type::getFromOpaquePointer ( const void * pointer )

inlinestatic

◆ getIntOrFloatBitWidth()

unsigned Type::getIntOrFloatBitWidth ( )

Return the bit width of an integer or a float type, assert failure on other types.

◆ getKind()

unsigned Type::getKind ( ) const

Return the classification for this type.

◆ getSubclassData()

unsigned Type::getSubclassData ( ) const

◆ isa()

template<typename U >

bool mlir::Type::isa ( ) const

◆ isBF16()

bool Type::isBF16 ( )

◆ isF16()

bool Type::isF16 ( )

◆ isF32()

bool Type::isF32 ( )

◆ isF64()

bool Type::isF64 ( )

◆ isIndex()

bool Type::isIndex ( )

◆ isInteger()

bool Type::isInteger ( unsigned width )

Return true if this is an integer type with the specified width.

◆ isIntOrFloat()

bool Type::isIntOrFloat ( )

Return true of this is an integer or a float type.

◆ isIntOrIndex()

bool Type::isIntOrIndex ( )

Return true if this is an integer or index type.

◆ isIntOrIndexOrFloat()

bool Type::isIntOrIndexOrFloat ( )

Return true if this is an integer, index, or float type.

◆ operator bool()

mlir::Type::operator bool ( ) const

inlineexplicit

◆ operator!()

bool mlir::Type::operator! ( ) const

inline

◆ operator!=()

bool mlir::Type::operator!= ( Type other ) const

inline

◆ operator=()

Type& mlir::Type::operator= ( const Type & other )

default

◆ operator==()

bool mlir::Type::operator== ( Type other ) const

inline

◆ print()

void Type::print ( raw_ostream & os )

Print the current type.

◆ setSubclassData()

void Type::setSubclassData ( unsigned val )

Friends And Related Function Documentation

◆ hash_value

::llvm::hash_code hash_value ( Type arg )

friend

Member Data Documentation

◆ impl

ImplType* mlir::Type::impl

protected

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

include/mlir/IR/Types.h
lib/IR/AsmPrinter.cpp
lib/IR/StandardTypes.cpp
lib/IR/Types.cpp
lib/TableGen/Type.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ImplType

◆ TypeBase

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ Type() [1/3]

◆ Type() [2/3]

◆ Type() [3/3]

Member Function Documentation

◆ cast()

◆ classof()

◆ dump()

◆ dyn_cast()

◆ dyn_cast_or_null()

◆ getAsOpaquePointer()

◆ getContext()

◆ getDialect()

◆ getFromOpaquePointer()

◆ getIntOrFloatBitWidth()

◆ getKind()

◆ getSubclassData()

◆ isa()

◆ isBF16()

◆ isF16()

◆ isF32()

◆ isF64()

◆ isIndex()

◆ isInteger()

◆ isIntOrFloat()

◆ isIntOrIndex()

◆ isIntOrIndexOrFloat()

◆ operator bool()

◆ operator!()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ print()

◆ setSubclassData()

Friends And Related Function Documentation

◆ hash_value

Member Data Documentation

◆ impl