Struct melior::dialect::ods::sparse_tensor::PushBackOperation

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

A push_back operation. Pushes a value to the back of a given buffer.

Pushes value to the end of the given sparse tensor storage buffer inBuffer as indicated by the value of curSize and returns the new size of the buffer in newSize (newSize = curSize + n). The capacity of the buffer is recorded in the memref type of inBuffer. If the current buffer is full, then inBuffer.realloc is called before pushing the data to the buffer. This is similar to std::vector push_back.

The optional input n specifies the number of times to repeately push the value to the back of the tensor. When n is a compile-time constant, its value can’t be less than 1. If n is a runtime value that is less than 1, the behavior is undefined. Although using input n is semantically equivalent to calling push_back n times, it gives compiler more chances to to optimize the memory reallocation and the filling of the memory with the same value.

The inbounds attribute tells the compiler that the insertion won’t go beyond the current storage buffer. This allows the compiler to not generate the code for capacity check and reallocation. The typical usage will be for “dynamic” sparse tensors for which a capacity can be set beforehand.

Note that this operation is “impure” in the sense that even though the result is modeled through an SSA value, referencing the memref through the old SSA value after this operation is undefined behavior.

Example:

%buf, %newSize = sparse_tensor.push_back %curSize, %buffer, %val
   : index, memref<?xf64>, f64

%buf, %newSize = sparse_tensor.push_back inbounds %curSize, %buffer, %val
   : xindex, memref<?xf64>, f64

%buf, %newSize = sparse_tensor.push_back inbounds %curSize, %buffer, %val, %n
   : xindex, memref<?xf64>, f64

Implementations

impl<'c> PushBackOperation<'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> ) -> PushBackOperationBuilder<'c, Unset, Unset, Unset, Unset, Unset>

Creates a builder.

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

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

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

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

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

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

pub fn inbounds(&self) -> Result<Attribute<'c>, Error>

pub fn set_inbounds(&mut self, value: Attribute<'c>)

pub fn remove_inbounds(&mut self) -> Result<(), Error>

Trait Implementations

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

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

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for PushBackOperation<'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.