A helper class around an array of values that corresponds to a sparse tensor. More...

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

Inheritance diagram for mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >:

Public Member Functions
FieldIndex	getMemRefFieldIndex (SparseTensorFieldKind kind, std::optional< Level > lvl) const
unsigned	getNumFields () const
Value	getSpecifier () const
	Getters: get the value for required field.
Value	getSpecifierField (OpBuilder &builder, Location loc, StorageSpecifierKind kind, std::optional< Level > lvl) const
Value	getLvlSize (OpBuilder &builder, Location loc, Level lvl) const
Value	getPosMemRef (Level lvl) const
Value	getValMemRef () const
Value	getMemRefField (SparseTensorFieldKind kind, std::optional< Level > lvl) const
Value	getMemRefField (FieldIndex fidx) const
Value	getPosMemSize (OpBuilder &builder, Location loc, Level lvl) const
Value	getCrdMemSize (OpBuilder &builder, Location loc, Level lvl) const
Value	getValMemSize (OpBuilder &builder, Location loc) const
Type	getMemRefElementType (SparseTensorFieldKind kind, std::optional< Level > lvl) const
Value	getField (FieldIndex fidx) const
ValueRange	getMemRefFields () const
std::pair< FieldIndex, unsigned >	getCrdMemRefIndexAndStride (Level lvl) const
Value	getAOSMemRef () const
RankedTensorType	getRankedTensorType () const
ValueArrayRef	getFields () const
StorageLayout	getLayout () const

Protected Member Functions
	SparseTensorDescriptorImpl (SparseTensorType stt, ValueArrayRef fields)

Protected Attributes
SparseTensorType	rType
ValueArrayRef	fields
StorageLayout	layout

Detailed Description

template<typename ValueArrayRef>
class mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >

A helper class around an array of values that corresponds to a sparse tensor.

This class provides a set of meaningful APIs to query and update a particular field in a consistent way. Users should not make assumptions on how a sparse tensor is laid out but instead rely on this class to access the right value for the right field.

Definition at line 51 of file SparseTensorDescriptor.h.

Constructor & Destructor Documentation

◆ SparseTensorDescriptorImpl()

template<typename ValueArrayRef>

mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::SparseTensorDescriptorImpl	(	SparseTensorType	stt,
		ValueArrayRef	fields )

inlineprotected

Definition at line 53 of file SparseTensorDescriptor.h.

References fields, getNumFields(), layout, rType, and SparseTensorDescriptorImpl().

Referenced by SparseTensorDescriptorImpl().

Member Function Documentation

◆ getAOSMemRef()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getAOSMemRef ( ) const

inline

Definition at line 139 of file SparseTensorDescriptor.h.

References mlir::sparse_tensor::CrdMemRef, getMemRefField(), and rType.

◆ getCrdMemRefIndexAndStride()

template<typename ValueArrayRef>

std::pair< FieldIndex, unsigned > mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getCrdMemRefIndexAndStride ( Level lvl ) const

inline

Definition at line 135 of file SparseTensorDescriptor.h.

References mlir::sparse_tensor::CrdMemRef, and layout.

Referenced by genCompressed().

◆ getCrdMemSize()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getCrdMemSize	(	OpBuilder &	builder,
		Location	loc,
		Level	lvl ) const

inline

Definition at line 111 of file SparseTensorDescriptor.h.

References getSpecifierField().

Referenced by genCompressed().

◆ getField()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getField ( FieldIndex fidx ) const

inline

Definition at line 126 of file SparseTensorDescriptor.h.

References fields.

Referenced by genCompressed(), getMemRefField(), and getMemRefField().

◆ getFields()

template<typename ValueArrayRef>

ValueArrayRef mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getFields ( ) const

inline

Definition at line 146 of file SparseTensorDescriptor.h.

References fields.

Referenced by genCompressed(), and mlir::sparse_tensor::genTuple().

◆ getLayout()

template<typename ValueArrayRef>

StorageLayout mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getLayout ( ) const

inline

Definition at line 147 of file SparseTensorDescriptor.h.

References layout.

◆ getLvlSize()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getLvlSize	(	OpBuilder &	builder,
		Location	loc,
		Level	lvl ) const

inline

Definition at line 84 of file SparseTensorDescriptor.h.

References getSpecifierField().

Referenced by allocSchemeForRank().

◆ getMemRefElementType()

template<typename ValueArrayRef>

Type mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getMemRefElementType	(	SparseTensorFieldKind	kind,
		std::optional< Level >	lvl ) const

inline

Definition at line 121 of file SparseTensorDescriptor.h.

References getMemRefField(), and mlir::sparse_tensor::getMemRefType().

Referenced by createPushback().

◆ getMemRefField() [1/2]

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getMemRefField ( FieldIndex fidx ) const

inline

Definition at line 101 of file SparseTensorDescriptor.h.

References fields, and getField().

