Base type for affine expression. More...

#include "mlir/IR/AffineExpr.h"

Inheritance diagram for mlir::AffineExpr:

Public Types
using	ImplType = detail::AffineExprStorage

Public Member Functions
constexpr	AffineExpr ()

	AffineExpr (const ImplType *expr)

bool	operator== (AffineExpr other) const

bool	operator!= (AffineExpr other) const

bool	operator== (int64_t v) const

bool	operator!= (int64_t v) const

	operator bool () const

bool	operator! () const

template<typename U >
constexpr 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

MLIRContext *	getContext () const

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

void	print (raw_ostream &os) const

void	dump () const

bool	isSymbolicOrConstant () const
	Returns true if this expression is made out of only symbols and constants, i.e., it does not involve dimensional identifiers. More...

bool	isPureAffine () const
	Returns true if this is a pure affine expression, i.e., multiplication, floordiv, ceildiv, and mod is only allowed w.r.t constants. More...

int64_t	getLargestKnownDivisor () const
	Returns the greatest known integral divisor of this affine expression. More...

bool	isMultipleOf (int64_t factor) const
	Return true if the affine expression is a multiple of 'factor'. More...

bool	isFunctionOfDim (unsigned position) const
	Return true if the affine expression involves AffineDimExpr `position`. More...

bool	isFunctionOfSymbol (unsigned position) const
	Return true if the affine expression involves AffineSymbolExpr `position`. More...

template<typename FnT , typename RetT = detail::walkResultType<FnT>>
RetT	walk (FnT &&callback) const
	Walk all of the AffineExpr's in this expression in postorder. More...

