Struct SparseTensor

Source

pub struct SparseTensor<T> {
    pub indices: Vec<Vec<usize>>,
    pub values: Vec<T>,
    pub shape: Vec<usize>,
}

Expand description

Sparse tensor in COO (coordinate) format

Fields§

§indices: Vec<Vec<usize>>

Indices for each non-zero element (one vector per dimension)

§values: Vec<T>

Values of non-zero elements

§shape: Vec<usize>

Shape of the tensor

Implementations§

Source §

impl<T> SparseTensor<T>
where T: Float + SparseElement + Debug + Copy + Sum + 'static,

Source

pub fn new( indices: Vec<Vec<usize>>, values: Vec<T>, shape: Vec<usize>, ) -> SparseResult<Self>

Create a new sparse tensor

Source

pub fn ndim(&self) -> usize

Get the number of dimensions

Source

pub fn nnz(&self) -> usize

Get the number of non-zero elements

Source

pub fn size(&self) -> usize

Get the total number of elements

Source

pub fn get(&self, indices: &[usize]) -> T

Get an element at the specified indices

Source

pub fn unfold(&self, mode: usize) -> SparseResult<CsrArray<T>>

Mode-n unfolding (matricization)

Unfolds the tensor along the specified mode into a matrix.

Source

pub fn fold( matrix: &dyn SparseArray<T>, shape: Vec<usize>, mode: usize, ) -> SparseResult<Self>

Fold a matrix back into a tensor along the specified mode

Source

pub fn mode_product( &self, matrix: &CsrArray<T>, mode: usize, ) -> SparseResult<Self>

Tensor-matrix product along specified mode

Multiplies the tensor by a matrix along the given mode.

Source

pub fn inner_product(&self, other: &Self) -> SparseResult<T>

Inner product of two sparse tensors

Source

pub fn frobenius_norm(&self) -> T

Frobenius norm of the tensor

Trait Implementations§

Source §

impl<T: Clone> Clone for SparseTensor<T>

Source §

fn clone(&self) -> SparseTensor<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl<T: Debug> Debug for SparseTensor<T>

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> UnwindSafe for SparseTensor<T>
where T: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §