Struct melior::dialect::ods::sparse_tensor::UnpackOperation

pub struct UnpackOperation<'c> { /* private fields */ }

An unpack operation. Returns the (values, coordinates) pair unpacked from the input tensor.

The unpack operation is the inverse of sparse_tensor::pack. It returns the values and per-level position and coordinate array to the user from the sparse tensor along with the actual length of the memory used in each returned buffer. This operation can be used for returning an unpacked MLIR sparse tensor to frontend; e.g., returning two numpy arrays to Python.

Disclaimer: This is the user’s responsibility to allocate large enough buffers to hold the sparse tensor. The sparse compiler simply copies each fields of the sparse tensor into the user-supplied buffer without bound checking.

TODO: the current implementation does not yet support non-identity mappings.

Example:

// input COO format |1.1, 0.0, 0.0, 0.0|
//    of 3x4 matrix |0.0, 0.0, 2.2, 3.3|
//                  |0.0, 0.0, 0.0, 0.0|
%v, %p, %c, %v_len, %p_len, %c_len = sparse_tensor.unpack %sp : tensor<3x4xf64, #SparseVector>
                                     outs(%od, %op, %oi : tensor<3xf64>, tensor<2xindex>, tensor<3x2xindex>)
                                  -> tensor<3xf64>, (tensor<2xindex>, tensor<3x2xindex>), index, (index, index)
// %v = arith.constant dense<[ 1.1,   2.2,   3.3 ]> : tensor<3xf64>
// %p = arith.constant dense<[ 0,              3 ]> : tensor<2xindex>
// %c = arith.constant dense<[[0,0], [1,2], [1,3]]> : tensor<3x2xindex>
// %v_len = 3
// %p_len = 2
// %c_len = 6 (3x2)

Implementations

impl<'c> UnpackOperation<'c>

pub fn name() -> &'static str

Returns a name.

pub fn as_operation(&self) -> &Operation<'c>

Returns a generic operation.

pub fn builder( context: &'c Context, location: Location<'c> ) -> UnpackOperationBuilder<'c, Unset, Unset, Unset, Unset, Unset, Unset, Unset>

Creates a builder.

pub fn ret_values(&self) -> Result<OperationResult<'c, '_>, Error>

pub fn ret_levels(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

pub fn val_len(&self) -> Result<OperationResult<'c, '_>, Error>

pub fn lvl_lens(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

pub fn tensor(&self) -> Result<Value<'c, '_>, Error>

pub fn out_values(&self) -> Result<Value<'c, '_>, Error>

pub fn out_levels(&self) -> impl Iterator<Item = Value<'c, '_>>

Trait Implementations

impl<'c> From<UnpackOperation<'c>> for Operation<'c>

fn from(operation: UnpackOperation<'c>) -> Self

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for UnpackOperation<'c>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(operation: Operation<'c>) -> Result<Self, Self::Error>

Performs the conversion.