MLIR  17.0.0git
Public Member Functions | Static Public Member Functions | List of all members
mlir::TensorType Class Reference

Tensor types represent multi-dimensional arrays, and have two variants: RankedTensorType and UnrankedTensorType. More...

#include "mlir/IR/BuiltinTypes.h"

+ Inheritance diagram for mlir::TensorType:
+ Collaboration diagram for mlir::TensorType:

Public Member Functions

Type getElementType () const
 Returns the element type of this tensor 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 tensor type. More...
 
TensorType cloneWith (std::optional< ArrayRef< int64_t >> shape, Type elementType) const
 Clone this type with the given shape and element type. More...
 
 operator ShapedType () const
 Allow implicit conversion to ShapedType. 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
 
Typeoperator= (const Type &other)=default
 
bool operator== (Type other) const
 
bool operator!= (Type other) const
 
 operator bool () const
 
bool operator! () const
 
template<typename... Tys>
bool isa () const
 
template<typename... Tys>
bool isa_and_nonnull () const
 
template<typename U >
dyn_cast () const
 
template<typename U >
dyn_cast_or_null () const
 
template<typename U >
cast () const
 
TypeID getTypeID ()
 Return a unique identifier for the concrete type. More...
 
MLIRContextgetContext () const
 Return the MLIRContext in which this type was uniqued. More...
 
DialectgetDialect () const
 Get the dialect this type is registered to. More...
 
bool isIndex () const
 
bool isFloat8E5M2 () const
 
bool isFloat8E4M3FN () const
 
bool isBF16 () const
 
bool isF16 () const
 
bool isF32 () const
 
bool isF64 () const
 
bool isF80 () const
 
bool isF128 () const
 
bool isInteger (unsigned width) const
 Return true if this is an integer type with the specified width. More...
 
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<template< typename T > class Trait>
bool hasTrait ()
 Returns true if the type was registered with a particular trait. More...
 
const AbstractTygetAbstractType () const
 Return the abstract type descriptor for this type. More...
 
ImplTypegetImpl () 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 tensor. 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 bool classof (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
ImplTypeimpl {nullptr}
 

Detailed Description

Tensor types represent multi-dimensional arrays, and have two variants: RankedTensorType and UnrankedTensorType.

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 tensor types.

Definition at line 77 of file BuiltinTypes.h.

Member Function Documentation

◆ classof()

bool mlir::TensorType::classof ( Type  type)
inlinestatic

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

Definition at line 413 of file BuiltinTypes.h.

References mlir::Type::isa().

◆ cloneWith()

TensorType TensorType::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 None, the current shape of the type is used.

Definition at line 271 of file BuiltinTypes.cpp.

◆ getElementType()

Type TensorType::getElementType ( ) const

Returns the element type of this tensor type.

Definition at line 259 of file BuiltinTypes.cpp.

Referenced by convertTensorType(), and joinShapes().

◆ getShape()

ArrayRef< int64_t > TensorType::getShape ( ) const

Returns the shape of this tensor type.

Definition at line 267 of file BuiltinTypes.cpp.

◆ hasRank()

bool TensorType::hasRank ( ) const

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

Definition at line 265 of file BuiltinTypes.cpp.

Referenced by joinShapes().

◆ isValidElementType()

bool TensorType::isValidElementType ( Type  type)
static

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

Definition at line 297 of file BuiltinTypes.cpp.

References mlir::Type::getDialect(), and mlir::Type::isa().

Referenced by checkTensorElementType(), and mlir::detail::Parser::parseTensorType().

◆ operator ShapedType()

mlir::TensorType::operator ShapedType ( ) const
inline

Allow implicit conversion to ShapedType.

Definition at line 102 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: