Helper class that generates loop conditions, etc, to traverse a sparse tensor level. More...

#include "Dialect/SparseTensor/Transforms/Utils/SparseTensorIterator.h"

Public Member Functions
virtual	~SparseIterator ()=default

void	setSparseEmitStrategy (SparseEmitStrategy strategy)

virtual std::string	getDebugInterfacePrefix () const =0

virtual SmallVector< Type >	getCursorValTypes (OpBuilder &b) const =0

Value	getCrd () const

ValueRange	getBatchCrds () const

ValueRange	getCursor () const

void	seek (ValueRange vals)

SmallVector< Value >	toValues () const

virtual bool	isBatchIterator () const =0

virtual bool	randomAccessible () const =0

virtual bool	iteratableByFor () const

virtual Value	upperBound (OpBuilder &b, Location l) const =0

virtual SmallVector< Value >	serialize () const

virtual void	deserialize (ValueRange vs)

void	genInit (OpBuilder &b, Location l, const SparseIterator *p)

ValueRange	forward (OpBuilder &b, Location l)

void	locate (OpBuilder &b, Location l, Value crd)

Value	genNotEnd (OpBuilder &b, Location l)

Value	deref (OpBuilder &b, Location l)

virtual void	genInitImpl (OpBuilder &, Location, const SparseIterator *)=0

virtual ValueRange	forwardImpl (OpBuilder &b, Location l)=0

virtual void	locateImpl (OpBuilder &b, Location l, Value crd)

virtual Value	genNotEndImpl (OpBuilder &b, Location l)=0

virtual Value	derefImpl (OpBuilder &b, Location l)=0

virtual ValueRange	getCurPosition () const

virtual std::pair< Value, Value >	genForCond (OpBuilder &b, Location l)

std::pair< Value, ValueRange >	genWhileCond (OpBuilder &b, Location l, ValueRange vs)

virtual ValueRange	forwardIf (OpBuilder &b, Location l, Value cond)

ValueRange	linkNewScope (ValueRange pos)

Static Public Member Functions
static std::unique_ptr< SparseIterator >	fromValues (IteratorType dstTp, ValueRange values, unsigned tid)

Public Attributes
const IterKind	kind

const unsigned	tid

const unsigned	lvl

Protected Member Functions
	SparseIterator (IterKind kind, unsigned tid, unsigned lvl, unsigned cursorValsCnt, SmallVectorImpl< Value > &cursorValStorage)

	SparseIterator (IterKind kind, unsigned cursorValsCnt, SmallVectorImpl< Value > &cursorValStorage, const SparseIterator &delegate)

	SparseIterator (IterKind kind, const SparseIterator &wrap, unsigned extraCursorCnt=0)

void	updateCrd (Value crd)

MutableArrayRef< Value >	getMutCursorVals ()

void	inherentBatch (const SparseIterator &parent)

Protected Attributes
SparseEmitStrategy	emitStrategy

SmallVector< Value >	batchCrds

Detailed Description

Helper class that generates loop conditions, etc, to traverse a sparse tensor level.

Definition at line 148 of file SparseTensorIterator.h.

Constructor & Destructor Documentation

◆ SparseIterator() [1/3]

mlir::sparse_tensor::SparseIterator::SparseIterator	(	IterKind	kind,
		unsigned	tid,
		unsigned	lvl,
		unsigned	cursorValsCnt,
		SmallVectorImpl< Value > &	cursorValStorage
	)

inlineprotected

Definition at line 155 of file SparseTensorIterator.h.

◆ SparseIterator() [2/3]

mlir::sparse_tensor::SparseIterator::SparseIterator	(	IterKind	kind,
		unsigned	cursorValsCnt,
		SmallVectorImpl< Value > &	cursorValStorage,
		const SparseIterator &	delegate
	)

inlineprotected

Definition at line 161 of file SparseTensorIterator.h.

◆ SparseIterator() [3/3]

mlir::sparse_tensor::SparseIterator::SparseIterator	(	IterKind	kind,
		const SparseIterator &	wrap,
		unsigned	extraCursorCnt = `0`
	)