◆ getMemRefField() [2/2]

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getMemRefField	(	SparseTensorFieldKind	kind,
		std::optional< Level >	lvl ) const

inline

Definition at line 96 of file SparseTensorDescriptor.h.

References getField(), and getMemRefFieldIndex().

Referenced by createPushback(), genCompressed(), getAOSMemRef(), getMemRefElementType(), getPosMemRef(), and getValMemRef().

◆ getMemRefFieldIndex()

template<typename ValueArrayRef>

FieldIndex mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getMemRefFieldIndex	(	SparseTensorFieldKind	kind,
		std::optional< Level >	lvl ) const

inline

Definition at line 63 of file SparseTensorDescriptor.h.

References layout.

Referenced by getMemRefField().

◆ getMemRefFields()

template<typename ValueArrayRef>

ValueRange mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getMemRefFields ( ) const

inline

Definition at line 131 of file SparseTensorDescriptor.h.

References fields.

◆ getNumFields()

template<typename ValueArrayRef>

unsigned mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getNumFields ( ) const

inline

Definition at line 69 of file SparseTensorDescriptor.h.

References fields.

Referenced by genCompressed(), and SparseTensorDescriptorImpl().

◆ getPosMemRef()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getPosMemRef ( Level lvl ) const

inline

Definition at line 88 of file SparseTensorDescriptor.h.

References getMemRefField(), and mlir::sparse_tensor::PosMemRef.

Referenced by genCompressed(), and genEndInsert().

◆ getPosMemSize()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getPosMemSize	(	OpBuilder &	builder,
		Location	loc,
		Level	lvl ) const

inline

Definition at line 106 of file SparseTensorDescriptor.h.

References getSpecifierField().

Referenced by genEndInsert().

◆ getRankedTensorType()

template<typename ValueArrayRef>

RankedTensorType mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getRankedTensorType ( ) const

inline

Definition at line 145 of file SparseTensorDescriptor.h.

References rType.

Referenced by allocSchemeForRank(), genCompressed(), genEndInsert(), and mlir::sparse_tensor::genTuple().

◆ getSpecifier()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getSpecifier ( ) const

inline

Getters: get the value for required field.

Definition at line 75 of file SparseTensorDescriptor.h.

References fields.

◆ getSpecifierField()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getSpecifierField	(	OpBuilder &	builder,
		Location	loc,
		StorageSpecifierKind	kind,
		std::optional< Level >	lvl ) const

inline

Definition at line 77 of file SparseTensorDescriptor.h.

References fields, and mlir::sparse_tensor::SparseTensorSpecifier::getSpecifierField().

Referenced by createPushback(), getCrdMemSize(), getLvlSize(), getPosMemSize(), and getValMemSize().

◆ getValMemRef()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getValMemRef ( ) const

inline

Definition at line 92 of file SparseTensorDescriptor.h.

References getMemRefField(), and mlir::sparse_tensor::ValMemRef.

◆ getValMemSize()

template<typename ValueArrayRef>

Value mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::getValMemSize	(	OpBuilder &	builder,
		Location	loc ) const

inline

Definition at line 116 of file SparseTensorDescriptor.h.

References getSpecifierField().

Member Data Documentation

◆ fields

template<typename ValueArrayRef>

ValueArrayRef mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::fields

protected

Definition at line 151 of file SparseTensorDescriptor.h.

Referenced by getField(), getFields(), getMemRefField(), getMemRefFields(), getNumFields(), getSpecifier(), getSpecifierField(), and SparseTensorDescriptorImpl().

◆ layout

template<typename ValueArrayRef>

StorageLayout mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::layout

protected

Definition at line 152 of file SparseTensorDescriptor.h.

Referenced by getCrdMemRefIndexAndStride(), getLayout(), getMemRefFieldIndex(), and SparseTensorDescriptorImpl().

◆ rType

template<typename ValueArrayRef>

SparseTensorType mlir::sparse_tensor::SparseTensorDescriptorImpl< ValueArrayRef >::rType

protected

Definition at line 150 of file SparseTensorDescriptor.h.

Referenced by getAOSMemRef(), getRankedTensorType(), and SparseTensorDescriptorImpl().

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

lib/Dialect/SparseTensor/Transforms/Utils/SparseTensorDescriptor.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SparseTensorDescriptorImpl()

Member Function Documentation

◆ getAOSMemRef()

◆ getCrdMemRefIndexAndStride()

◆ getCrdMemSize()

◆ getField()

◆ getFields()

◆ getLayout()

◆ getLvlSize()

◆ getMemRefElementType()

◆ getMemRefField() [1/2]

◆ getMemRefField() [2/2]

◆ getMemRefFieldIndex()

◆ getMemRefFields()

◆ getNumFields()

◆ getPosMemRef()

◆ getPosMemSize()

◆ getRankedTensorType()

◆ getSpecifier()

◆ getSpecifierField()

◆ getValMemRef()

◆ getValMemSize()

Member Data Documentation

◆ fields

◆ layout

◆ rType