Struct SparseTensorIndexCsf

pub struct SparseTensorIndexCsf {
    pub indptr_type: Box<Int>,
    pub indptr_buffers: Vec<Buffer>,
    pub indices_type: Box<Int>,
    pub indices_buffers: Vec<Buffer>,
    pub axis_order: Vec<i32>,
}

Compressed Sparse Fiber (CSF) sparse tensor index.

Generated from these locations:

• Table SparseTensorIndexCSF in the file SparseTensor.fbs:128

Fields

indptr_type: Box<Int>

CSF is a generalization of compressed sparse row (CSR) index. See smith2017knl

CSF index recursively compresses each dimension of a tensor into a set of prefix trees. Each path from a root to leaf forms one tensor non-zero index. CSF is implemented with two arrays of buffers and one arrays of integers.

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

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

As a prefix tree this would be represented as:

        0          1
       / \         |
      0   1        1
     /   / \       |
    0   0   1      1
   /|  /|   |    /| |
  1 2 0 2   0   0 1 2

The type of values in indptrBuffers

indptr_buffers: Vec<Buffer>

indptrBuffers stores the sparsity structure. Each two consecutive dimensions in a tensor correspond to a buffer in indptrBuffers. A pair of consecutive values at indptrBuffers[dim][i] and indptrBuffers[dim][i + 1] signify a range of nodes in indicesBuffers[dim + 1] who are children of indicesBuffers[dim][i] node.

For example, the indptrBuffers for the above X is:

  indptrBuffer(X) = [
                      [0, 2, 3],
                      [0, 1, 3, 4],
                      [0, 2, 4, 5, 8]
                    ].

indices_type: Box<Int>

The type of values in indicesBuffers

indices_buffers: Vec<Buffer>

indicesBuffers stores values of nodes. Each tensor dimension corresponds to a buffer in indicesBuffers. For example, the indicesBuffers for the above X is:

  indicesBuffer(X) = [
                       [0, 1],
                       [0, 1, 1],
                       [0, 0, 1, 1],
                       [1, 2, 0, 2, 0, 0, 1, 2]
                     ].

axis_order: Vec<i32>

axisOrder stores the sequence in which dimensions were traversed to produce the prefix tree. For example, the axisOrder for the above X is:

  axisOrder(X) = [0, 1, 2, 3].

Implementations

impl SparseTensorIndexCsf

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

Creates a SparseTensorIndexCsfBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_indptr_type: impl WriteAs<Offset<Int>>, field_indptr_buffers: impl WriteAs<Offset<[Buffer]>>, field_indices_type: impl WriteAs<Offset<Int>>, field_indices_buffers: impl WriteAs<Offset<[Buffer]>>, field_axis_order: impl WriteAs<Offset<[i32]>>, ) -> Offset<Self>

Trait Implementations

impl Clone for SparseTensorIndexCsf

fn clone(&self) -> SparseTensorIndexCsf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparseTensorIndexCsf

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

Formats the value using the given formatter.

impl Default for SparseTensorIndexCsf

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SparseTensorIndexCsf

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SparseTensorIndexCsf

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 SparseTensorIndexCsf

fn cmp(&self, other: &SparseTensorIndexCsf) -> 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 SparseTensorIndexCsf

fn eq(&self, other: &SparseTensorIndexCsf) -> 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 SparseTensorIndexCsf

fn partial_cmp(&self, other: &SparseTensorIndexCsf) -> 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 SparseTensorIndexCsf

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<SparseTensorIndexCsfRef<'a>> for SparseTensorIndexCsf

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for SparseTensorIndexCsf

impl StructuralPartialEq for SparseTensorIndexCsf

impl VectorWrite<Offset<SparseTensorIndexCsf>> for SparseTensorIndexCsf

Safety

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

impl WriteAs<Offset<SparseTensorIndexCsf>> for SparseTensorIndexCsf

impl WriteAsOffset<SparseTensorIndexCsf> for SparseTensorIndexCsf

impl<T0: WriteAs<Offset<Int>>, T1: WriteAs<Offset<[Buffer]>>, T2: WriteAs<Offset<Int>>, T3: WriteAs<Offset<[Buffer]>>, T4: WriteAs<Offset<[i32]>>> WriteAsOffset<SparseTensorIndexCsf> for SparseTensorIndexCsfBuilder<(T0, T1, T2, T3, T4)>

impl WriteAsOptional<Offset<SparseTensorIndexCsf>> for SparseTensorIndexCsf