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

A multi-dimensional affine map Affine map's are immutable like Type's, and they are uniqued. More...

#include "mlir/IR/AffineMap.h"

Public Types

using ImplType = detail::AffineMapStorage
 

Public Member Functions

constexpr AffineMap ()=default
 
 AffineMap (ImplType *map)
 
MLIRContextgetContext () const
 
 operator bool () const
 
bool operator== (AffineMap other) const
 
bool operator!= (AffineMap other) const
 
bool isIdentity () const
 Returns true if this affine map is an identity affine map. More...
 
bool isSymbolIdentity () const
 Returns true if this affine map is an identity affine map on the symbol identifiers. More...
 
bool isMinorIdentity () const
 Returns true if this affine map is a minor identity, i.e. More...
 
bool isMinorIdentityWithBroadcasting (SmallVectorImpl< unsigned > *broadcastedDims=nullptr) const
 Returns true if this affine map is a minor identity up to broadcasted dimensions which are indicated by value 0 in the result. More...
 
bool isPermutationOfMinorIdentityWithBroadcasting (SmallVectorImpl< unsigned > &permutedDims) const
 Return true if this affine map can be converted to a minor identity with broadcast by doing a permute. More...
 
bool isEmpty () const
 Returns true if this affine map is an empty map, i.e., () -> (). More...
 
bool isSingleConstant () const
 Returns true if this affine map is a single result constant function. More...
 
bool isConstant () const
 Returns true if this affine map has only constant results. More...
 
int64_t getSingleConstantResult () const
 Returns the constant result of this map. More...
 
SmallVector< int64_t > getConstantResults () const
 Returns the constant results of this map. More...
 
void print (raw_ostream &os) const
 
void dump () const
 
unsigned getNumDims () const
 
unsigned getNumSymbols () const
 
unsigned getNumResults () const
 
unsigned getNumInputs () const
 
ArrayRef< AffineExprgetResults () const
 
AffineExpr getResult (unsigned idx) const
 
unsigned getDimPosition (unsigned idx) const
 Extracts the position of the dimensional expression at the given result, when the caller knows it is safe to do so. More...
 
std::optional< unsigned > getResultPosition (AffineExpr input) const
 Extracts the first result position where input dimension resides. More...
 
bool isFunctionOfDim (unsigned position) const
 Return true if any affine expression involves AffineDimExpr position. More...
 
bool isFunctionOfSymbol (unsigned position) const
 Return true if any affine expression involves AffineSymbolExpr position. More...
 
void walkExprs (llvm::function_ref< void(AffineExpr)> callback) const
 Walk all of the AffineExpr's in this mapping. More...
 