inlineprotected

Definition at line 167 of file SparseTensorIterator.h.

References wrap().

◆ ~SparseIterator()

virtual mlir::sparse_tensor::SparseIterator::~SparseIterator ( )

virtualdefault

Member Function Documentation

◆ deref()

Value SparseIterator::deref	(	OpBuilder &	b,
		Location	l
	)

Definition at line 1021 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), derefImpl(), emitStrategy, getCrd(), getCursor(), getDebugInterfacePrefix(), mlir::Builder::getIndexType(), mlir::Builder::getStringAttr(), mlir::kDebugInterface, and updateCrd().

Referenced by mlir::sparse_tensor::genCoIteration(), and genWhenInBound().

◆ derefImpl()

virtual Value mlir::sparse_tensor::SparseIterator::derefImpl	(	OpBuilder &	b,
		Location	l
	)

pure virtual

Referenced by deref().

◆ deserialize()

virtual void mlir::sparse_tensor::SparseIterator::deserialize ( ValueRange vs )

inlinevirtual

Definition at line 239 of file SparseTensorIterator.h.

◆ forward()

ValueRange SparseIterator::forward	(	OpBuilder &	b,
		Location	l
	)

Definition at line 1033 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), emitStrategy, forwardImpl(), getCursor(), getCursorValTypes(), getDebugInterfacePrefix(), mlir::Operation::getResults(), mlir::Builder::getStringAttr(), mlir::kDebugInterface, randomAccessible(), and seek().

Referenced by forwardIf(), and genLoopWithIterator().

◆ forwardIf()

ValueRange SparseIterator::forwardIf	(	OpBuilder &	b,
		Location	l,
		Value	cond
	)

virtual

Definition at line 1045 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), forward(), getCursor(), mlir::ValueRange::getTypes(), seek(), mlir::OpBuilder::setInsertionPointAfter(), mlir::OpBuilder::setInsertionPointToStart(), and YIELD.

◆ forwardImpl()

virtual ValueRange mlir::sparse_tensor::SparseIterator::forwardImpl	(	OpBuilder &	b,
		Location	l
	)

pure virtual

Referenced by forward().

◆ fromValues()

static std::unique_ptr<SparseIterator> mlir::sparse_tensor::SparseIterator::fromValues	(	IteratorType	dstTp,
		ValueRange	values,
		unsigned	tid
	)

static

◆ genForCond()

virtual std::pair<Value, Value> mlir::sparse_tensor::SparseIterator::genForCond	(	OpBuilder &	b,
		Location	l
	)

inlinevirtual

Definition at line 285 of file SparseTensorIterator.h.

References getCrd(), randomAccessible(), and upperBound().

Referenced by genLoopWithIterator().

◆ genInit()

void SparseIterator::genInit	(	OpBuilder &	b,
		Location	l,
		const SparseIterator *	p
	)

Definition at line 980 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), emitStrategy, genInitImpl(), getCursorValTypes(), getDebugInterfacePrefix(), mlir::Operation::getResults(), mlir::Builder::getStringAttr(), inherentBatch(), mlir::kDebugInterface, and seek().

Referenced by mlir::sparse_tensor::LoopEmitter::locateLvlAtAffineAddress().

◆ genInitImpl()

virtual void mlir::sparse_tensor::SparseIterator::genInitImpl	(	OpBuilder &	,
		Location	,
		const SparseIterator *
	)

pure virtual

Referenced by genInit().

◆ genNotEnd()

Value SparseIterator::genNotEnd	(	OpBuilder &	b,
		Location	l
	)

Definition at line 996 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), emitStrategy, genNotEndImpl(), getCursor(), getDebugInterfacePrefix(), mlir::Builder::getI1Type(), mlir::Operation::getResult(), mlir::Builder::getStringAttr(), and mlir::kDebugInterface.

Referenced by genWhenInBound(), and genWhileCond().

◆ genNotEndImpl()

virtual Value mlir::sparse_tensor::SparseIterator::genNotEndImpl	(	OpBuilder &	b,
		Location	l
	)

pure virtual

Referenced by genNotEnd().

