Struct polars_arrow_rvsry99dx::ipc::gen::SparseTensor::SparseTensorIndexCOO

pub struct SparseTensorIndexCOO<'a> {
    pub _tab: Table<'a>,
}

---

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]]

Note that the indices are sorted in lexicographical order.

Fields

_tab: Table<'a>

Implementations

impl<'a> SparseTensorIndexCOO<'a>

pub fn init_from_table(table: Table<'a>) -> Self

pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>(
    _fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>,
    args: &'args SparseTensorIndexCOOArgs<'args>
) -> WIPOffset<SparseTensorIndexCOO<'bldr>>

pub const VT_INDICESTYPE: VOffsetT

pub const VT_INDICESSTRIDES: VOffsetT

pub const VT_INDICESBUFFER: VOffsetT

pub fn indicesType(&self) -> Option<Int<'a>>

The type of values in indicesBuffer

pub fn indicesStrides(&self) -> Option<Vector<'a, i64>>

Non-negative byte offsets to advance one value cell along each dimension

pub fn indicesBuffer(&self) -> Option<&'a Buffer>

The location and size of the indices matrix's data

Trait Implementations

impl<'a> Clone for SparseTensorIndexCOO<'a>

fn clone(&self) -> SparseTensorIndexCOO<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SparseTensorIndexCOO<'a>

impl<'a> Debug for SparseTensorIndexCOO<'a>

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

Formats the value using the given formatter.

impl<'a> Follow<'a> for SparseTensorIndexCOO<'a>

type Inner = SparseTensorIndexCOO<'a>

fn follow(buf: &'a [u8], loc: usize) -> Self::Inner

impl<'a> PartialEq<SparseTensorIndexCOO<'a>> for SparseTensorIndexCOO<'a>

fn eq(&self, other: &SparseTensorIndexCOO<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SparseTensorIndexCOO<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for SparseTensorIndexCOO<'a>