AffineMap replaceDimsAndSymbols (ArrayRef< AffineExpr > dimReplacements, ArrayRef< AffineExpr > symReplacements, unsigned numResultDims, unsigned numResultSyms) const
 This method substitutes any uses of dimensions and symbols (e.g. More...
 
AffineMap replace (AffineExpr expr, AffineExpr replacement, unsigned numResultDims, unsigned numResultSyms) const
 Sparse replace method. More...
 
AffineMap replace (const DenseMap< AffineExpr, AffineExpr > &map) const
 Sparse replace method. More...
 
AffineMap replace (const DenseMap< AffineExpr, AffineExpr > &map, unsigned numResultDims, unsigned numResultSyms) const
 Sparse replace method. More...
 
AffineMap shiftDims (unsigned shift, unsigned offset=0) const
 Replace dims[offset ... More...
 
AffineMap shiftSymbols (unsigned shift, unsigned offset=0) const
 Replace symbols[offset ... More...
 
AffineMap dropResult (int64_t pos)
 Returns a new AffineMap with the same number of dims and symbols and one less result at pos, dropped. More...
 
AffineMap dropResults (ArrayRef< int64_t > positions)
 
AffineMap insertResult (AffineExpr expr, unsigned pos)
 Returns a new AffineMap with the same number of dims and symbols and an extra result inserted at pos. More...
 
LogicalResult constantFold (ArrayRef< Attribute > operandConstants, SmallVectorImpl< Attribute > &results) const
 Folds the results of the application of an affine map on the provided operands to a constant if possible. More...
 
AffineMap partialConstantFold (ArrayRef< Attribute > operandConstants, SmallVectorImpl< int64_t > *results=nullptr) const
 Propagates the constant operands into this affine map. More...
 
AffineMap compose (AffineMap map) const
 Returns the AffineMap resulting from composing this with map. More...
 
SmallVector< int64_t, 4 > compose (ArrayRef< int64_t > values) const
 Applies composition by the dims of this to the integer values and returns the resulting values. More...
 
bool isProjectedPermutation (bool allowZeroInResults=false) const
 Returns true if the AffineMap represents a subset (i.e. More...
 
bool isPermutation () const
 Returns true if the AffineMap represents a symbol-less permutation map. More...
 
AffineMap getSubMap (ArrayRef< unsigned > resultPos) const
 Returns the map consisting of the resultPos subset. More...
 
AffineMap getSliceMap (unsigned start, unsigned length) const
 Returns the map consisting of length expressions starting from start. More...
 
AffineMap getMajorSubMap (unsigned numResults) const
 Returns the map consisting of the most major numResults results. More...
 
AffineMap getMinorSubMap (unsigned numResults) const
 Returns the map consisting of the most minor numResults results. More...
 
uint64_t getLargestKnownDivisorOfMapExprs ()
 Get the largest known divisor of all map expressions. More...
 
const void * getAsOpaquePointer () const
 Methods supporting C API. More...
 

Static Public Member Functions

static AffineMap get (MLIRContext *context)
 Returns a zero result affine map with no dimensions or symbols: () -> (). More...
 
static AffineMap get (unsigned dimCount, unsigned symbolCount, MLIRContext *context)
 Returns a zero result affine map with dimCount dimensions and symbolCount symbols, e.g. More...
 
static AffineMap get (unsigned dimCount, unsigned symbolCount, AffineExpr result)
 Returns an affine map with dimCount dimensions and symbolCount mapping to a single output dimension. More...
 
static AffineMap get (unsigned dimCount, unsigned symbolCount, ArrayRef< AffineExpr > results, MLIRContext *context)
 Returns an affine map with dimCount dimensions and symbolCount mapping to the given results. More...
 
static AffineMap getConstantMap (int64_t val, MLIRContext *context)
 Returns a single constant result affine map. More...
 
static AffineMap getMultiDimIdentityMap (unsigned numDims, MLIRContext *context)
 Returns an AffineMap with 'numDims' identity result dim exprs. More...
 
static AffineMap getMinorIdentityMap (unsigned dims, unsigned results, MLIRContext *context)
 Returns an identity affine map (d0, ..., dn) -> (dp, ..., dn) on the most minor dimensions. More...
 
static AffineMap getPermutationMap (ArrayRef< unsigned > permutation, MLIRContext *context)
 Returns an AffineMap representing a permutation. More...
 
static SmallVector< AffineMap, 4 > inferFromExprList (ArrayRef< ArrayRef< AffineExpr >> exprsList)
 Returns a vector of AffineMaps; each with as many results as exprs.size(), as many dims as the largest dim in exprs and as many symbols as the largest symbol in exprs. More...
 
static SmallVector< AffineMap, 4 > inferFromExprList (ArrayRef< SmallVector< AffineExpr, 4 >> exprsList)
 
static AffineMap getFromOpaquePointer (const void *pointer)
 

Friends

::llvm::hash_code hash_value (AffineMap arg)
 

Detailed Description

A multi-dimensional affine map Affine map's are immutable like Type's, and they are uniqued.

Eg: (d0, d1) -> (d0/128, d0 mod 128, d1) The names used (d0, d1) don't matter - it's the mathematical function that is unique to this affine map.

Definition at line 43 of file AffineMap.h.

Member Typedef Documentation

◆ ImplType

Definition at line 45 of file AffineMap.h.

Constructor & Destructor Documentation

◆ AffineMap() [1/2]

constexpr mlir::AffineMap::AffineMap ( )
constexprdefault

◆ AffineMap() [2/2]

mlir::AffineMap::AffineMap ( ImplType map)
inlineexplicit

Definition at line 48 of file AffineMap.h.

Member Function Documentation

◆ compose() [1/2]

AffineMap AffineMap::compose ( AffineMap  map) const

Returns the AffineMap resulting from composing this with map.

The resulting AffineMap has as many AffineDimExpr as map and as many AffineSymbolExpr as the concatenation of this and map (in which case the symbols of this map come first).

Prerequisites: The maps are composable, i.e. that the number of AffineDimExpr of this matches the number of results of map.

Example: map1: (d0, d1)[s0, s1] -> (d0 + 1 + s1, d1 - 1 - s0) map2: (d0)[s0] -> (d0 + s0, d0 - s0) map1.compose(map2): (d0)[s0, s1, s2] -> (d0 + s1 + s2 + 1, d0 - s0 - s2 - 1)

Definition at line 468 of file AffineMap.cpp.

References mlir::AffineExpr::compose(), get(), mlir::getAffineDimExpr(), mlir::getAffineSymbolExpr(), getContext(), getNumDims(), getNumResults(), getNumSymbols(), getResults(), and replaceDimsAndSymbols().

Referenced by buildVectorWrite(), compose(), mlir::linalg::fuseElementwiseOps(), getIndexingMapOfProducerOperandsInCoordinatesOfFusedOp(), getPermutationMapAttr(), inferTransferOpMaskType(), insertParallelDim(), mlir::linalg::interchangeGenericOp(), TransferReadPermutationLowering::matchAndRewrite(), scaleReductionDim(), transposeOneLinalgOperandAndReplace(), vectorizeAsLinalgGeneric(), verifyOutputShape(), and mlir::linalg::detail::verifyStructuredOpInterface().

◆ compose() [2/2]

SmallVector< int64_t, 4 > AffineMap::compose ( ArrayRef< int64_t >  values) const

Applies composition by the dims of this to the integer values and returns the resulting values.

this must be symbol-less.

Definition at line 492 of file AffineMap.cpp.

References compose(), get(), mlir::getAffineConstantExpr(), getContext(), getNumSymbols(), and mlir::AffineConstantExpr::getValue().

◆ constantFold()

LogicalResult AffineMap::constantFold ( ArrayRef< Attribute operandConstants,
SmallVectorImpl< Attribute > &  results 
) const

Folds the results of the application of an affine map on the provided operands to a constant if possible.

Returns false if the folding happens, true otherwise.

Definition at line 360 of file AffineMap.cpp.

References mlir::failure(), getContext(), partialConstantFold(), and mlir::success().

Referenced by foldLoopBounds().

◆ dropResult()

AffineMap mlir::AffineMap::dropResult ( int64_t  pos)
inline

Returns a new AffineMap with the same number of dims and symbols and one less result at pos, dropped.

Definition at line 252 of file AffineMap.h.

References dropResults().

Referenced by mlir::linalg::splitReductionByScaling().

◆ dropResults()

AffineMap mlir::AffineMap::dropResults ( ArrayRef< int64_t >  positions)
inline

Definition at line 256 of file AffineMap.h.

References get(), getContext(), getNumDims(), getNumSymbols(), and getResults().

Referenced by dropResult(), and vectorizeAsLinalgGeneric().

◆ dump()

void AffineMap::dump ( ) const

◆ get() [1/4]

AffineMap AffineMap::get ( MLIRContext context)
static

Returns a zero result affine map with no dimensions or symbols: () -> ().

Definition at line 1047 of file MLIRContext.cpp.

References mlir::OperationName::getImpl().

Referenced by addConstToResults(), addLoopRangeConstraints(), adjustMap(), augmentMapAndBounds(), mlir::tensor::bubbleUpPadSlice(), calculateImplicitMap(), canonicalizeMapExprAndTermOrder(), mlir::canonicalizeStridedLayout(), mlir::coalesceLoops(), compose(), composeMultiResultAffineMap(), composeSetAndOperands(), mlir::compressDims(), mlir::compressSymbols(), compressUnusedImpl(), computeMemoryOpIndices(), mlir::concatAffineMaps(), constructTiledIndexSetHyperRect(), mlir::createAffineComputationSlice(), createMask(), createPrivateMemRef(), mlir::AffineValueMap::difference(), doubleBuffer(), dropResults(), elementwiseMatchAndRewriteHelper(), mlir::linalg::extractOrIdentityMap(), fuseWithReshapeByExpansion(), generateCopy(), generatePointWiseCopy(), mlir::MutableAffineMap::getAffineMap(), getBoundedTileSize(), getCleanupLoopLowerBound(), getCollapsedOpIndexingMap(), getCollapsedOutputDimFromInputShape(), mlir::Builder::getConstantAffineMap(), getConstantMap(), mlir::Builder::getDimIdentityMap(), mlir::Builder::getEmptyAffineMap(), getExpandedOutputDimFromInputShape(), mlir::FlatAffineValueConstraints::getHyperrectangular(), getIndexingMapInExpandedOp(), getIndicesForAccess(), mlir::FlatAffineValueConstraints::getIneqAsAffineValueMap(), mlir::nvgpu::getLaneIdAndValueIdToOperandCoord(), mlir::nvgpu::getLaneIdToLdMatrixMatrixCoord(), mlir::FlatAffineValueConstraints::getLowerAndUpperBound(), getMinorIdentityMap(), getMultiDimIdentityMap(), mlir::Builder::getMultiDimIdentityMap(), getPermutationMap(), getPermutationMapAttr(), getRegisterIndexToTileOffsetMap(), mlir::Builder::getShiftedAffineMap(), mlir::Builder::getSingleDimShiftAffineMap(), mlir::FlatAffineValueConstraints::getSliceBounds(), getSliceMap(), getSubMap(), mlir::Builder::getSymbolIdentityMap(), mlir::getSymbolLessAffineMaps(), mlir::vector::getTransferMinorIdentityMap(), mlir::getTripCountMapAndOperands(), inferFromExprList(), insertResult(), mlir::inverseAndBroadcastProjectedPermutation(), mlir::inversePermutation(), mlir::isColumnMajorMatmul(), mlir::isRowMajorBatchMatmul(), mlir::isRowMajorMatmul(), isTransposeMatrixLoadMap(), mlir::loopUnrollJamByFactor(), makeCanonicalAffineApplies(), makePermutationMap(), mlir::makeStridedLinearLayoutMap(), mlir::mapLoopToProcessorIds(), DeduplicateAffineMinMaxExpressions< T >::matchAndRewrite(), MergeAffineMinMaxOp< T >::matchAndRewrite(), mlir::linalg::PadOpTransformationPattern::matchAndRewrite(), mlir::vector::ContractionOpToMatmulOpLowering::matchAndRewrite(), TransferOpReduceRank::matchAndRewrite(), TransferWriteNonPermutationLowering::matchAndRewrite(), mlirAffineMapEmptyGet(), mlirAffineMapGet(), mlirAffineMapZeroResultGet(), mlir::memref::multiBuffer(), mlir::normalizeAffineFor(), mlir::normalizeAffineParallel(), parseAffineMapWithMinMax(), partialConstantFold(), peelForLoop(), processParallelLoop(), mlir::removeDuplicateExprs(), replace(), mlir::replaceAllMemRefUsesWith(), replaceDimsAndSymbols(), replaceUnitExtents(), resolveSourceIndicesCollapseShape(), resolveSourceIndicesExpandShape(), resolveSourceIndicesSubView(), setInterTileBoundsParametric(), setIntraTileBoundsParametric(), shiftDims(), shiftSymbols(), mlir::simplifyAffineMap(), simplifyMapWithOperands(), sliceTransferIndices(), mlir::linalg::splitReduction(), mlir::linalg::splitReductionByScaling(), mlir::scf::tileParallelLoop(), transferReadSupportsMMAMatrixType(), and verifyOutputShape().

◆ get() [2/4]

AffineMap AffineMap::get ( unsigned  dimCount,
unsigned  symbolCount,
AffineExpr  result 
)
static

Returns an affine map with dimCount dimensions and symbolCount mapping to a single output dimension.

Definition at line 1056 of file MLIRContext.cpp.

References mlir::AffineExpr::getContext(), mlir::OperationName::getImpl(), and willBeValidAffineMap().

◆ get() [3/4]

AffineMap AffineMap::get ( unsigned  dimCount,
unsigned  symbolCount,
ArrayRef< AffineExpr results,
MLIRContext context 
)
static

Returns an affine map with dimCount dimensions and symbolCount mapping to the given results.

Definition at line 1062 of file MLIRContext.cpp.

References mlir::OperationName::getImpl(), and willBeValidAffineMap().

◆ get() [4/4]

AffineMap AffineMap::get ( unsigned  dimCount,
unsigned  symbolCount,
MLIRContext context 
)
static

Returns a zero result affine map with dimCount dimensions and symbolCount symbols, e.g.

: (...) -> ().

Definition at line 1051 of file MLIRContext.cpp.

References mlir::OperationName::getImpl().

◆ getAsOpaquePointer()

const void* mlir::AffineMap::getAsOpaquePointer ( ) const
inline

Methods supporting C API.

Definition at line 344 of file AffineMap.h.

◆ getConstantMap()

AffineMap AffineMap::getConstantMap ( int64_t  val,
MLIRContext context 
)
static

Returns a single constant result affine map.

Definition at line 97 of file AffineMap.cpp.

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

Referenced by mlir::getTripCountMapAndOperands(), mlir::linalg::getUpperBoundForIndex(), and mlirAffineMapConstantGet().

◆ getConstantResults()

SmallVector< int64_t > AffineMap::getConstantResults ( ) const

Returns the constant results of this map.

This method asserts that the map has all constant results.

Definition at line 311 of file AffineMap.cpp.

References mlir::AffineExpr::cast(), getResults(), mlir::AffineConstantExpr::getValue(), and isConstant().

◆ getContext()

MLIRContext * AffineMap::getContext ( ) const

◆ getDimPosition()

unsigned AffineMap::getDimPosition ( unsigned  idx) const

Extracts the position of the dimensional expression at the given result, when the caller knows it is safe to do so.

Definition at line 340 of file AffineMap.cpp.

References mlir::AffineExpr::cast(), and getResult().

Referenced by adjustMap(), getDimPosition(), getReductionIndex(), getResultIndex(), mlir::inverseAndBroadcastProjectedPermutation(), and mlir::linalg::splitReduction().

◆ getFromOpaquePointer()

static AffineMap mlir::AffineMap::getFromOpaquePointer ( const void *  pointer)
inlinestatic

Definition at line 347 of file AffineMap.h.

References AffineMap().

◆ getLargestKnownDivisorOfMapExprs()

uint64_t AffineMap::getLargestKnownDivisorOfMapExprs ( )

Get the largest known divisor of all map expressions.

For eg: for (d0, d1) -> (8*d0 + 4, 4*d1 + 2), the result is 2. In the case of maps with no expressions or all zero constant expressions, the largest known divisor is trivially the max uint64_t value.

Definition at line 246 of file AffineMap.cpp.

References mlir::presburger::gcd(), getResults(), and max().

◆ getMajorSubMap()

AffineMap AffineMap::getMajorSubMap ( unsigned  numResults) const

Returns the map consisting of the most major numResults results.

Returns the null AffineMap if numResults == 0. Returns *this if numResults >= this->getNumResults().

Definition at line 556 of file AffineMap.cpp.

References AffineMap(), getNumResults(), and getSliceMap().

◆ getMinorIdentityMap()

AffineMap AffineMap::getMinorIdentityMap ( unsigned  dims,
unsigned  results,
MLIRContext context 
)
static

Returns an identity affine map (d0, ..., dn) -> (dp, ..., dn) on the most minor dimensions.

Definition at line 104 of file AffineMap.cpp.

References get(), getMultiDimIdentityMap(), and getResults().

Referenced by mlir::vector::getTransferMinorIdentityMap(), isMinorIdentity(), TransferWritePermutationLowering::matchAndRewrite(), and mlirAffineMapMinorIdentityGet().

◆ getMinorSubMap()

AffineMap AffineMap::getMinorSubMap ( unsigned  numResults) const

Returns the map consisting of the most minor numResults results.

Returns the null AffineMap if numResults == 0. Returns *this if numResults >= this->getNumResults().

Definition at line 564 of file AffineMap.cpp.

References AffineMap(), getNumResults(), and getSliceMap().

◆ getMultiDimIdentityMap()

AffineMap AffineMap::getMultiDimIdentityMap ( unsigned  numDims,
MLIRContext context 
)
static

◆ getNumDims()

unsigned AffineMap::getNumDims ( ) const

Definition at line 319 of file AffineMap.cpp.

References mlir::detail::AffineMapStorage::numDims.

Referenced by mlir::FlatAffineValueConstraints::addBound(), addConstToResults(), adjustMap(), mlir::alignAffineMapWithValues(), mlir::applyMapToValues(), augmentMapAndBounds(), canonicalizeMapExprAndTermOrder(), mlir::canonicalizeStridedLayout(), compose(), composeAffineMapAndOperands(), mlir::FlatAffineValueConstraints::composeMatchingMap(), composeMultiResultAffineMap(), composeSetAndOperands(), mlir::compressDims(), mlir::compressSymbols(), compressUnusedImpl(), mlir::MemRefRegion::compute(), computeMemoryOpIndices(), constructTiledIndexSetHyperRect(), dropResults(), mlir::expandAffineMap(), getCleanupLoopLowerBound(), getConstDifference(), mlir::getFlattenedAffineExprs(), getIndicesForAccess(), mlir::getMultiAffineFunctionFromMap(), mlir::AffineValueMap::getNumDims(), mlir::getRelationFromMap(), mlir::Builder::getShiftedAffineMap(), getSliceMap(), getStridesAndOffset(), getSubMap(), getXferIndices(), insertParallelDim(), insertResult(), mlir::inversePermutation(), isEmpty(), isIdentity(), isMinorIdentity(), isMinorIdentityWithBroadcasting(), isPermutation(), isTransposeMatrixLoadMap(), makeCanonicalAffineApplies(), DeduplicateAffineMinMaxExpressions< T >::matchAndRewrite(), MergeAffineMinMaxOp< T >::matchAndRewrite(), TransferOpReduceRank::matchAndRewrite(), TransferWritePermutationLowering::matchAndRewrite(), TransferWriteNonPermutationLowering::matchAndRewrite(), mlir::normalizeAffineFor(), mlir::normalizeAffineParallel(), packLinalgMetadataOnce(), parseBound(), partialConstantFold(), permute(), mlir::AsmPrinter::Impl::printAffineMap(), printBound(), printMinMaxBound(), remainsLegalAfterInline(), mlir::removeDuplicateExprs(), mlir::replaceAllMemRefUsesWith(), replaceDimOrSym(), replaceUnitExtents(), mlir::MutableAffineMap::reset(), scaleReductionDim(), setInterTileBoundsParametric(), setIntraTileBoundsParametric(), shiftDims(), shiftSymbols(), mlir::simplifyAffineMap(), mlir::simplifyConstrainedMinMaxOp(), simplifyMapWithOperands(), mlir::linalg::splitReduction(), transferReadSupportsMMAMatrixType(), mlir::detail::verifyAffineMapAsLayout(), and mlir::linalg::detail::verifyStructuredOpInterface().

◆ getNumInputs()

unsigned AffineMap::getNumInputs ( ) const

◆ getNumResults()

unsigned AffineMap::getNumResults ( ) const

Definition at line 327 of file AffineMap.cpp.

References getResults().

Referenced by mlir::FlatAffineValueConstraints::addBound(), mlir::FlatAffineValueConstraints::addDomainFromSliceMaps(), mlir::FlatAffineValueConstraints::addSliceBounds(), adjustMap(), mlir::applyMapToValues(), mlir::applyPermutationMap(), mlir::linalg::areElementwiseOpsFusable(), mlir::buildSliceTripCountMap(), calculateExpandedAccessIndices(), canonicalizeMapExprAndTermOrder(), mlir::canonicalizeStridedLayout(), compose(), composeAffineMapAndOperands(), mlir::FlatAffineValueConstraints::composeMatchingMap(), composeMultiResultAffineMap(), mlir::compressDims(), mlir::compressSymbols(), mlir::concatAffineMaps(), constructTiledIndexSetHyperRect(), createMask(), foldLoopBounds(), getCleanupLoopLowerBound(), getCollapsedOpOperand(), getConstDifference(), getDimPosition(), getFirstResultIndexFunctionOf(), mlir::getFlattenedAffineExprs(), getIndicesForAccess(), mlir::getLargestDivisorOfTripCount(), getMajorSubMap(), getMinorSubMap(), mlir::getMultiAffineFunctionFromMap(), mlir::AffineValueMap::getNumResults(), getOperandReassociation(), getReductionIndex(), mlir::getRelationFromMap(), getResultIndex(), getResultPosition(), getShapeDefiningLoopRange(), mlir::Builder::getShiftedAffineMap(), mlir::FlatAffineValueConstraints::getSliceBounds(), getStridesAndOffset(), getTiledProducerLoops(), mlir::inverseAndBroadcastProjectedPermutation(), mlir::inversePermutation(), isDimSequencePreserved(), isEmpty(), isIdentity(), isMinorIdentity(), isMinorIdentityWithBroadcasting(), isPermutation(), isPermutationOfMinorIdentityWithBroadcasting(), isProjectedPermutation(), isSingleConstant(), isSymbolIdentity(), isTiled(), makeCanonicalAffineApplies(), mlir::makeComposedFoldedAffineApply(), mlir::makeComposedFoldedMultiResultAffineApply(), mlir::linalg::makeTiledLoopRanges(), DeduplicateAffineMinMaxExpressions< T >::matchAndRewrite(), TransferReadPermutationLowering::matchAndRewrite(), TransferWritePermutationLowering::matchAndRewrite(), mlir::normalizeMemRefType(), packLinalgMetadataOnce(), parseBound(), partialConstantFold(), permute(), printBound(), replace(), mlir::replaceAllMemRefUsesWith(), replaceDimOrSym(), replaceDimsAndSymbols(), setInterTileBoundsParametric(), setIntraTileBoundsParametric(), mlir::simplifyConstrainedMinMaxOp(), simplifyMapWithOperands(), mlir::linalg::splitReduction(), verifyMemoryOpIndexing(), mlir::linalg::detail::verifyStructuredOpInterface(), and verifyTransferOp().

◆ getNumSymbols()

unsigned AffineMap::getNumSymbols ( ) const

Definition at line 323 of file AffineMap.cpp.

References mlir::detail::AffineMapStorage::numSymbols.

Referenced by mlir::FlatAffineValueConstraints::addBound(), addConstToResults(), mlir::alignAffineMapWithValues(), mlir::applyMapToValues(), augmentMapAndBounds(), canonicalizeMapExprAndTermOrder(), mlir::canonicalizeStridedLayout(), compose(), mlir::FlatAffineValueConstraints::composeMatchingMap(), composeSetAndOperands(), mlir::compressDims(), mlir::compressSymbols(), compressUnusedImpl(), mlir::compressUnusedSymbols(), mlir::MemRefRegion::compute(), computeMemoryOpIndices(), constructTiledIndexSetHyperRect(), createNewDynamicSizes(), dropResults(), getCleanupLoopLowerBound(), getConstDifference(), mlir::getFlattenedAffineExprs(), getIndexingMapInExpandedOp(), getIndicesForAccess(), mlir::getMultiAffineFunctionFromMap(), mlir::AffineValueMap::getNumSymbols(), mlir::Builder::getShiftedAffineMap(), getSliceMap(), getStridesAndOffset(), getSubMap(), insertResult(), mlir::inversePermutation(), isEmpty(), isProjectedPermutation(), isSymbolIdentity(), makeCanonicalAffineApplies(), DeduplicateAffineMinMaxExpressions< T >::matchAndRewrite(), MergeAffineMinMaxOp< T >::matchAndRewrite(), mlir::normalizeAffineFor(), mlir::normalizeAffineParallel(), parseBound(), partialConstantFold(), mlir::AsmPrinter::Impl::printAffineMap(), printBound(), remainsLegalAfterInline(), mlir::removeDuplicateExprs(), mlir::replaceAllMemRefUsesWith(), replaceDimOrSym(), replaceUnitExtents(), mlir::MutableAffineMap::reset(), setInterTileBoundsParametric(), setIntraTileBoundsParametric(), shiftDims(), shiftSymbols(), mlir::simplifyAffineMap(), mlir::simplifyConstrainedMinMaxOp(), simplifyMapWithOperands(), mlir::linalg::detail::verifyStructuredOpInterface(), and verifyTransferOp().

◆ getPermutationMap()

AffineMap AffineMap::getPermutationMap ( ArrayRef< unsigned >  permutation,
MLIRContext context 
)
static

Returns an AffineMap representing a permutation.

The permutation is expressed as a non-empty vector of integers. E.g. the permutation (i,j,k) -> (j,k,i) will be expressed with permutation = [1,2,0]. All values in permutation must be integers, in the range 0..permutation.size()-1 without duplications (i.e. [1,1,2] is an invalid permutation).

Definition at line 207 of file AffineMap.cpp.

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

Referenced by convertTransferReadOp(), foldTransferInBoundsAttribute(), mlir::linalg::interchangeGenericOp(), interchangeGenericOpPrecondition(), mlir::linalg::makeTransposeOp(), TransferReadPermutationLowering::matchAndRewrite(), TransferOpReduceRank::matchAndRewrite(), TransferWritePermutationLowering::matchAndRewrite(), TransferWriteNonPermutationLowering::matchAndRewrite(), mlirAffineMapPermutationGet(), permute(), tileLinalgOpImpl(), transferReadSupportsMMAMatrixType(), and transposeOneLinalgOperandAndReplace().

◆ getResult()

AffineExpr AffineMap::getResult ( unsigned  idx) const

◆ getResultPosition()

std::optional< unsigned > AffineMap::getResultPosition ( AffineExpr  input) const

Extracts the first result position where input dimension resides.

Returns std::nullopt if input is not a dimension expression or cannot be found in results.

Definition at line 344 of file AffineMap.cpp.

References getNumResults(), getResult(), and mlir::AffineExpr::isa().

◆ getResults()

ArrayRef< AffineExpr > AffineMap::getResults ( ) const

Definition at line 332 of file AffineMap.cpp.

References mlir::detail::AffineMapStorage::results().

Referenced by addConstToResults(), mlir::applyMapToValues(), mlir::applyPermutationMap(), augmentMapAndBounds(), canonicalizeMapExprAndTermOrder(), mlir::coalesceLoops(), mlir::AffineExpr::compose(), compose(), composeSetAndOperands(), mlir::compressDims(), mlir::compressSymbols(), compressUnusedImpl(), computeMemoryOpIndices(), constructTiledIndexSetHyperRect(), createNewDynamicSizes(), dropResults(), mlir::expandAffineMap(), findPermutationsIndexingOperand(), fuse(), getCollapsedOpIndexingMap(), getCollapsedOutputDimFromInputShape(), getConstantResults(), mlir::getConstantTripCount(), mlir::linalg::getConstantUpperBoundForIndex(), getDomainReassociation(), getExpandedType(), mlir::getFlattenedAffineExprs(), getIndexingMapInExpandedOp(), getIndicesForAccess(), mlir::getLargestDivisorOfTripCount(), getLargestKnownDivisorOfMapExprs(), getMinorIdentityMap(), getNumCompoundAffineOnSparseDims(), getNumResults(), getPreservedDims(), getReassociationForExpansion(), getResult(), getShapeDefiningLoopRange(), mlir::Builder::getShiftedAffineMap(), getSliceMap(), getTiledSliceDims(), getTileSizePos(), hasAtMostOneResultFunctionOfDim(), inferTransposeResultType(), insertResult(), mlir::inversePermutation(), isConstant(), isDimSequencePreserved(), isFunctionOfDim(), isFunctionOfSymbol(), isIdentity(), isMinorIdentityWithBroadcasting(), isNormalizedMemRefDynamicDim(), isPermutationOfMinorIdentityWithBroadcasting(), isProjectedPermutation(), isSymbolIdentity(), makeCanonicalAffineApplies(), DeduplicateAffineMinMaxExpressions< T >::matchAndRewrite(), MergeAffineMinMaxOp< T >::matchAndRewrite(), TransferOpReduceRank::matchAndRewrite(), TransferWritePermutationLowering::matchAndRewrite(), TransferWriteNonPermutationLowering::matchAndRewrite(), mlir::normalizeAffineFor(), mlir::normalizeAffineParallel(), mlir::MemRefAccess::operator==(), padOperandToSmallestStaticBoundingBox(), partialConstantFold(), permuteValues(), mlir::AsmPrinter::Impl::printAffineMap(), mlir::removeDuplicateExprs(), replace(), mlir::replaceAllMemRefUsesWith(), replaceDimsAndSymbols(), replaceUnitExtents(), mlir::MutableAffineMap::reset(), setInterTileBoundsParametric(), setIntraTileBoundsParametric(), shiftDims(), shiftSymbols(), mlir::simplifyAffineMap(), simplifyMapWithOperands(), sliceTransferIndices(), vectorizeAsLinalgGeneric(), verifyOutputShape(), verifyPermutationMap(), and walkExprs().

◆ getSingleConstantResult()

int64_t AffineMap::getSingleConstantResult ( ) const

Returns the constant result of this map.

This methods asserts that the map has a single constant result.

Definition at line 306 of file AffineMap.cpp.

References mlir::AffineExpr::cast(), getResult(), and isSingleConstant().

Referenced by mlir::FlatAffineValueConstraints::addAffineParallelOpDomain().

◆ getSliceMap()

AffineMap AffineMap::getSliceMap ( unsigned  start,
unsigned  length 
) const

Returns the map consisting of length expressions starting from start.

Definition at line 551 of file AffineMap.cpp.

References get(), getContext(), getNumDims(), getNumSymbols(), and getResults().

Referenced by getMajorSubMap(), getMinorSubMap(), and printMinMaxBound().

◆ getSubMap()

AffineMap AffineMap::getSubMap ( ArrayRef< unsigned >  resultPos) const

◆ inferFromExprList() [1/2]

SmallVector< AffineMap, 4 > AffineMap::inferFromExprList ( ArrayRef< ArrayRef< AffineExpr >>  exprsList)
static

◆ inferFromExprList() [2/2]

SmallVector< AffineMap, 4 > AffineMap::inferFromExprList ( ArrayRef< SmallVector< AffineExpr, 4 >>  exprsList)
static

Definition at line 242 of file AffineMap.cpp.

References inferFromExprList().

◆ insertResult()

AffineMap mlir::AffineMap::insertResult ( AffineExpr  expr,
unsigned  pos 
)
inline

Returns a new AffineMap with the same number of dims and symbols and an extra result inserted at pos.

Definition at line 268 of file AffineMap.h.

References get(), getContext(), getNumDims(), getNumSymbols(), and getResults().

Referenced by insertParallelDim(), and packLinalgMetadataOnce().

◆ isConstant()

bool AffineMap::isConstant ( ) const

Returns true if this affine map has only constant results.

Definition at line 300 of file AffineMap.cpp.

References getResults(), and mlir::AffineExpr::isa().

Referenced by mlir::FlatAffineValueConstraints::addAffineParallelOpDomain(), and getConstantResults().

◆ isEmpty()

bool AffineMap::isEmpty ( ) const

Returns true if this affine map is an empty map, i.e., () -> ().

Definition at line 292 of file AffineMap.cpp.

References getNumDims(), getNumResults(), and getNumSymbols().

Referenced by mlir::linalg::interchangeGenericOp(), mlir::inversePermutation(), and makeCanonicalAffineApplies().

◆ isFunctionOfDim()

bool mlir::AffineMap::isFunctionOfDim ( unsigned  position) const
inline

Return true if any affine expression involves AffineDimExpr position.

Definition at line 180 of file AffineMap.h.

References getResults(), and mlir::AffineExpr::isFunctionOfDim().

Referenced by composeAffineMapAndOperands().

◆ isFunctionOfSymbol()

bool mlir::AffineMap::isFunctionOfSymbol ( unsigned  position) const
inline

Return true if any affine expression involves AffineSymbolExpr position.

Definition at line 187 of file AffineMap.h.

References getResults(), and mlir::AffineExpr::isFunctionOfSymbol().

Referenced by composeAffineMapAndOperands().

◆ isIdentity()

bool AffineMap::isIdentity ( ) const

Returns true if this affine map is an identity affine map.

An identity affine map corresponds to an identity affine function on the dimensional identifiers.

Definition at line 268 of file AffineMap.cpp.

References getNumDims(), getNumResults(), and getResults().

Referenced by mlir::canonicalizeStridedLayout(), getStridesAndOffset(), and TransferReadPermutationLowering::matchAndRewrite().

◆ isMinorIdentity()

bool AffineMap::isMinorIdentity ( ) const

Returns true if this affine map is a minor identity, i.e.

an identity affine map (d0, ..., dn) -> (dp, ..., dn) on the most minor dimensions.

Definition at line 111 of file AffineMap.cpp.

References getContext(), getMinorIdentityMap(), getNumDims(), and getNumResults().

Referenced by TransferWritePermutationLowering::matchAndRewrite(), and transferReadSupportsMMAMatrixType().

◆ isMinorIdentityWithBroadcasting()

bool AffineMap::isMinorIdentityWithBroadcasting ( SmallVectorImpl< unsigned > *  broadcastedDims = nullptr) const

Returns true if this affine map is a minor identity up to broadcasted dimensions which are indicated by value 0 in the result.

If broadcastedDims is not null, it will be populated with the indices of the broadcasted dimensions in the result array. Example: affine_map<(d0, d1, d2, d3, d4) -> (0, d2, 0, d4)> (broadcastedDims will contain [0, 2])

Definition at line 119 of file AffineMap.cpp.

References mlir::AffineExpr::dyn_cast(), mlir::detail::enumerate(), getNumDims(), getNumResults(), and getResults().

Referenced by TransferOpReduceRank::matchAndRewrite().

◆ isPermutation()

bool AffineMap::isPermutation ( ) const

Returns true if the AffineMap represents a symbol-less permutation map.

Definition at line 537 of file AffineMap.cpp.

References getNumDims(), getNumResults(), and isProjectedPermutation().

Referenced by mlir::linalg::areElementwiseOpsFusable(), permuteValues(), and reductionPreconditions().

◆ isPermutationOfMinorIdentityWithBroadcasting()

bool AffineMap::isPermutationOfMinorIdentityWithBroadcasting ( SmallVectorImpl< unsigned > &  permutedDims) const

Return true if this affine map can be converted to a minor identity with broadcast by doing a permute.

Return a permutation (there may be several) to apply to get to a minor identity with broadcasts. Ex:

  • (d0, d1, d2) -> (0, d1) maps to minor identity (d1, 0 = d2) with perm = [1, 0] and broadcast d2
  • (d0, d1, d2) -> (d0, 0) cannot be mapped to a minor identity by permutation + broadcast
  • (d0, d1, d2, d3) -> (0, d1, d3) maps to minor identity (d1, 0 = d2, d3) with perm = [1, 0, 2] and broadcast d2
  • (d0, d1) -> (d1, 0, 0, d0) maps to minor identity (d0, d1) with extra leading broadcat dimensions. The map returned would be (0, 0, d0, d1) with perm = [3, 0, 1, 2]

Definition at line 159 of file AffineMap.cpp.

References mlir::AffineExpr::dyn_cast(), mlir::detail::enumerate(), getNumInputs(), getNumResults(), getResults(), and max().

Referenced by TransferReadPermutationLowering::matchAndRewrite(), TransferWritePermutationLowering::matchAndRewrite(), and TransferWriteNonPermutationLowering::matchAndRewrite().

◆ isProjectedPermutation()

bool AffineMap::isProjectedPermutation ( bool  allowZeroInResults = false) const

Returns true if the AffineMap represents a subset (i.e.

a projection) of a symbol-less permutation map. allowZeroInResults allows projected permutation maps with constant zero result expressions. TODO: Remove allowZeroInResults when constant zero result expressions are broadly supported.

Definition at line 507 of file AffineMap.cpp.

References mlir::AffineExpr::dyn_cast(), getNumInputs(), getNumResults(), getNumSymbols(), and getResults().

Referenced by mlir::applyPermutationMap(), getCollapsedOpIndexingMap(), getDomainReassociation(), getPreservedDims(), getTiledProducerLoops(), mlir::inverseAndBroadcastProjectedPermutation(), isContractionInterfaceImpl(), isDimSequencePreserved(), isPermutation(), and reindexIndexingMap().

◆ isSingleConstant()

bool AffineMap::isSingleConstant ( ) const

Returns true if this affine map is a single result constant function.

Definition at line 296 of file AffineMap.cpp.

References getNumResults(), getResult(), and mlir::AffineExpr::isa().

Referenced by getSingleConstantResult().

◆ isSymbolIdentity()

bool AffineMap::isSymbolIdentity ( ) const

Returns true if this affine map is an identity affine map on the symbol identifiers.

Definition at line 280 of file AffineMap.cpp.

References getNumResults(), getNumSymbols(), and getResults().

◆ operator bool()

mlir::AffineMap::operator bool ( ) const
inlineexplicit

Definition at line 99 of file AffineMap.h.

◆ operator!=()

bool mlir::AffineMap::operator!= ( AffineMap  other) const
inline

Definition at line 101 of file AffineMap.h.

◆ operator==()

bool mlir::AffineMap::operator== ( AffineMap  other) const
inline

Definition at line 100 of file AffineMap.h.

◆ partialConstantFold()

AffineMap AffineMap::partialConstantFold ( ArrayRef< Attribute operandConstants,
SmallVectorImpl< int64_t > *  results = nullptr 
) const

Propagates the constant operands into this affine map.

Operands are allowed to be null, at which point they are treated as non-constant. This does not change the number of symbols and dimensions. Returns a new map, which may be equal to the old map if no folding happened. If results is provided and if all expressions in the map were folded to constants, results will contain the values of these constants.

Definition at line 379 of file AffineMap.cpp.

References get(), mlir::getAffineConstantExpr(), getContext(), getNumDims(), getNumInputs(), getNumResults(), getNumSymbols(), and getResults().

Referenced by constantFold().

◆ print()

void AffineMap::print ( raw_ostream &  os) const

◆ replace() [1/3]

AffineMap AffineMap::replace ( AffineExpr  expr,
AffineExpr  replacement,
unsigned  numResultDims,
unsigned  numResultSyms 
) const

Sparse replace method.

Apply AffineExpr::replace(expr, replacement) to each of the results and return a new AffineMap with the new results and with the specified number of dims and symbols.

Definition at line 436 of file AffineMap.cpp.

References get(), getContext(), getNumResults(), and getResults().

Referenced by replaceDimOrSym(), scaleReductionDim(), and mlir::simplifyConstrainedMinMaxOp().

◆ replace() [2/3]

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

Sparse replace method.

Apply AffineExpr::replace(map) to each of the results and return a new AffineMap with the new results and with inferred number of dims and symbols.

Definition at line 460 of file AffineMap.cpp.

References getNumResults(), getResults(), and inferFromExprList().

◆ replace() [3/3]

AffineMap AffineMap::replace ( const DenseMap< AffineExpr, AffineExpr > &  map,
unsigned  numResultDims,
unsigned  numResultSyms 
) const

Sparse replace method.

Apply AffineExpr::replace(map) to each of the results and return a new AffineMap with the new results and with the specified number of dims and symbols.

Definition at line 449 of file AffineMap.cpp.

References get(), getContext(), getNumResults(), and getResults().

◆ replaceDimsAndSymbols()

AffineMap AffineMap::replaceDimsAndSymbols ( ArrayRef< AffineExpr dimReplacements,
ArrayRef< AffineExpr symReplacements,
unsigned  numResultDims,
unsigned  numResultSyms 
) const

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

dim#0 with dimReplacements[0]) in subexpressions and returns the modified expression mapping. Because this can be used to eliminate dims and symbols, the client needs to specify the number of dims and symbols in the result. The returned map always has the same number of results.

Definition at line 421 of file AffineMap.cpp.

References get(), getContext(), getNumResults(), getResults(), and mlir::AffineExpr::replaceDimsAndSymbols().

Referenced by mlir::alignAffineMapWithValues(), compose(), and composeAffineMapAndOperands().

◆ shiftDims()

AffineMap mlir::AffineMap::shiftDims ( unsigned  shift,
unsigned  offset = 0 
) const
inline

◆ shiftSymbols()

AffineMap mlir::AffineMap::shiftSymbols ( unsigned  shift,
unsigned  offset = 0 
) const
inline

Replace symbols[offset ...

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

Definition at line 239 of file AffineMap.h.

References get(), getContext(), getNumDims(), getNumSymbols(), getResults(), and mlir::AffineExpr::shiftSymbols().

Referenced by composeMultiResultAffineMap(), mlir::AffineValueMap::difference(), and replaceDimOrSym().

◆ walkExprs()

void AffineMap::walkExprs ( llvm::function_ref< void(AffineExpr)>  callback) const

Walk all of the AffineExpr's in this mapping.

Each node in an expression tree is visited in postorder.

Definition at line 411 of file AffineMap.cpp.

References getResults(), and mlir::AffineExpr::walk().

Referenced by mlir::compressUnusedSymbols().

Friends And Related Function Documentation

◆ hash_value

::llvm::hash_code hash_value ( AffineMap  arg)
friend

Definition at line 359 of file AffineMap.h.


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