AffineExpr	replaceDimsAndSymbols (ArrayRef< AffineExpr > dimReplacements, ArrayRef< AffineExpr > symReplacements) const
	This method substitutes any uses of dimensions and symbols (e.g. More...

AffineExpr	replaceDims (ArrayRef< AffineExpr > dimReplacements) const
	Dim-only version of replaceDimsAndSymbols. More...

AffineExpr	replaceSymbols (ArrayRef< AffineExpr > symReplacements) const
	Symbol-only version of replaceDimsAndSymbols. More...

AffineExpr	replace (AffineExpr expr, AffineExpr replacement) const
	Sparse replace method. More...

AffineExpr	replace (const DenseMap< AffineExpr, AffineExpr > &map) const
	Sparse replace method. More...

AffineExpr	shiftDims (unsigned numDims, unsigned shift, unsigned offset=0) const
	Replace dims[offset ... More...

AffineExpr	shiftSymbols (unsigned numSymbols, unsigned shift, unsigned offset=0) const
	Replace symbols[offset ... More...

AffineExpr	operator+ (int64_t v) const

AffineExpr	operator+ (AffineExpr other) const

AffineExpr	operator- () const

AffineExpr	operator- (int64_t v) const

AffineExpr	operator- (AffineExpr other) const

AffineExpr	operator* (int64_t v) const

AffineExpr	operator* (AffineExpr other) const

AffineExpr	floorDiv (uint64_t v) const

AffineExpr	floorDiv (AffineExpr other) const

AffineExpr	ceilDiv (uint64_t v) const

AffineExpr	ceilDiv (AffineExpr other) const

AffineExpr	operator% (uint64_t v) const

AffineExpr	operator% (AffineExpr other) const

AffineExpr	compose (AffineMap map) const
	Compose with an AffineMap. More...

const void *	getAsOpaquePointer () const
	Methods supporting C API. More...

ImplType *	getImpl () const

Static Public Member Functions
static AffineExpr	getFromOpaquePointer (const void *pointer)

Protected Attributes
ImplType *	expr {nullptr}

Friends
::llvm::hash_code	hash_value (AffineExpr arg)
	Make AffineExpr hashable. More...

Detailed Description

Base type for affine expression.

AffineExpr's are immutable value types with intuitive operators to operate on chainable, lightweight compositions. An AffineExpr is an interface to the underlying storage type pointer.

Definition at line 69 of file AffineExpr.h.

Member Typedef Documentation

◆ ImplType

using mlir::AffineExpr::ImplType = detail::AffineExprStorage

Definition at line 71 of file AffineExpr.h.

Constructor & Destructor Documentation

◆ AffineExpr() [1/2]

constexpr mlir::AffineExpr::AffineExpr ( )

inlineconstexpr

Definition at line 73 of file AffineExpr.h.

Referenced by getFromOpaquePointer().

◆ AffineExpr() [2/2]

mlir::AffineExpr::AffineExpr ( const ImplType * expr )

inline

Definition at line 74 of file AffineExpr.h.

Member Function Documentation

◆ cast()

template<typename U >

U mlir::AffineExpr::cast

Definition at line 312 of file AffineExpr.h.

◆ ceilDiv() [1/2]

AffineExpr AffineExpr::ceilDiv ( AffineExpr other ) const

Definition at line 929 of file AffineExpr.cpp.

References mlir::CeilDiv, mlir::StorageUniquer::get(), mlir::MLIRContext::getAffineUniquer(), getContext(), and simplifyCeilDiv().

◆ ceilDiv() [2/2]

AffineExpr AffineExpr::ceilDiv ( uint64_t v ) const

Definition at line 926 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

Referenced by calculateTileOffsetsAndSizes(), mlir::affine::AffineBuilder::ceil(), mlir::affine::getTripCountMapAndOperands(), and mlir::linalg::packMatmulGreedily().

◆ compose()

AffineExpr AffineExpr::compose ( AffineMap map ) const

Compose with an AffineMap.

Returns the composition of this AffineExpr with map.

Prerequisites: this and map are composable, i.e. that the number of AffineDimExpr of this is smaller than the number of results of map. If a result of a map does not have a corresponding AffineDimExpr, that result simply does not appear in the produced AffineExpr.

Example: expr: d0 + d2 map: (d0, d1, d2)[s0, s1] -> (d0 + s1, d1 + s0, d0 + d1 + d2) returned expr: d0 * 2 + d1 + d2 + s1

Definition at line 994 of file AffineExpr.cpp.

References mlir::AffineMap::getResults(), and replaceDimsAndSymbols().

Referenced by mlir::AffineMap::compose().

◆ dump()

void AffineExpr::dump ( ) const

Definition at line 3837 of file AsmPrinter.cpp.

◆ dyn_cast()

template<typename U >

U mlir::AffineExpr::dyn_cast

Definition at line 304 of file AffineExpr.h.

◆ dyn_cast_or_null()

template<typename U >

U mlir::AffineExpr::dyn_cast_or_null

Definition at line 308 of file AffineExpr.h.

◆ floorDiv() [1/2]

AffineExpr AffineExpr::floorDiv ( AffineExpr other ) const

Definition at line 886 of file AffineExpr.cpp.

References mlir::FloorDiv, mlir::StorageUniquer::get(), mlir::MLIRContext::getAffineUniquer(), getContext(), and simplifyFloorDiv().

◆ floorDiv() [2/2]

AffineExpr AffineExpr::floorDiv ( uint64_t v ) const

Definition at line 883 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

Referenced by mlir::affine::coalesceLoops(), common3DIdBuilderFn(), commonLinearIdBuilderFn(), mlir::delinearize(), mlir::affine::AffineBuilder::floor(), getCompressedMaskOp(), mlir::affine::getDivMod(), getExpandedOutputDimFromInputShape(), getIndicesForLoadOrStore(), mlir::nvgpu::getLaneIdAndValueIdToOperandCoord(), mlir::nvgpu::getLaneIdToLdMatrixMatrixCoord(), mlir::memref::getLinearizedMemRefOffsetAndSize(), getRegisterIndexToTileOffsetMap(), simplifyExprAndOperands(), and mlir::SimpleAffineExprFlattener::visitModExpr().

◆ getAsOpaquePointer()

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

inline

Methods supporting C API.

Definition at line 199 of file AffineExpr.h.

References expr.

◆ getContext()

MLIRContext * AffineExpr::getContext ( ) const

Definition at line 25 of file AffineExpr.cpp.

Referenced by ceilDiv(), mlir::delinearize(), floorDiv(), mlir::AffineMap::get(), mlir::detail::TileOffsetRangeImpl::getDynamicTileOffsets(), getStridesAndOffset(), mlir::isBatchMatvec(), mlir::isBatchVecmat(), mlir::isColumnMajorMatmul(), mlir::isMatvec(), isModOfModSubtraction(), mlir::isRowMajorBatchMatmul(), mlir::isRowMajorMatmul(), mlir::isVecmat(), operator%(), operator*(), operator+(), operator-(), operator==(), simplifyAdd(), mlir::simplifyAffineExpr(), simplifyCeilDiv(), simplifyExprAndOperands(), simplifyFloorDiv(), simplifyMinOrMaxExprWithOperands(), simplifyMod(), simplifyMul(), simplifySemiAffine(), symbolicDivide(), mlir::sparse_tensor::ir_detail::DimLvlExpr::tryGetContext(), mlir::SimpleAffineExprFlattener::visitModExpr(), and mlir::SimpleAffineExprFlattener::visitMulExpr().

◆ getFromOpaquePointer()

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

inlinestatic

Definition at line 202 of file AffineExpr.h.

References AffineExpr().

◆ getImpl()

ImplType* mlir::AffineExpr::getImpl ( ) const

inline

Definition at line 207 of file AffineExpr.h.

References expr.

Referenced by llvm::CastInfo< To, From, std::enable_if_t< std::is_same_v< mlir::AffineExpr, std::remove_const_t< From > >||std::is_base_of_v< mlir::AffineExpr, From > > >::doCast().

◆ getKind()

AffineExprKind AffineExpr::getKind ( ) const

Return the classification for this type.

Definition at line 27 of file AffineExpr.cpp.

Referenced by checkOperandAffineExprRecursively(), findAffine(), findDepIdxSet(), mlir::sparse_tensor::LoopEmitter::genAffine(), genIndex(), mlir::sparse_tensor::genMapBuffers(), mlir::sparse_tensor::ir_detail::DimLvlExpr::getAffineKind(), isa(), isDivisibleBySymbol(), isInvariantAffine(), isModOfModSubtraction(), llvm::CastInfo< To, From, std::enable_if_t< std::is_same_v< mlir::AffineExpr, std::remove_const_t< From > >||std::is_base_of_v< mlir::AffineExpr, From > > >::isPossible(), mlir::AsmPrinter::Impl::printAffineExprInternal(), simplifyAdd(), simplifyExprAndOperands(), simplifySemiAffine(), symbolicDivide(), mlir::AffineExprVisitorBase< SubClass, RetTy >::visit(), mlir::AffineExprVisitor< SubClass, RetTy >::walkPostOrder(), and mlir::AffineExprVisitor< SubClass, LogicalResult >::walkPostOrder().

◆ getLargestKnownDivisor()

int64_t AffineExpr::getLargestKnownDivisor ( ) const

Returns the greatest known integral divisor of this affine expression.

The result is always positive.

Definition at line 235 of file AffineExpr.cpp.

References mlir::presburger::abs(), mlir::Add, mlir::CeilDiv, mlir::Constant, mlir::DimId, mlir::FloorDiv, mlir::presburger::gcd(), getLargestKnownDivisor(), mlir::AffineBinaryOpExpr::getLHS(), mlir::AffineBinaryOpExpr::getRHS(), mlir::Mod, mlir::Mul, and mlir::SymbolId.

Referenced by getLargestKnownDivisor(), getLargestKnownDivisor(), isMultipleOf(), and simplifyMod().

◆ isa()

template<typename U >

constexpr bool mlir::AffineExpr::isa

constexpr

Definition at line 293 of file AffineExpr.h.

References mlir::Constant, mlir::DimId, getKind(), mlir::LAST_AFFINE_BINARY_OP, and mlir::SymbolId.

◆ isFunctionOfDim()

bool AffineExpr::isFunctionOfDim ( unsigned position ) const

Return true if the affine expression involves AffineDimExpr position.

Definition at line 308 of file AffineExpr.cpp.

References mlir::DimId, mlir::getAffineDimExpr(), and getContext().

Referenced by getFirstResultIndexFunctionOf(), mlir::affine::AffineValueMap::isFunctionOf(), and mlir::AffineMap::isFunctionOfDim().

◆ isFunctionOfSymbol()

bool AffineExpr::isFunctionOfSymbol ( unsigned position ) const

Return true if the affine expression involves AffineSymbolExpr position.

Definition at line 319 of file AffineExpr.cpp.

References mlir::getAffineSymbolExpr(), getContext(), and mlir::SymbolId.

Referenced by mlir::AffineMap::isFunctionOfSymbol().

◆ isMultipleOf()

bool AffineExpr::isMultipleOf ( int64_t factor ) const

Return true if the affine expression is a multiple of 'factor'.

Definition at line 275 of file AffineExpr.cpp.

References mlir::Add, mlir::CeilDiv, mlir::Constant, mlir::DimId, mlir::FloorDiv, mlir::presburger::gcd(), getLargestKnownDivisor(), mlir::AffineBinaryOpExpr::getLHS(), mlir::AffineBinaryOpExpr::getRHS(), mlir::Mod, mlir::Mul, and mlir::SymbolId.

◆ isPureAffine()

bool AffineExpr::isPureAffine ( ) const

Returns true if this is a pure affine expression, i.e., multiplication, floordiv, ceildiv, and mod is only allowed w.r.t constants.

Definition at line 204 of file AffineExpr.cpp.

References mlir::Add, mlir::Constant, mlir::DimId, and mlir::SymbolId.

Referenced by mlir::simplifyAffineExpr().

◆ isSymbolicOrConstant()

bool AffineExpr::isSymbolicOrConstant ( ) const

Returns true if this expression is made out of only symbols and constants, i.e., it does not involve dimensional identifiers.

Returns true if this expression is made out of only symbols and constants (no dimensional identifiers).

Definition at line 180 of file AffineExpr.cpp.

References mlir::Add, mlir::CeilDiv, mlir::Constant, mlir::DimId, mlir::FloorDiv, mlir::Mod, mlir::Mul, and mlir::SymbolId.

Referenced by simplifyAdd(), and simplifyMul().

◆ operator bool()

mlir::AffineExpr::operator bool ( ) const

inlineexplicit

Definition at line 81 of file AffineExpr.h.

References expr.

◆ operator!()

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

inline

Definition at line 83 of file AffineExpr.h.

References expr.

◆ operator!=() [1/2]

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

inline

Definition at line 78 of file AffineExpr.h.

◆ operator!=() [2/2]

bool mlir::AffineExpr::operator!= ( int64_t v ) const

inline

Definition at line 80 of file AffineExpr.h.

◆ operator%() [1/2]

AffineExpr AffineExpr::operator% ( AffineExpr other ) const

Definition at line 985 of file AffineExpr.cpp.

References mlir::StorageUniquer::get(), mlir::MLIRContext::getAffineUniquer(), getContext(), mlir::Mod, and simplifyMod().

◆ operator%() [2/2]

AffineExpr AffineExpr::operator% ( uint64_t v ) const

Definition at line 982 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

◆ operator*() [1/2]

AffineExpr AffineExpr::operator* ( AffineExpr other ) const

Definition at line 820 of file AffineExpr.cpp.

References mlir::StorageUniquer::get(), mlir::MLIRContext::getAffineUniquer(), getContext(), mlir::Mul, and simplifyMul().

◆ operator*() [2/2]

AffineExpr AffineExpr::operator* ( int64_t v ) const

Definition at line 817 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

◆ operator+() [1/2]

AffineExpr AffineExpr::operator+ ( AffineExpr other ) const

Definition at line 759 of file AffineExpr.cpp.

References mlir::Add, mlir::StorageUniquer::get(), mlir::MLIRContext::getAffineUniquer(), getContext(), and simplifyAdd().

◆ operator+() [2/2]

AffineExpr AffineExpr::operator+ ( int64_t v ) const

Definition at line 756 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

◆ operator-() [1/3]

AffineExpr AffineExpr::operator- ( ) const

Definition at line 830 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

◆ operator-() [2/3]

AffineExpr AffineExpr::operator- ( AffineExpr other ) const

Definition at line 836 of file AffineExpr.cpp.

◆ operator-() [3/3]

AffineExpr AffineExpr::operator- ( int64_t v ) const

Definition at line 835 of file AffineExpr.cpp.

◆ operator==() [1/2]

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

inline

Definition at line 77 of file AffineExpr.h.

References expr.

◆ operator==() [2/2]

bool AffineExpr::operator== ( int64_t v ) const

Definition at line 619 of file AffineExpr.cpp.

References mlir::getAffineConstantExpr(), and getContext().

◆ print()

void AffineExpr::print ( raw_ostream & os ) const

Definition at line 3828 of file AsmPrinter.cpp.

Referenced by mlir::operator<<().

◆ replace() [1/2]

AffineExpr AffineExpr::replace	(	AffineExpr	expr,
		AffineExpr	replacement
	)		const

Sparse replace method.

Sparse replace method. Return the modified expression tree.

Replace expr by replacement and return the modified expression tree.

Definition at line 173 of file AffineExpr.cpp.

◆ replace() [2/2]

AffineExpr AffineExpr::replace ( const DenseMap< AffineExpr, AffineExpr > & map ) const

Sparse replace method.

Sparse replace method. Return the modified expression tree.

If *this appears in map replaces it by map[*this] and return the modified expression tree. Otherwise traverse *this and apply replace with map on its subexpressions.

Definition at line 149 of file AffineExpr.cpp.

References mlir::Add, mlir::CeilDiv, mlir::FloorDiv, mlir::getAffineBinaryOpExpr(), mlir::Mod, and mlir::Mul.

◆ replaceDims()

AffineExpr AffineExpr::replaceDims ( ArrayRef< AffineExpr > dimReplacements ) const

Dim-only version of replaceDimsAndSymbols.

Definition at line 114 of file AffineExpr.cpp.

Referenced by projectCommonImpl().

◆ replaceDimsAndSymbols()

AffineExpr AffineExpr::replaceDimsAndSymbols	(	ArrayRef< AffineExpr >	dimReplacements,
		ArrayRef< AffineExpr >	symReplacements
	)		const

This method substitutes any uses of dimensions and symbols (e.g.

dim#0 with dimReplacements[0]) and returns the modified expression tree. This is a dense replacement method: a replacement must be specified for every single dim and symbol.

dim#0 with dimReplacements[0]) and returns the modified expression tree.

Definition at line 81 of file AffineExpr.cpp.

References mlir::Add, mlir::CeilDiv, mlir::Constant, mlir::DimId, mlir::FloorDiv, mlir::getAffineBinaryOpExpr(), mlir::Mod, mlir::Mul, and mlir::SymbolId.

Referenced by compose(), mlir::ValueBoundsConstraintSet::insert(), and mlir::AffineMap::replaceDimsAndSymbols().

◆ replaceSymbols()

AffineExpr AffineExpr::replaceSymbols ( ArrayRef< AffineExpr > symReplacements ) const

Symbol-only version of replaceDimsAndSymbols.

Definition at line 119 of file AffineExpr.cpp.

Referenced by projectCommonImpl().

◆ shiftDims()

AffineExpr AffineExpr::shiftDims	(	unsigned	numDims,
		unsigned	shift,
		unsigned	offset = `0`
	)		const

Replace dims[offset ...

numDims) by dims[offset + shift ... shift + numDims).

Definition at line 125 of file AffineExpr.cpp.

References mlir::getAffineDimExpr(), and getContext().

Referenced by mlir::AffineMap::shiftDims().

◆ shiftSymbols()

AffineExpr AffineExpr::shiftSymbols	(	unsigned	numSymbols,
		unsigned	shift,
		unsigned	offset = `0`
	)		const

Replace symbols[offset ...

numSymbols) by symbols[offset + shift ... shift + numSymbols).

Definition at line 137 of file AffineExpr.cpp.

References mlir::getAffineSymbolExpr(), and getContext().

Referenced by mlir::AffineMap::shiftSymbols().

◆ walk()

template<typename FnT , typename RetT = detail::walkResultType<FnT>>

RetT mlir::AffineExpr::walk ( FnT && callback ) const

inline

Walk all of the AffineExpr's in this expression in postorder.

This allows a lambda walk function that can either return void or a WalkResult. With a WalkResult, interrupting is supported.

Definition at line 131 of file AffineExpr.h.

Referenced by isNormalizedMemRefDynamicDim(), and mlir::AffineMap::walkExprs().

Friends And Related Function Documentation

◆ hash_value

::llvm::hash_code hash_value ( AffineExpr arg )

friend

Make AffineExpr hashable.

Definition at line 261 of file AffineExpr.h.

Member Data Documentation

◆ expr

ImplType* mlir::AffineExpr::expr {nullptr}

protected

Definition at line 210 of file AffineExpr.h.

Referenced by getAsOpaquePointer(), getImpl(), mlir::AffineBinaryOpExpr::getLHS(), mlir::AffineDimExpr::getPosition(), mlir::AffineSymbolExpr::getPosition(), mlir::AffineBinaryOpExpr::getRHS(), mlir::AffineConstantExpr::getValue(), operator bool(), operator!(), and operator==().

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

include/mlir/IR/AffineExpr.h
lib/IR/AffineExpr.cpp
lib/IR/AsmPrinter.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ImplType

Constructor & Destructor Documentation

◆ AffineExpr() [1/2]

◆ AffineExpr() [2/2]

Member Function Documentation

◆ cast()

◆ ceilDiv() [1/2]

◆ ceilDiv() [2/2]

◆ compose()

◆ dump()

◆ dyn_cast()

◆ dyn_cast_or_null()

◆ floorDiv() [1/2]

◆ floorDiv() [2/2]

◆ getAsOpaquePointer()

◆ getContext()

◆ getFromOpaquePointer()

◆ getImpl()

◆ getKind()

◆ getLargestKnownDivisor()

◆ isa()

◆ isFunctionOfDim()

◆ isFunctionOfSymbol()

◆ isMultipleOf()

◆ isPureAffine()

◆ isSymbolicOrConstant()

◆ operator bool()

◆ operator!()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator%() [1/2]

◆ operator%() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ print()

◆ replace() [1/2]

◆ replace() [2/2]

◆ replaceDims()

◆ replaceDimsAndSymbols()

◆ replaceSymbols()

◆ shiftDims()

◆ shiftSymbols()

◆ walk()

Friends And Related Function Documentation

◆ hash_value

Member Data Documentation

◆ expr