Enum tc_tensor::Tensor

pub enum Tensor<FD, FS, D, T> {
    Dense(DenseTensor<FD, FS, D, T, DenseAccessor<FD, FS, D, T>>),
    Sparse(SparseTensor<FD, FS, D, T, SparseAccessor<FD, FS, D, T>>),
}

An n-dimensional array of numbers which supports basic math and logic operations

Variants

Dense(DenseTensor<FD, FS, D, T, DenseAccessor<FD, FS, D, T>>)

Tuple Fields of Dense

0: DenseTensor<FD, FS, D, T, DenseAccessor<FD, FS, D, T>>

Sparse(SparseTensor<FD, FS, D, T, SparseAccessor<FD, FS, D, T>>)

Tuple Fields of Sparse

0: SparseTensor<FD, FS, D, T, SparseAccessor<FD, FS, D, T>>

Implementations

impl<FD, FS, D, T> 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>,
    D::FileClass: From<TensorType>, 

pub fn schema(&self) -> Schema

Trait Implementations

impl<FD: Clone, FS: Clone, D: Clone, T: Clone> Clone for Tensor<FD, FS, D, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FD, FS, D, T> Debug for Tensor<FD, FS, D, T>

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

Formats the value using the given formatter.

impl<FD, FS, D, T> Display for Tensor<FD, FS, D, T>

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

Formats the value using the given formatter.

impl<FD, FS, D, T, B> From<DenseTensor<FD, FS, D, T, B>> 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>,
    B: DenseAccess<FD, FS, D, T>,
    D::FileClass: From<TensorType>, 

fn from(dense: DenseTensor<FD, FS, D, T, B>) -> 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 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>,
    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<FD: File<Array>, FS: File<Node>, D: Dir, T: Transaction<D>> Instance for Tensor<FD, FS, D, T>

type Class = TensorType

The Class type of this instance

fn class(&self) -> Self::Class

Returns the [Class] of this instance.

impl<'en, FD, FS, D, T> IntoView<'en, D> 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>,
    D::FileClass: From<TensorType>, 

type Txn = T

type View = TensorView<'en>

fn into_view<'async_trait>(
    self,
    txn: T
) -> 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> TensorAccess 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>,
    D::FileClass: From<TensorType>, 

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, B> TensorBoolean<Tensor<FD, FS, D, T>> for DenseTensor<FD, FS, D, T, B> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    B: DenseAccess<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, 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> TensorBoolean<Tensor<FD, FS, D, T>> 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>,
    D::FileClass: From<TensorType>, 

type Combine = Self

The result type of a boolean operation.

type LeftCombine = Self

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

fn and(self, other: Self) -> TCResult<Self::LeftCombine>

Logical and

fn or(self, other: Self) -> TCResult<Self::Combine>

Logical or

fn xor(self, other: Self) -> TCResult<Self::Combine>

Logical xor

impl<FD, FS, D, T, B> TensorCompare<Tensor<FD, FS, D, T>> for DenseTensor<FD, FS, D, T, B> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    B: DenseAccess<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, 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> TensorCompare<Tensor<FD, FS, D, T>> 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>,
    D::FileClass: From<TensorType>, 

type Compare = Self

The result of a comparison operation

type Dense = Self

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

fn eq(self, other: Self) -> TCResult<Self>

Element-wise equality

fn gt(self, other: Self) -> TCResult<Self>

Element-wise greater-than

fn gte(self, other: Self) -> TCResult<Self>

Element-wise greater-or-equal

fn lt(self, other: Self) -> TCResult<Self>

Element-wise less-than

fn lte(self, other: Self) -> TCResult<Self>

Element-wise less-or-equal

fn ne(self, other: Self) -> TCResult<Self>

Element-wise not-equal

impl<FD, FS, D, T, B> TensorDualIO<D, Tensor<FD, FS, D, T>> for DenseTensor<FD, FS, D, T, B> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    B: DenseWrite<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: 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> 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> TensorDualIO<D, Tensor<FD, FS, D, T>> 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>,
    D::FileClass: From<TensorType>, 

type Txn = T

The type of Transaction to expect

fn write<'async_trait>(
    self,
    txn: T,
    bounds: Bounds,
    value: Self
) -> 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> TensorIO<D> 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>,
    D::FileClass: From<TensorType>, 

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> TensorInstance 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>,
    D::FileClass: From<TensorType>, 

type Dense = Self

A dense representation of this Tensor

type Sparse = Self

A sparse representation of this Tensor

fn into_dense(self) -> Self

Return a dense representation of this Tensor.

fn into_sparse(self) -> Self

Return a sparse representation of this Tensor.

impl<FD, FS, D, T, B> TensorMath<D, Tensor<FD, FS, D, T>> for DenseTensor<FD, FS, D, T, B> where
    FD: File<Array> + TryFrom<D::File, Error = TCError>,
    FS: File<Node> + TryFrom<D::File, Error = TCError>,
    D: Dir,
    T: Transaction<D>,
    B: DenseAccess<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> 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> TensorMath<D, Tensor<FD, FS, D, T>> 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>,
    D::FileClass: From<TensorType>, 

type Combine = Self

The result type of a math operation

type LeftCombine = Self

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

fn add(self, other: Self) -> TCResult<Self::Combine>

Add two tensors together.

fn div(self, other: Self) -> TCResult<Self::LeftCombine>

Divide self by other.

fn mul(self, other: Self) -> TCResult<Self::LeftCombine>

Multiply two tensors together.

fn sub(self, other: Self) -> TCResult<Self::Combine>

Subtract other from self.

impl<FD, FS, D, T> TensorReduce<D> 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>,
    D::FileClass: From<TensorType>, 

type Txn = T

The type of Transaction to expect

type Reduce = Self

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> TensorTransform 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>,
    D::FileClass: From<TensorType>, 

type Broadcast = Self

A broadcast Tensor

type Cast = Self

A type-cast Tensor

type Expand = Self

A Tensor with an expanded dimension

type Slice = Self

A Tensor slice

type Transpose = Self

A transposed Tensor

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

Broadcast this Tensor to the given shape.

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

Cast this Tensor to the given dtype.

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

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

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

Return a slice of this Tensor with the given bounds.

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

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> TensorUnary<D> 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>,
    D::FileClass: From<TensorType>, 

type Txn = T

The type of Transaction to expect

type Unary = Self

The return type of a unary operation

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

Element-wise absolute value

fn all<'async_trait>(
    self,
    txn: T
) -> 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: T
) -> 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>

Element-wise logical not