Struct arrow_ipc::gen::SparseTensor::SparseTensorIndexCSF

pub struct SparseTensorIndexCSF<'a> {
pub _tab: Table<'a>,
}
Expand description

Compressed Sparse Fiber (CSF) sparse tensor index.

§_tab: Table<'a>

Implementations§

source§

impl<'a> SparseTensorIndexCSF<'a>

source

source

source

source

source

source

source

source

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

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

source

pub fn indptrBuffers(&self) -> Vector<'a, 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]
].
source

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

The type of values in indicesBuffers

source

pub fn indicesBuffers(&self) -> Vector<'a, 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]
].
source

pub fn axisOrder(&self) -> Vector<'a, 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].

Trait Implementations§

source§

impl<'a> Clone for SparseTensorIndexCSF<'a>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SparseTensorIndexCSF<'_>

source§

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

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

source§

source§

source§

impl<'a> PartialEq for SparseTensorIndexCSF<'a>

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Verifiable for SparseTensorIndexCSF<'_>

source§

fn run_verifier( v: &mut Verifier<'_, '_>, pos: usize, ) -> Result<(), InvalidFlatbuffer>

Runs the verifier for this type, assuming its at position pos in the verifier’s buffer. Should not need to be called directly.
source§

source§

§

§

§

§

§

§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for Twhere T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.
§