◆ genWhileCond()

std::pair<Value, ValueRange> mlir::sparse_tensor::SparseIterator::genWhileCond	(	OpBuilder &	b,
		Location	l,
		ValueRange	vs
	)

inline

Definition at line 292 of file SparseTensorIterator.h.

References genNotEnd(), and linkNewScope().

Referenced by mlir::sparse_tensor::genCoIteration(), and genLoopWithIterator().

◆ getBatchCrds()

ValueRange mlir::sparse_tensor::SparseIterator::getBatchCrds ( ) const

inline

Definition at line 188 of file SparseTensorIterator.h.

References batchCrds.

◆ getCrd()

Value mlir::sparse_tensor::SparseIterator::getCrd ( ) const

inline

Definition at line 187 of file SparseTensorIterator.h.

Referenced by deref(), genCoIterateBranchNest(), mlir::sparse_tensor::genCoIteration(), genForCond(), and mlir::sparse_tensor::LoopEmitter::getCoord().

◆ getCurPosition()

virtual ValueRange mlir::sparse_tensor::SparseIterator::getCurPosition ( ) const

inlinevirtual

Definition at line 282 of file SparseTensorIterator.h.

References getCursor().

◆ getCursor()

ValueRange mlir::sparse_tensor::SparseIterator::getCursor ( ) const

inline

Definition at line 189 of file SparseTensorIterator.h.

Referenced by deref(), forward(), forwardIf(), mlir::sparse_tensor::genCoIteration(), genLoopWithIterator(), genNotEnd(), getCurPosition(), and locate().

◆ getCursorValTypes()

virtual SmallVector<Type> mlir::sparse_tensor::SparseIterator::getCursorValTypes ( OpBuilder & b ) const

pure virtual

Referenced by forward(), genInit(), and locate().

◆ getDebugInterfacePrefix()

virtual std::string mlir::sparse_tensor::SparseIterator::getDebugInterfacePrefix ( ) const

pure virtual

Referenced by deref(), forward(), genInit(), genNotEnd(), and locate().

◆ getMutCursorVals()

MutableArrayRef<Value> mlir::sparse_tensor::SparseIterator::getMutCursorVals ( )

inlineprotected

Definition at line 323 of file SparseTensorIterator.h.

◆ inherentBatch()

void mlir::sparse_tensor::SparseIterator::inherentBatch ( const SparseIterator & parent )

inlineprotected

Definition at line 328 of file SparseTensorIterator.h.

References batchCrds.

Referenced by genInit().

◆ isBatchIterator()

virtual bool mlir::sparse_tensor::SparseIterator::isBatchIterator ( ) const

pure virtual

◆ iteratableByFor()

virtual bool mlir::sparse_tensor::SparseIterator::iteratableByFor ( ) const

inlinevirtual

Definition at line 220 of file SparseTensorIterator.h.

Referenced by genLoopWithIterator().

◆ linkNewScope()

ValueRange mlir::sparse_tensor::SparseIterator::linkNewScope ( ValueRange pos )

inline

Definition at line 313 of file SparseTensorIterator.h.

References randomAccessible(), and seek().

Referenced by mlir::sparse_tensor::genCoIteration(), genLoopWithIterator(), and genWhileCond().

◆ locate()

void SparseIterator::locate	(	OpBuilder &	b,
		Location	l,
		Value	crd
	)

Definition at line 1007 of file SparseTensorIterator.cpp.

References mlir::OpBuilder::create(), emitStrategy, getCursor(), getCursorValTypes(), getDebugInterfacePrefix(), mlir::Builder::getStringAttr(), mlir::kDebugInterface, locateImpl(), seek(), and updateCrd().

Referenced by mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls(), and mlir::sparse_tensor::LoopEmitter::locateLvlAtAffineAddress().

◆ locateImpl()

virtual void mlir::sparse_tensor::SparseIterator::locateImpl	(	OpBuilder &	b,
		Location	l,
		Value	crd
	)

inlinevirtual

Definition at line 267 of file SparseTensorIterator.h.

Referenced by locate().

◆ randomAccessible()

