Struct tc_tensor::SparseTensor

pub struct SparseTensor<FD, FS, D, T, A> { /* fields omitted */ }

A Tensor stored as a Table of Coords and [Number] values

Implementations

impl<FD, FS, D, T, A> SparseTensor<FD, FS, D, T, A>

pub fn into_inner(self) -> A

Consume this SparseTensor and return its accessor.

impl<FD, FS, D, T> SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    D::FileClass: From<BTreeType>, 

pub async fn create(dir: &D, schema: Schema, txn_id: TxnId) -> TCResult<Self>

Create a new SparseTensor with the given schema

Trait Implementations

impl<FD: Clone, FS: Clone, D: Clone, T: Clone, A: Clone> Clone for SparseTensor<FD, FS, D, T, A>

fn clone(&self) -> SparseTensor<FD, FS, D, T, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FD, FS, D, T, A> CopyFrom<D, SparseTensor<FD, FS, D, T, A>> for SparseTable<FD, FS, D, T> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<BTreeType> + From<TensorType>, 

fn copy_from<'life0, 'async_trait>(
    instance: SparseTensor<FD, FS, D, T, A>,
    store: D,
    txn: &'life0 T
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Copy a new instance of Self from an existing instance.

impl<FD, FS, D, T, A> CopyFrom<D, SparseTensor<FD, FS, D, T, A>> for SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<BTreeType> + From<TensorType>, 

fn copy_from<'life0, 'async_trait>(
    instance: SparseTensor<FD, FS, D, T, A>,
    store: Self::Store,
    txn: &'life0 Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Copy a new instance of Self from an existing instance.

impl<FD, FS, D, T, A> Display for SparseTensor<FD, FS, D, T, A>

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

Formats the value using the given formatter.

impl<FD, FS, D, T, A> From<A> for SparseTensor<FD, FS, D, T, A>

fn from(accessor: A) -> Self

Performs the conversion.

impl<FD, FS, D, T, A> From<SparseTensor<FD, FS, D, T, A>> for Tensor<FD, FS, D, T> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

fn from(sparse: SparseTensor<FD, FS, D, T, A>) -> Self

Performs the conversion.

impl<FD, FS, D, T> FromStream for SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    D::FileClass: From<BTreeType> + From<TensorType>, 

type Context = T

The decoding context of this type, useful in situations where the stream to be decoded may be too large to hold in main memory.

fn from_stream<'life0, 'async_trait, De: Decoder>(
    txn: T,
    decoder: &'life0 mut De
) -> Pin<Box<dyn Future<Output = Result<Self, De::Error>> + Send + 'async_trait>> where
    De: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse this value using the given Decoder.

impl<'en, FD, FS, D, T, A> Hash<'en, D> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>, 

type Item = (Coord, Number)

type Txn = T

fn hashable<'async_trait>(
    &'en self,
    txn: &'en Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<TCBoxTryStream<'en, (Coord, Number)>>> + Send + 'async_trait>> where
    'en: 'async_trait,
    Self: 'async_trait, 

fn hash_hex<'async_trait>(
    &'en self,
    txn: &'en Self::Txn
) -> Pin<Box<dyn Future<Output = Result<String, TCError>> + Send + 'async_trait, Global>> where
    'en: 'async_trait,
    Self: Sync + 'async_trait, 

fn hash<'async_trait>(
    &'en self,
    txn: &'en Self::Txn
) -> Pin<Box<dyn Future<Output = Result<Bytes, TCError>> + Send + 'async_trait, Global>> where
    'en: 'async_trait,
    Self: Sync + 'async_trait, 

impl<'en, FD, FS, D, T, A> IntoView<'en, D> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Txn = T

type View = SparseTensorView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Return a View which can be encoded with en::IntoStream.

impl<FD, FS, D, T> Persist<D> for SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    D::FileClass: From<BTreeType> + From<TensorType>, 

type Schema = Schema

type Store = D

type Txn = T

fn schema(&self) -> &Self::Schema

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 Self::Txn,
    schema: Self::Schema,
    store: Self::Store
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Load a saved state from persistent storage.

impl<FD, FS, D, T> Restore<D> for SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    D::FileClass: From<BTreeType> + From<TensorType>, 

fn restore<'life0, 'life1, 'async_trait>(
    &'life0 self,
    backup: &'life1 Self,
    txn_id: TxnId
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

impl<FD, FS, D, T, A> TensorAccess for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>, 

fn dtype(&self) -> NumberType

The datatype of this Tensor

fn ndim(&self) -> usize

The number of dimensions of this Tensor

fn shape(&self) -> &Shape

The shape of this Tensor

fn size(&self) -> u64

The number of elements in this Tensor

