This class provides a shared interface for ranked and unranked memref types. More...

#include "mlir/IR/BuiltinTypes.h"

Inheritance diagram for mlir::BaseMemRefType:

Public Member Functions
Type	getElementType () const
	Returns the element type of this memref type. More...

bool	hasRank () const
	Returns if this type is ranked, i.e. it has a known number of dimensions. More...

ArrayRef< int64_t >	getShape () const
	Returns the shape of this memref type. More...

BaseMemRefType	cloneWith (std::optional< ArrayRef< int64_t >> shape, Type elementType) const
	Clone this type with the given shape and element type. More...

FailureOr< PtrLikeTypeInterface >	clonePtrWith (Attribute memorySpace, std::optional< Type > elementType) const
	Clone this type with the given memory space and element type. More...

MemRefType	clone (ArrayRef< int64_t > shape, Type elementType) const
	Return a clone of this type with the given new shape and element type. More...

MemRefType	clone (ArrayRef< int64_t > shape) const
	Return a clone of this type with the given new shape. More...

Attribute	getMemorySpace () const
	Returns the memory space in which data referred to by this memref resides. More...

unsigned	getMemorySpaceAsInt () const
	[deprecated] Returns the memory space in old raw integer representation. More...

bool	hasPtrMetadata () const
	Returns that this ptr-like object has non-empty ptr metadata. More...

	operator ShapedType () const
	Allow implicit conversion to ShapedType. More...

	operator PtrLikeTypeInterface () const
	Allow implicit conversion to PtrLikeTypeInterface. More...

constexpr	Type ()=default

	Type (const ImplType *impl)

	Type (const Type &other)=default

Public Member Functions inherited from mlir::Type
constexpr	Type ()=default

	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

TypeID	getTypeID ()
	Return a unique identifier for the concrete type. More...

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

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

bool	isIndex () const

bool	isBF16 () const

bool	isF16 () const

bool	isTF32 () const

bool	isF32 () const

bool	isF64 () const

bool	isF80 () const

bool	isF128 () const

bool	isFloat () const
	Return true if this is an float type (with the specified width). More...

bool	isFloat (unsigned width) const
	Return true if this is a float type with the specified width. More...

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

bool	isInteger (unsigned width) const

bool	isSignlessInteger () const
	Return true if this is a signless integer type (with the specified width). More...

bool	isSignlessInteger (unsigned width) const

bool	isSignedInteger () const
	Return true if this is a signed integer type (with the specified width). More...

bool	isSignedInteger (unsigned width) const

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

bool	isUnsignedInteger (unsigned width) const

unsigned	getIntOrFloatBitWidth () const
	Return the bit width of an integer or a float type, assert failure on other types. More...

bool	isSignlessIntOrIndex () const
	Return true if this is a signless integer or index type. More...

bool	isSignlessIntOrIndexOrFloat () const
	Return true if this is a signless integer, index, or float type. More...

bool	isSignlessIntOrFloat () const
	Return true of this is a signless integer or a float type. More...

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

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

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

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

void	print (raw_ostream &os, AsmState &state) const

void	dump () const

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

template<typename InterfaceT >
bool	hasPromiseOrImplementsInterface ()
	Returns true if `InterfaceT` has been promised by the dialect or implemented. More...

template<template< typename T > class Trait>
bool	hasTrait ()
	Returns true if the type was registered with a particular trait. More...

const AbstractTy &	getAbstractType () const
	Return the abstract type descriptor for this type. More...

ImplType *	getImpl () const
	Return the Type implementation. More...

void	walkImmediateSubElements (function_ref< void(Attribute)> walkAttrsFn, function_ref< void(Type)> walkTypesFn) const
	Walk all of the immediately nested sub-attributes and sub-types. More...

auto	replaceImmediateSubElements (ArrayRef< Attribute > replAttrs, ArrayRef< Type > replTypes) const
	Replace the immediately nested sub-attributes and sub-types with those provided. More...

template<WalkOrder Order = WalkOrder::PostOrder, typename... WalkFns>
auto	walk (WalkFns &&...walkFns)
	Walk this type and all attibutes/types nested within using the provided walk functions. More...

template<typename... ReplacementFns>
auto	replace (ReplacementFns &&...replacementFns)
	Recursively replace all of the nested sub-attributes and sub-types using the provided map functions. More...

Static Public Member Functions
static bool	isValidElementType (Type type)
	Return true if the specified element type is ok in a memref. More...

static bool	classof (Type type)
	Methods for support type inquiry through isa, cast, and dyn_cast. More...

Static Public Member Functions inherited from mlir::Type
static Type	getFromOpaquePointer (const void *pointer)

Additional Inherited Members
Public Types inherited from mlir::Type
template<typename ConcreteType , typename BaseType , typename StorageType , template< typename T > class... Traits>
using	TypeBase = detail::StorageUserBase< ConcreteType, BaseType, StorageType, detail::TypeUniquer, Traits... >
	Utility class for implementing types. More...

using	ImplType = TypeStorage

using	AbstractTy = AbstractType

Protected Attributes inherited from mlir::Type
ImplType *	impl {nullptr}

Detailed Description

This class provides a shared interface for ranked and unranked memref types.

Note: This class attaches the ShapedType trait to act as a mixin to provide many useful utility functions. This inheritance has no effect on derived memref types.