virtual bool mlir::sparse_tensor::SparseIterator::randomAccessible ( ) const

pure virtual

Referenced by forward(), genForCond(), linkNewScope(), and mlir::sparse_tensor::LoopEmitter::locateLvlAtAffineAddress().

◆ seek()

void mlir::sparse_tensor::SparseIterator::seek ( ValueRange vals )

inline

Definition at line 194 of file SparseTensorIterator.h.

References copy().

Referenced by forward(), forwardIf(), genInit(), linkNewScope(), and locate().

◆ serialize()

virtual SmallVector<Value> mlir::sparse_tensor::SparseIterator::serialize ( ) const

inlinevirtual

Definition at line 236 of file SparseTensorIterator.h.

◆ setSparseEmitStrategy()

void mlir::sparse_tensor::SparseIterator::setSparseEmitStrategy ( SparseEmitStrategy strategy )

inline

Definition at line 180 of file SparseTensorIterator.h.

References emitStrategy.

Referenced by mlir::sparse_tensor::makeSynLevelAndIterator().

◆ toValues()

SmallVector<Value> mlir::sparse_tensor::SparseIterator::toValues ( ) const

inline

Definition at line 206 of file SparseTensorIterator.h.

◆ updateCrd()

void mlir::sparse_tensor::SparseIterator::updateCrd ( Value crd )

inlineprotected

Definition at line 321 of file SparseTensorIterator.h.

Referenced by deref(), and locate().

◆ upperBound()

virtual Value mlir::sparse_tensor::SparseIterator::upperBound	(	OpBuilder &	b,
		Location	l
	)		const

pure virtual

Referenced by genForCond().

Member Data Documentation

◆ batchCrds

SmallVector<Value> mlir::sparse_tensor::SparseIterator::batchCrds

protected

Definition at line 333 of file SparseTensorIterator.h.

Referenced by getBatchCrds(), and inherentBatch().

◆ emitStrategy

SparseEmitStrategy mlir::sparse_tensor::SparseIterator::emitStrategy

protected

Definition at line 332 of file SparseTensorIterator.h.

Referenced by deref(), forward(), genInit(), genNotEnd(), locate(), and setSparseEmitStrategy().

◆ kind

const IterKind mlir::sparse_tensor::SparseIterator::kind

Definition at line 336 of file SparseTensorIterator.h.

Referenced by mlir::sparse_tensor::LoopEmitter::locateLvlAtAffineAddress().

◆ lvl

const unsigned mlir::sparse_tensor::SparseIterator::lvl

Definition at line 337 of file SparseTensorIterator.h.

Referenced by mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls().

◆ tid

const unsigned mlir::sparse_tensor::SparseIterator::tid

Definition at line 337 of file SparseTensorIterator.h.

Referenced by mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls().

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

lib/Dialect/SparseTensor/Transforms/Utils/SparseTensorIterator.h
lib/Dialect/SparseTensor/Transforms/Utils/SparseTensorIterator.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SparseIterator() [1/3]

◆ SparseIterator() [2/3]

◆ SparseIterator() [3/3]

◆ ~SparseIterator()

Member Function Documentation

◆ deref()

◆ derefImpl()

◆ deserialize()

◆ forward()

◆ forwardIf()

◆ forwardImpl()

◆ fromValues()

◆ genForCond()

◆ genInit()

◆ genInitImpl()

◆ genNotEnd()

◆ genNotEndImpl()

◆ genWhileCond()

◆ getBatchCrds()

◆ getCrd()

◆ getCurPosition()

◆ getCursor()

◆ getCursorValTypes()

◆ getDebugInterfacePrefix()

◆ getMutCursorVals()

◆ inherentBatch()

◆ isBatchIterator()

◆ iteratableByFor()

◆ linkNewScope()

◆ locate()

◆ locateImpl()

◆ randomAccessible()

◆ seek()

◆ serialize()

◆ setSparseEmitStrategy()

◆ toValues()

◆ updateCrd()

◆ upperBound()

Member Data Documentation

◆ batchCrds

◆ emitStrategy

◆ kind

◆ lvl

◆ tid