impl<FD, FS, D, T, L, R> TensorBoolean<SparseTensor<FD, FS, D, T, R>> for SparseTensor<FD, FS, D, T, L> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    L: SparseAccess<FD, FS, D, T>,
    R: SparseAccess<FD, FS, D, T>, 

type Combine = SparseTensor<FD, FS, D, T, SparseCombinator<FD, FS, D, T, L, R>>

The result type of a boolean operation.

type LeftCombine = SparseTensor<FD, FS, D, T, SparseLeftCombinator<FD, FS, D, T, L, R>>

The result type of a boolean operation which may ignore right-hand values.

fn and(
    self,
    other: SparseTensor<FD, FS, D, T, R>
) -> TCResult<Self::LeftCombine>

Logical and

fn or(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Combine>

Logical or

fn xor(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Combine>

Logical xor

impl<FD, FS, D, T, A> TensorBoolean<Tensor<FD, FS, D, T>> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Combine = Tensor<FD, FS, D, T>

The result type of a boolean operation.

type LeftCombine = Tensor<FD, FS, D, T>

The result type of a boolean operation which may ignore right-hand values.

fn and(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Logical and

fn or(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Logical or

fn xor(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Logical xor

impl<FD, FS, D, T, L, R> TensorCompare<SparseTensor<FD, FS, D, T, R>> for SparseTensor<FD, FS, D, T, L> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    L: SparseAccess<FD, FS, D, T>,
    R: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Compare = SparseTensor<FD, FS, D, T, SparseCombinator<FD, FS, D, T, L, R>>

The result of a comparison operation

type Dense = DenseTensor<FD, FS, D, T, BlockListSparse<FD, FS, D, T, SparseCombinator<FD, FS, D, T, L, R>>>

The result of a comparison operation which can only return a dense Tensor

fn eq(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Dense>

Element-wise equality

fn gt(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Compare>

Element-wise greater-than

fn gte(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Dense>

Element-wise greater-or-equal

fn lt(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Compare>

Element-wise less-than

fn lte(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Dense>

Element-wise less-or-equal

fn ne(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Compare>

Element-wise not-equal

impl<FD, FS, D, T, A> TensorCompare<Tensor<FD, FS, D, T>> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Compare = Tensor<FD, FS, D, T>

The result of a comparison operation

type Dense = Tensor<FD, FS, D, T>

The result of a comparison operation which can only return a dense Tensor

fn eq(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Dense>

Element-wise equality

fn gt(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Compare>

Element-wise greater-than

fn gte(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Dense>

Element-wise greater-or-equal

fn lt(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Compare>

Element-wise less-than

fn lte(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Dense>

Element-wise less-or-equal

fn ne(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Compare>

Element-wise not-equal

impl<FD, FS, D, T, L, R> TensorDualIO<D, SparseTensor<FD, FS, D, T, R>> for SparseTensor<FD, FS, D, T, L> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    L: SparseWrite<FD, FS, D, T>,
    R: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Txn = T

The type of Transaction to expect

fn write<'async_trait>(
    self,
    txn: T,
    bounds: Bounds,
    other: SparseTensor<FD, FS, D, T, R>
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Overwrite the slice of this Tensor given by Bounds with the given value.

impl<FD, FS, D, T, A> TensorDualIO<D, Tensor<FD, FS, D, T>> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseWrite<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Txn = T

The type of Transaction to expect

fn write<'async_trait>(
    self,
    txn: Self::Txn,
    bounds: Bounds,
    other: Tensor<FD, FS, D, T>
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Overwrite the slice of this Tensor given by Bounds with the given value.

impl<FD, FS, D, T, A> TensorIO<D> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseWrite<FD, FS, D, T>, 

type Txn = T

The type of Transaction to expect

fn read_value<'async_trait>(
    self,
    txn: Self::Txn,
    coord: Coord
) -> Pin<Box<dyn Future<Output = TCResult<Number>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Read a single value from this Tensor.

fn write_value<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    bounds: Bounds,
    value: Number
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Write a single value to the slice of this Tensor with the given Bounds.

fn write_value_at<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    coord: Coord,
    value: Number
) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Overwrite a single element of this Tensor.

impl<FD, FS, D, T, A> TensorInstance for SparseTensor<FD, FS, D, T, A>

type Dense = DenseTensor<FD, FS, D, T, BlockListSparse<FD, FS, D, T, A>>

A dense representation of this Tensor

type Sparse = Self

A sparse representation of this Tensor

fn into_dense(self) -> Self::Dense

Return a dense representation of this Tensor.

fn into_sparse(self) -> Self::Sparse

Return a sparse representation of this Tensor.

impl<FD, FS, D, T, L, R> TensorMath<D, SparseTensor<FD, FS, D, T, R>> for SparseTensor<FD, FS, D, T, L> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    L: SparseAccess<FD, FS, D, T>,
    R: SparseAccess<FD, FS, D, T>, 

type Combine = SparseTensor<FD, FS, D, T, SparseCombinator<FD, FS, D, T, L, R>>

The result type of a math operation

type LeftCombine = SparseTensor<FD, FS, D, T, SparseLeftCombinator<FD, FS, D, T, L, R>>

The result type of a math operation which may ignore right-hand-side values

fn add(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Combine>

Add two tensors together.

fn div(
    self,
    other: SparseTensor<FD, FS, D, T, R>
) -> TCResult<Self::LeftCombine>

Divide self by other.

fn mul(
    self,
    other: SparseTensor<FD, FS, D, T, R>
) -> TCResult<Self::LeftCombine>

Multiply two tensors together.

fn sub(self, other: SparseTensor<FD, FS, D, T, R>) -> TCResult<Self::Combine>

Subtract other from self.

impl<FD, FS, D, T, A> TensorMath<D, Tensor<FD, FS, D, T>> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Combine = Tensor<FD, FS, D, T>

The result type of a math operation

type LeftCombine = Tensor<FD, FS, D, T>

The result type of a math operation which may ignore right-hand-side values

fn add(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Add two tensors together.

fn div(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Divide self by other.

fn mul(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Multiply two tensors together.

fn sub(self, other: Tensor<FD, FS, D, T>) -> TCResult<Self::Combine>

Subtract other from self.

impl<FD, FS, D, T, A> TensorReduce<D> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>,
    Self: TensorInstance,
    <Self as TensorInstance>::Dense: TensorReduce<D, Txn = T> + Send + Sync, 

type Txn = T

The type of Transaction to expect

type Reduce = SparseTensor<FD, FS, D, T, SparseReduce<FD, FS, D, T>>

The result type of a reduce operation

fn product(self, axis: usize) -> TCResult<Self::Reduce>

Return the product of this Tensor along the given axis.

fn product_all(&self, txn: T) -> TCBoxTryFuture<'_, Number>

Return the product of all elements in this Tensor.

fn sum(self, axis: usize) -> TCResult<Self::Reduce>

Return the sum of this Tensor along the given axis.

fn sum_all(&self, txn: T) -> TCBoxTryFuture<'_, Number>

Return the sum of all elements in this Tensor.

impl<FD, FS, D, T, A> TensorTransform for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

type Broadcast = SparseTensor<FD, FS, D, T, SparseBroadcast<FD, FS, D, T, A>>

A broadcast Tensor

type Cast = SparseTensor<FD, FS, D, T, SparseCast<FD, FS, D, T, A>>

A type-cast Tensor

type Expand = SparseTensor<FD, FS, D, T, SparseExpand<FD, FS, D, T, A>>

A Tensor with an expanded dimension

type Slice = SparseTensor<FD, FS, D, T, A::Slice>

A Tensor slice

type Transpose = SparseTensor<FD, FS, D, T, A::Transpose>

A transposed Tensor

fn broadcast(self, shape: Shape) -> TCResult<Self::Broadcast>

Broadcast this Tensor to the given shape.

fn cast_into(self, dtype: NumberType) -> TCResult<Self::Cast>

Cast this Tensor to the given dtype.

fn expand_dims(self, axis: usize) -> TCResult<Self::Expand>

Insert a new dimension of size 1 at the given axis.

fn slice(self, bounds: Bounds) -> TCResult<Self::Slice>

Return a slice of this Tensor with the given bounds.

fn transpose(self, permutation: Option<Vec<usize>>) -> TCResult<Self::Transpose>

Transpose this Tensor by reordering its axes according to the given permutation. If no permutation is given, the axes will be reversed.

impl<FD, FS, D, T, A> TensorUnary<D> for SparseTensor<FD, FS, D, T, A> where
    FD: File<Array>,
    FS: File<Node>,
    D: Dir,
    T: Transaction<D>,
    A: SparseAccess<FD, FS, D, T>, 

type Txn = T

The type of Transaction to expect

type Unary = SparseTensor<FD, FS, D, T, SparseUnary<FD, FS, D, T>>

The return type of a unary operation

fn abs(&self) -> TCResult<Self::Unary>

Element-wise absolute value

fn all<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<bool>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Return true if all elements in this Tensor are nonzero.

fn any<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<bool>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Return true if any element in this Tensor is nonzero.

fn not(&self) -> TCResult<Self::Unary>

Element-wise logical not

impl<FD, FS, D, T> Transact for SparseTensor<FD, FS, D, T, SparseTable<FD, FS, D, T>> where
    Self: Send + Sync,
    SparseTable<FD, FS, D, T>: Transact + Send + Sync, 

fn commit<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Commit this transaction.

fn finalize<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Delete any version data specific to this transaction.