Struct arrow::ipc::gen::SparseTensor::SparseTensorIndexCSF [−][src]
pub struct SparseTensorIndexCSF<'a> { pub _tab: Table<'a>, }
Compressed Sparse Fiber (CSF) sparse tensor index.
Fields
_tab: Table<'a>
Implementations
impl<'a> SparseTensorIndexCSF<'a>
[src]
impl<'a> SparseTensorIndexCSF<'a>
[src]pub fn init_from_table(table: Table<'a>) -> Self
[src]
pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>(
_fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>,
args: &'args SparseTensorIndexCSFArgs<'args>
) -> WIPOffset<SparseTensorIndexCSF<'bldr>>
[src]
_fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>,
args: &'args SparseTensorIndexCSFArgs<'args>
) -> WIPOffset<SparseTensorIndexCSF<'bldr>>
pub const VT_INDPTRTYPE: VOffsetT
[src]
pub const VT_INDPTRBUFFERS: VOffsetT
[src]
pub const VT_INDICESTYPE: VOffsetT
[src]
pub const VT_INDICESBUFFERS: VOffsetT
[src]
pub const VT_AXISORDER: VOffsetT
[src]
pub fn indptrType(&self) -> Int<'a>
[src]
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
pub fn indptrBuffers(&self) -> &'a [Buffer]ⓘ
[src]
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]
].
pub fn indicesType(&self) -> Int<'a>
[src]
The type of values in indicesBuffers
pub fn indicesBuffers(&self) -> &'a [Buffer]ⓘ
[src]
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]
].
pub fn axisOrder(&self) -> Vector<'a, i32>
[src]
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
impl<'a> Clone for SparseTensorIndexCSF<'a>
[src]
impl<'a> Clone for SparseTensorIndexCSF<'a>
[src]fn clone(&self) -> SparseTensorIndexCSF<'a>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Copy for SparseTensorIndexCSF<'a>
[src]
impl<'a> Copy for SparseTensorIndexCSF<'a>
[src]impl<'a> Follow<'a> for SparseTensorIndexCSF<'a>
[src]
impl<'a> Follow<'a> for SparseTensorIndexCSF<'a>
[src]impl<'a> PartialEq<SparseTensorIndexCSF<'a>> for SparseTensorIndexCSF<'a>
[src]
impl<'a> PartialEq<SparseTensorIndexCSF<'a>> for SparseTensorIndexCSF<'a>
[src]fn eq(&self, other: &SparseTensorIndexCSF<'a>) -> bool
[src]
fn ne(&self, other: &SparseTensorIndexCSF<'a>) -> bool
[src]
impl<'a> StructuralPartialEq for SparseTensorIndexCSF<'a>
[src]
impl<'a> StructuralPartialEq for SparseTensorIndexCSF<'a>
[src]impl Verifiable for SparseTensorIndexCSF<'_>
[src]
impl Verifiable for SparseTensorIndexCSF<'_>
[src]fn run_verifier(
v: &mut Verifier<'_, '_>,
pos: usize
) -> Result<(), InvalidFlatbuffer>
[src]
v: &mut Verifier<'_, '_>,
pos: usize
) -> Result<(), InvalidFlatbuffer>
Auto Trait Implementations
impl<'a> RefUnwindSafe for SparseTensorIndexCSF<'a>
impl<'a> RefUnwindSafe for SparseTensorIndexCSF<'a>
impl<'a> Send for SparseTensorIndexCSF<'a>
impl<'a> Send for SparseTensorIndexCSF<'a>
impl<'a> Sync for SparseTensorIndexCSF<'a>
impl<'a> Sync for SparseTensorIndexCSF<'a>
impl<'a> Unpin for SparseTensorIndexCSF<'a>
impl<'a> Unpin for SparseTensorIndexCSF<'a>
impl<'a> UnwindSafe for SparseTensorIndexCSF<'a>
impl<'a> UnwindSafe for SparseTensorIndexCSF<'a>