Skip to main content

SparseCOOTensor

Struct SparseCOOTensor 

Source
pub struct SparseCOOTensor { /* private fields */ }
Expand description

Sparse tensor in COO (Coordinate) format.

COO format stores sparse tensors as a pair of tensors:

  • indices: shape [sparse_dim, nnz], dtype I64 — the coordinates of non-zero elements
  • values: shape [nnz, *dense_dims] — the values at those coordinates

For a sparse tensor with shape [3, 4, 5] and sparse_dim=2:

  • indices has shape [2, nnz] (row and column indices)
  • values has shape [nnz, 5] (the remaining dense dimension)

The coalesced flag indicates whether duplicate indices have been merged. A coalesced tensor has unique, sorted indices.

Implementations§

Source§

impl SparseCOOTensor

Source

pub fn new( indices: DenseI64Tensor, values: DenseTensor, dense_shape: Vec<usize>, coalesced: bool, ) -> Result<Self, SparseTensorError>

Create a new sparse COO tensor.

§Arguments
  • indices - shape [sparse_dim, nnz], dtype I64
  • values - shape [nnz, *dense_dims], any floating-point dtype
  • dense_shape - the full shape if this were a dense tensor
  • coalesced - whether indices are unique and sorted
§Errors

Returns error if indices/values shapes don’t match or indices are out of bounds.

Source

pub fn from_coords( coords: &[Vec<i64>], values: Vec<f64>, dense_shape: Vec<usize>, dtype: DType, device: Device, ) -> Result<Self, SparseTensorError>

Create a sparse COO tensor from coordinate lists.

§Arguments
  • coords - list of coordinate tuples, each of length sparse_dim
  • values - flat values for each coordinate
  • dense_shape - the full dense shape
  • dtype - dtype for the values
  • device - device for the tensor
Source

pub fn id(&self) -> u64

Source

pub fn indices(&self) -> &DenseI64Tensor

Source

pub fn values(&self) -> &DenseTensor

Source

pub fn dense_shape(&self) -> &[usize]

Source

pub fn sparse_dim(&self) -> usize

Source

pub fn nnz(&self) -> usize

Source

pub fn is_coalesced(&self) -> bool

Source

pub fn dtype(&self) -> DType

Source

pub fn device(&self) -> Device

Source

pub fn version(&self) -> u64

Source

pub fn to_dense(&self) -> Result<DenseTensor, SparseTensorError>

Convert this sparse tensor to a dense tensor.

This allocates a new dense tensor with zeros and fills in the non-zero values.

Trait Implementations§

Source§

impl Clone for SparseCOOTensor

Source§

fn clone(&self) -> SparseCOOTensor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseCOOTensor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SparseCOOTensor

Source§

fn eq(&self, other: &SparseCOOTensor) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SparseCOOTensor

Auto Trait Implementations§

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<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.