Struct TensorMut 

pub struct TensorMut<'a, C: Memorable, const D: usize> { /* private fields */ }

A mutable view into tensor data.

This struct provides read-write access to tensor data without owning the underlying memory. It holds a mutable reference to the data along with dimension and stride information.

Implementations

impl<'a, C: Memorable, const D: usize> TensorMut<'a, C, D>

pub unsafe fn from_raw_parts( data: *mut C, dims: [usize; D], strides: [usize; D], ) -> Self

Creates a new SymSqTensorMut from raw parts.

Safety

The caller must ensure that data points to a valid memory block of C elements, and that dims and strides accurately describe the layout of the tensor within that memory block. The data pointer must be valid for the lifetime 'a and that it is safe to mutate the data.

pub fn dims(&self) -> &[usize; D]

Returns a reference to the dimensions of the tensor.

pub fn strides(&self) -> &[usize; D]

Returns a reference to the strides of the tensor.

pub fn rank(&self) -> usize

Returns the rank (number of dimensions) of the tensor.

pub fn num_elements(&self) -> usize

Returns the total number of elements in the tensor.

pub fn as_ptr(&self) -> *const C

Returns a mutable raw pointer to the tensor’s data.

pub fn as_ptr_mut(&mut self) -> *mut C

Returns a mutable raw pointer to the tensor’s data.

pub fn get(&self, indices: &[usize; D]) -> &C

Returns a reference to an element at the given indices.

Panics

Panics if the indices are out of bounds.

pub fn get_mut(&mut self, indices: &[usize; D]) -> &mut C

Returns a mutable reference to an element at the given indices.

Panics

Panics if the indices are out of bounds.

pub unsafe fn get_unchecked(&self, indices: &[usize; D]) -> &C

Returns an immutable reference to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

pub unsafe fn get_mut_unchecked(&mut self, indices: &[usize; D]) -> &mut C

Returns a mutable reference to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

pub unsafe fn ptr_at(&self, indices: &[usize; D]) -> *const C

Returns a raw pointer to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

pub unsafe fn ptr_at_mut(&mut self, indices: &[usize; D]) -> *mut C

Returns a mutable raw pointer to an element at the given indices, without performing bounds checks.

Safety

Calling this method with out-of-bounds indices is undefined behavior.

impl<'a, C: Memorable> TensorMut<'a, C, 4>

pub fn subtensor_ref(&self, m: usize) -> TensorRef<'a, C, 3>

Returns an immutable view of a 3D subtensor at the given index.

pub fn subtensor_mut(&mut self, m: usize) -> TensorMut<'a, C, 3>

Returns a mutable view of a 3D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> TensorRef<'a, C, 3>

Returns an immutable view of a 3D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

pub unsafe fn subtensor_mut_unchecked( &mut self, m: usize, ) -> TensorMut<'a, C, 3>

Returns a mutable view of a 3D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorMut<'a, C, 3>

pub fn subtensor_ref(&self, m: usize) -> MatRef<'a, C>

Returns an immutable matrix view of a 2D subtensor at the given index.

pub fn subtensor_mut(&mut self, m: usize) -> MatMut<'a, C>

Returns a mutable matrix view of a 2D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> MatRef<'a, C>

Returns an immutable matrix view of a 2D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

pub unsafe fn subtensor_mut_unchecked(&mut self, m: usize) -> MatMut<'a, C>

Returns a mutable matrix view of a 2D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorMut<'a, C, 2>

pub fn subtensor_ref(&self, m: usize) -> RowRef<'a, C>

Returns an immutable row view of a 1D subtensor at the given index.

pub fn subtensor_mut(&mut self, m: usize) -> RowMut<'a, C>

Returns a mutable row view of a 1D subtensor at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> RowRef<'a, C>

Returns an immutable row view of a 1D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

pub unsafe fn subtensor_mut_unchecked(&mut self, m: usize) -> RowMut<'a, C>

Returns a mutable row view of a 1D subtensor at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

impl<'a, C: Memorable> TensorMut<'a, C, 1>

pub fn subtensor_ref(&self, m: usize) -> &C

Returns an immutable reference to an element at the given index.

pub fn subtensor_mut(&mut self, m: usize) -> &mut C

Returns a mutable reference to an element at the given index.

pub unsafe fn subtensor_ref_unchecked(&self, m: usize) -> &C

Returns an immutable reference to an element at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

pub unsafe fn subtensor_mut_unchecked(&mut self, m: usize) -> &mut C

Returns a mutable reference to an element at the given index without bounds checking.

Safety

Caller must ensure that m is within bounds.

Trait Implementations

impl<'a, C: Memorable, const D: usize> Index<[usize; D]> for TensorMut<'a, C, D>

type Output = C

The returned type after indexing.

fn index(&self, indices: [usize; D]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, C: Memorable, const D: usize> IndexMut<[usize; D]> for TensorMut<'a, C, D>

fn index_mut(&mut self, indices: [usize; D]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.