Struct SparseTensorIndexCoo

pub struct SparseTensorIndexCoo {
    pub indices_type: Box<Int>,
    pub indices_strides: Option<Vec<i64>>,
    pub indices_buffer: Buffer,
    pub is_canonical: bool,
}

---

EXPERIMENTAL: Data structures for sparse tensors Coordinate (COO) format of sparse tensor index.

COO’s index list are represented as a NxM matrix, where N is the number of non-zero values, and M is the number of dimensions of a sparse tensor.

indicesBuffer stores the location and size of the data of this indices matrix. The value type and the stride of the indices matrix is specified in indicesType and indicesStrides fields.

For example, let X be a 2x3x4x5 tensor, and it has the following 6 non-zero values:

  X[0, 1, 2, 0] := 1
  X[1, 1, 2, 3] := 2
  X[0, 2, 1, 0] := 3
  X[0, 1, 3, 0] := 4
  X[0, 1, 2, 1] := 5
  X[1, 2, 0, 4] := 6

In COO format, the index matrix of X is the following 4x6 matrix:

  [[0, 0, 0, 0, 1, 1],
   [1, 1, 1, 2, 1, 2],
   [2, 2, 3, 1, 2, 0],
   [0, 1, 0, 0, 3, 4]]

When isCanonical is true, the indices is sorted in lexicographical order (row-major order), and it does not have duplicated entries. Otherwise, the indices may not be sorted, or may have duplicated entries.

Generated from these locations:

• Table SparseTensorIndexCOO in the file SparseTensor.fbs:58

Fields

indices_type: Box<Int>

The type of values in indicesBuffer

indices_strides: Option<Vec<i64>>

Non-negative byte offsets to advance one value cell along each dimension If omitted, default to row-major order (C-like).

indices_buffer: Buffer

The location and size of the indices matrix’s data

is_canonical: bool

This flag is true if and only if the indices matrix is sorted in row-major order, and does not have duplicated entries. This sort order is the same as of Tensorflow’s SparseTensor, but it is inverse order of SciPy’s canonical coo_matrix (SciPy employs column-major order for its coo_matrix).

Implementations

impl SparseTensorIndexCoo

pub fn builder() -> SparseTensorIndexCooBuilder<()>

Creates a SparseTensorIndexCooBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_indices_type: impl WriteAs<Offset<Int>>, field_indices_strides: impl WriteAsOptional<Offset<[i64]>>, field_indices_buffer: impl WriteAs<Buffer>, field_is_canonical: impl WriteAsDefault<bool, bool>, ) -> Offset<Self>

Trait Implementations

impl Clone for SparseTensorIndexCoo

fn clone(&self) -> SparseTensorIndexCoo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparseTensorIndexCoo

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

Formats the value using the given formatter.

impl Default for SparseTensorIndexCoo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SparseTensorIndexCoo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SparseTensorIndexCoo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SparseTensorIndexCoo

fn cmp(&self, other: &SparseTensorIndexCoo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SparseTensorIndexCoo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SparseTensorIndexCoo

fn partial_cmp(&self, other: &SparseTensorIndexCoo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SparseTensorIndexCoo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<SparseTensorIndexCooRef<'a>> for SparseTensorIndexCoo

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SparseTensorIndexCooRef<'a>) -> Result<Self>

Performs the conversion.

impl Eq for SparseTensorIndexCoo

impl StructuralPartialEq for SparseTensorIndexCoo

impl VectorWrite<Offset<SparseTensorIndexCoo>> for SparseTensorIndexCoo

Safety

The planus compiler generates implementations that initialize the bytes in write_values.

impl WriteAs<Offset<SparseTensorIndexCoo>> for SparseTensorIndexCoo

impl WriteAsOffset<SparseTensorIndexCoo> for SparseTensorIndexCoo

impl<T0: WriteAs<Offset<Int>>, T1: WriteAsOptional<Offset<[i64]>>, T2: WriteAs<Buffer>, T3: WriteAsDefault<bool, bool>> WriteAsOffset<SparseTensorIndexCoo> for SparseTensorIndexCooBuilder<(T0, T1, T2, T3)>

impl WriteAsOptional<Offset<SparseTensorIndexCoo>> for SparseTensorIndexCoo