Struct SparseMatrixIndexCsx

pub struct SparseMatrixIndexCsx {
    pub compressed_axis: SparseMatrixCompressedAxis,
    pub indptr_type: Box<Int>,
    pub indptr_buffer: Buffer,
    pub indices_type: Box<Int>,
    pub indices_buffer: Buffer,
}

Compressed Sparse format, that is matrix-specific.

Generated from these locations:

• Table SparseMatrixIndexCSX in the file SparseTensor.fbs:80

Fields

compressed_axis: SparseMatrixCompressedAxis

Which axis, row or column, is compressed

indptr_type: Box<Int>

The type of values in indptrBuffer

indptr_buffer: Buffer

indptrBuffer stores the location and size of indptr array that represents the range of the rows. The i-th row spans from indptr[i] to indptr[i+1] in the data. The length of this array is 1 + (the number of rows), and the type of index value is long.

For example, let X be the following 6x4 matrix:

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

The array of non-zero values in X is:

  values(X) = [1, 2, 3, 4, 5, 6, 7, 8, 9].

And the indptr of X is:

  indptr(X) = [0, 2, 3, 5, 5, 8, 10].

indices_type: Box<Int>

The type of values in indicesBuffer

indices_buffer: Buffer

indicesBuffer stores the location and size of the array that contains the column indices of the corresponding non-zero values. The type of index value is long.

For example, the indices of the above X is:

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

Note that the indices are sorted in lexicographical order for each row.

Implementations

impl SparseMatrixIndexCsx

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

Creates a SparseMatrixIndexCsxBuilder for serializing an instance of this table.

pub fn create( builder: &mut Builder, field_compressed_axis: impl WriteAsDefault<SparseMatrixCompressedAxis, SparseMatrixCompressedAxis>, field_indptr_type: impl WriteAs<Offset<Int>>, field_indptr_buffer: impl WriteAs<Buffer>, field_indices_type: impl WriteAs<Offset<Int>>, field_indices_buffer: impl WriteAs<Buffer>, ) -> Offset<Self>

Trait Implementations

impl Clone for SparseMatrixIndexCsx

fn clone(&self) -> SparseMatrixIndexCsx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparseMatrixIndexCsx

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

Formats the value using the given formatter.

impl Default for SparseMatrixIndexCsx

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SparseMatrixIndexCsx

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SparseMatrixIndexCsx

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 SparseMatrixIndexCsx

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

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

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

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<SparseMatrixIndexCsxRef<'a>> for SparseMatrixIndexCsx

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for SparseMatrixIndexCsx

impl StructuralPartialEq for SparseMatrixIndexCsx

impl VectorWrite<Offset<SparseMatrixIndexCsx>> for SparseMatrixIndexCsx

Safety

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

impl WriteAs<Offset<SparseMatrixIndexCsx>> for SparseMatrixIndexCsx

impl WriteAsOffset<SparseMatrixIndexCsx> for SparseMatrixIndexCsx

impl<T0: WriteAsDefault<SparseMatrixCompressedAxis, SparseMatrixCompressedAxis>, T1: WriteAs<Offset<Int>>, T2: WriteAs<Buffer>, T3: WriteAs<Offset<Int>>, T4: WriteAs<Buffer>> WriteAsOffset<SparseMatrixIndexCsx> for SparseMatrixIndexCsxBuilder<(T0, T1, T2, T3, T4)>

impl WriteAsOptional<Offset<SparseMatrixIndexCsx>> for SparseMatrixIndexCsx