Definition at line 102 of file BuiltinTypes.h.

Member Function Documentation

◆ classof()

bool mlir::BaseMemRefType::classof ( Type type )

inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast.

Definition at line 409 of file BuiltinTypes.h.

◆ clone() [1/2]

MemRefType mlir::BaseMemRefType::clone ( ArrayRef< int64_t > shape ) const

Return a clone of this type with the given new shape.

The returned type is ranked, even if this type is unranked.

◆ clone() [2/2]

MemRefType mlir::BaseMemRefType::clone	(	ArrayRef< int64_t >	shape,
		Type	elementType
	)		const

Return a clone of this type with the given new shape and element type.

The returned type is ranked, even if this type is unranked.

◆ clonePtrWith()

FailureOr< PtrLikeTypeInterface > BaseMemRefType::clonePtrWith	(	Attribute	memorySpace,
		std::optional< Type >	elementType
	)		const

Clone this type with the given memory space and element type.

If the provided element type is std::nullopt, the current element type of the type is used.

Definition at line 417 of file BuiltinTypes.cpp.

References mlir::get(), getElementType(), mlir::MemRefType::Builder::setElementType(), and mlir::MemRefType::Builder::setMemorySpace().

Referenced by getMemorySpaceCastInfo().

◆ cloneWith()

BaseMemRefType BaseMemRefType::cloneWith	(	std::optional< ArrayRef< int64_t >>	shape,
		Type	elementType
	)		const

Clone this type with the given shape and element type.

If the provided shape is std::nullopt, the current shape of the type is used.

Definition at line 399 of file BuiltinTypes.cpp.

References mlir::get(), mlir::MemRefType::Builder::setElementType(), mlir::MemRefType::Builder::setMemorySpace(), and mlir::MemRefType::Builder::setShape().

◆ getElementType()

Type BaseMemRefType::getElementType ( ) const

Returns the element type of this memref type.

Definition at line 385 of file BuiltinTypes.cpp.

Referenced by mlir::spirv::MemorySpaceToStorageClassConverter::MemorySpaceToStorageClassConverter().

◆ getMemorySpace()

Attribute BaseMemRefType::getMemorySpace ( ) const

Returns the memory space in which data referred to by this memref resides.

Definition at line 439 of file BuiltinTypes.cpp.

Referenced by mlir::LLVMTypeConverter::getMemRefAddressSpace(), hasDefaultMemorySpace(), hasSharedMemorySpace(), and mlir::spirv::MemorySpaceToStorageClassConverter::MemorySpaceToStorageClassConverter().

◆ getMemorySpaceAsInt()

unsigned BaseMemRefType::getMemorySpaceAsInt ( ) const

[deprecated] Returns the memory space in old raw integer representation.

New Attribute getMemorySpace() method should be used instead.

Definition at line 445 of file BuiltinTypes.cpp.

Referenced by hasDefaultMemorySpace().

◆ getShape()

ArrayRef< int64_t > BaseMemRefType::getShape ( ) const

Returns the shape of this memref type.

Definition at line 395 of file BuiltinTypes.cpp.

Referenced by mlir::spirv::MemorySpaceToStorageClassConverter::MemorySpaceToStorageClassConverter().

◆ hasPtrMetadata()

bool mlir::BaseMemRefType::hasPtrMetadata ( ) const

inline

Returns that this ptr-like object has non-empty ptr metadata.

Definition at line 153 of file BuiltinTypes.h.

◆ hasRank()

bool BaseMemRefType::hasRank ( ) const

Returns if this type is ranked, i.e. it has a known number of dimensions.

Definition at line 391 of file BuiltinTypes.cpp.

◆ isValidElementType()

bool mlir::BaseMemRefType::isValidElementType ( Type type )

inlinestatic

Return true if the specified element type is ok in a memref.

Definition at line 413 of file BuiltinTypes.h.

References mlir::Type::isIntOrIndexOrFloat().

Referenced by mlir::detail::Parser::parseMemRefType().

◆ operator PtrLikeTypeInterface()

mlir::BaseMemRefType::operator PtrLikeTypeInterface ( ) const

inline

Allow implicit conversion to PtrLikeTypeInterface.

Definition at line 159 of file BuiltinTypes.h.

◆ operator ShapedType()

mlir::BaseMemRefType::operator ShapedType ( ) const

inline

Allow implicit conversion to ShapedType.

Definition at line 156 of file BuiltinTypes.h.

◆ Type() [1/3]

constexpr mlir::Type::Type

constexprdefault

◆ Type() [2/3]

mlir::Type::Type

inline

Definition at line 87 of file Types.h.

◆ Type() [3/3]

mlir::Type::Type

default

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

include/mlir/IR/BuiltinTypes.h
lib/IR/BuiltinTypes.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ clone() [1/2]

◆ clone() [2/2]

◆ clonePtrWith()

◆ cloneWith()

◆ getElementType()

◆ getMemorySpace()

◆ getMemorySpaceAsInt()

◆ getShape()

◆ hasPtrMetadata()

◆ hasRank()

◆ isValidElementType()

◆ operator PtrLikeTypeInterface()

◆ operator ShapedType()

◆ Type() [1/3]

◆ Type() [2/3]

◆ Type() [3/3]