Enum tc_collection::tensor::Tensor

pub enum Tensor<Txn, FE> {
    Dense(Dense<Txn, FE>),
    Sparse(Sparse<Txn, FE>),
}

Expand description

An n-dimensional array of numbers which supports transactional reads and writes

Variants§

Dense(Dense<Txn, FE>)

Sparse(Sparse<Txn, FE>)

Trait Implementations§

impl<Txn, FE> AsType<Tensor<Txn, FE>> for Collection<Txn, FE>

fn as_type(&self) -> Option<&Tensor<Txn, FE>>

Borrow this instance as an instance of T if possible.

fn as_type_mut(&mut self) -> Option<&mut Tensor<Txn, FE>>

Borrow this instance mutably as an instance of T if possible.

fn into_type(self) -> Option<Tensor<Txn, FE>>

Convert this instance into an instance of T if possible.

impl<Txn, FE> Clone for Tensor<Txn, FE>

fn clone(&self) -> Self

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

impl<Txn: ThreadSafe, FE: ThreadSafe> Debug for Tensor<Txn, FE>

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

Formats the value using the given formatter. Read more

impl<Txn, FE> From<Dense<Txn, FE>> for Tensor<Txn, FE>

fn from(dense: Dense<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<DenseView<Txn, FE>> for Tensor<Txn, FE>

fn from(dense: DenseView<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<Sparse<Txn, FE>> for Tensor<Txn, FE>

fn from(sparse: Sparse<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<SparseView<Txn, FE>> for Tensor<Txn, FE>

fn from(sparse: SparseView<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<Tensor<Txn, FE>> for Collection<Txn, FE>

fn from(t: Tensor<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<Tensor<Txn, FE>> for TensorView<Txn, FE>

fn from(tensor: Tensor<Txn, FE>) -> Self

Converts to this type from the input type.

impl<Txn, FE> From<TensorBase<Txn, FE>> for Tensor<Txn, FE>

fn from(base: TensorBase<Txn, FE>) -> Tensor<Txn, FE>

Converts to this type from the input type.

impl<Txn: ThreadSafe, FE: ThreadSafe> Instance for Tensor<Txn, FE>

type Class = TensorType

The Class type of this instance

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

Returns the [Class] of this instance.

impl<'en, Txn, FE> IntoView<'en, FE> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Txn = Txn

The type of Transaction which this state supports

type View = TensorView

The type of encodable view returned by into_view

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<State> Route<State> for Tensor<State::Txn, State::FE>
where State: StateInstance + From<Tensor<State::Txn, State::FE>> + From<Tuple<Value>>, State::Class: From<NumberType>, State::FE: DenseCacheFile + AsType<Node>, Number: TryCastFrom<State>, Tensor<State::Txn, State::FE>: TryCastFrom<State>, Value: TryCastFrom<State>, bool: TryCastFrom<State>,

fn route<'a>( &'a self, path: &'a [PathSegment] ) -> Option<Box<dyn Handler<'a, State> + 'a>>

impl<Txn, FE> TensorBoolean<Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Combine = Tensor<Txn, FE>

The result type of a boolean operation.

type LeftCombine = Tensor<Txn, FE>

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<Txn, FE> TensorBooleanConst for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Combine = Tensor<Txn, FE>

The return type of a boolean operation.

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

Logical and

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

Logical or

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

Logical xor

impl<Txn, FE> TensorCast for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Cast = Tensor<Txn, FE>

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

Cast this tensor into the given dtype.

impl<Txn, FE> TensorCompare<Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Compare = Tensor<Txn, FE>

The result of a comparison operation

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

Element-wise equality

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

Element-wise greater-than

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

Element-wise greater-or-equal

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

Element-wise less-than

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

Element-wise less-or-equal

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

Element-wise not-equal

impl<Txn, FE> TensorCompareConst for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Compare = Tensor<Txn, FE>

The result of a comparison operation

fn eq_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise equality

fn gt_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise greater-than

fn ge_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise greater-or-equal

fn lt_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise less-than

fn le_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise less-or-equal

fn ne_const(self, other: Number) -> TCResult<Self::Compare>

Element-wise not-equal

impl<Txn, FE> TensorCond<Tensor<Txn, FE>, Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Cond = Tensor<Txn, FE>

The type of Tensor returned by cond

fn cond(self, then: Self, or_else: Self) -> TCResult<Self::Cond>

Use this tensor as a condition to select elements from then or or_else.

impl<Txn, FE> TensorConvert for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Dense = Dense<Txn, FE>

A dense representation of this Tensor

type Sparse = Sparse<Txn, FE>

A sparse representation of this Tensor

fn into_dense(self) -> Dense<Txn, FE>

Return a dense representation of this Tensor.

fn into_sparse(self) -> Sparse<Txn, FE>

Return a sparse representation of this Tensor.

impl<Txn, FE> TensorDiagonal for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Diagonal = Tensor<Txn, FE>

The type of Tensor returned by diagonal

fn diagonal(self) -> TCResult<Self::Diagonal>

impl<Txn: ThreadSafe, FE: ThreadSafe> TensorInstance for Tensor<Txn, FE>

fn dtype(&self) -> NumberType

fn shape(&self) -> &Shape

fn ndim(&self) -> usize

fn size(&self) -> u64

fn schema(&self) -> Schema

impl<Txn, FE> TensorMatMul<Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type MatMul = Tensor<Txn, FE>

The type of Tensor returned by matmul

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

impl<Txn, FE> TensorMath<Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Combine = Tensor<Txn, FE>

The result type of a math operation

type LeftCombine = Tensor<Txn, FE>

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 log(self, base: Self) -> TCResult<Self::LeftCombine>

Element-wise logarithm of self with respect to the given base.

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

Multiply two tensors together.

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

Raise self to the power of other.

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

Subtract other from self.

impl<Txn, FE> TensorMathConst for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Combine = Tensor<Txn, FE>

The return type of a math operation

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

Add a constant to this tensor

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

Divide self by other.

fn log_const(self, base: Number) -> TCResult<Self::Combine>

Element-wise logarithm

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

Multiply self by other.

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

Raise self to the power other.

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

Subtract other from self.

impl<Txn, FE> TensorRead for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

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

Read a single value from this Tensor.

impl<Txn, FE> TensorReduce for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Reduce = Tensor<Txn, FE>

The result type of a reduce operation

fn all<'async_trait>( self, txn_id: TxnId ) -> 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_id: TxnId ) -> 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 max(self, axes: Axes, keepdims: bool) -> TCResult<Self::Reduce>

Return the maximum of this Tensor along the given axis.

fn max_all<'async_trait>( self, txn_id: TxnId ) -> Pin<Box<dyn Future<Output = TCResult<Number>> + Send + 'async_trait>>
where Self: 'async_trait,

Return the maximum element in this Tensor.

fn min(self, axes: Axes, keepdims: bool) -> TCResult<Self::Reduce>

Return the minimum of this Tensor along the given axis.

fn min_all<'async_trait>( self, txn_id: TxnId ) -> Pin<Box<dyn Future<Output = TCResult<Number>> + Send + 'async_trait>>
where Self: 'async_trait,

Return the minimum element in this Tensor.

fn product(self, axes: Axes, keepdims: bool) -> TCResult<Self::Reduce>

Return the product of this Tensor along the given axis.

fn product_all<'async_trait>( self, txn_id: TxnId ) -> Pin<Box<dyn Future<Output = TCResult<Number>> + Send + 'async_trait>>
where Self: 'async_trait,

Return the product of all elements in this Tensor.

fn sum(self, axes: Axes, keepdims: bool) -> TCResult<Self::Reduce>

Return the sum of this Tensor along the given axis.

fn sum_all<'async_trait>( self, txn_id: TxnId ) -> Pin<Box<dyn Future<Output = TCResult<Number>> + Send + 'async_trait>>
where Self: 'async_trait,

Return the sum of all elements in this Tensor.

impl<Txn, FE> TensorTransform for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Broadcast = Tensor<Txn, FE>

A broadcast Tensor

type Expand = Tensor<Txn, FE>

A Tensor with an expanded dimension

type Reshape = Tensor<Txn, FE>

A reshaped Tensor

type Slice = Tensor<Txn, FE>

A Tensor slice

type Transpose = Tensor<Txn, FE>

A transposed Tensor

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

Broadcast this Tensor to the given shape.

fn expand(self, axes: Axes) -> TCResult<Self::Expand>

Insert a new dimension of size 1 at each of the given axes.

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

Change the shape of this Tensor.

fn slice(self, range: Range) -> TCResult<Self::Slice>

Return a slice of this Tensor with the given range.

fn transpose(self, permutation: Option<Axes>) -> 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<Txn, FE> TensorTrig for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Unary = Tensor<Txn, FE>

The return type of a unary operation

fn asin(self) -> TCResult<Self::Unary>

Element-wise arcsine

fn sin(self) -> TCResult<Self::Unary>

Element-wise sine

fn sinh(self) -> TCResult<Self::Unary>

Element-wise hyperbolic sine

fn acos(self) -> TCResult<Self::Unary>

Element-wise arccosine

fn cos(self) -> TCResult<Self::Unary>

Element-wise cosine

fn cosh(self) -> TCResult<Self::Unary>

Element-wise hyperbolic cosine

fn atan(self) -> TCResult<Self::Unary>

Element-wise arctangent

fn tan(self) -> TCResult<Self::Unary>

Element-wise tangent

fn tanh(self) -> TCResult<Self::Unary>

Element-wise hyperbolic tangent

impl<Txn, FE> TensorUnary for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Unary = Tensor<Txn, FE>

The return type of a unary operation

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

Element-wise absolute value

fn exp(self) -> TCResult<Self::Unary>

Element-wise exponentiation

fn ln(self) -> TCResult<Self::Unary>

Element-wise natural logarithm

fn round(self) -> TCResult<Self::Unary>

Element-wise round to the nearest integer

impl<Txn, FE> TensorUnaryBoolean for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

type Unary = Tensor<Txn, FE>

The return type of a unary operation

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

Element-wise logical not

impl<Txn, FE> TensorWrite for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node>,

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

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

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 Self: 'async_trait, 'life0: 'async_trait,

Overwrite a single element of this Tensor.

impl<Txn, FE> TensorWriteDual<Tensor<Txn, FE>> for Tensor<Txn, FE>
where Txn: Transaction<FE>, FE: DenseCacheFile + AsType<Node> + Clone,

fn write<'async_trait>( self, txn_id: TxnId, range: Range, value: Self ) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>>
where Self: 'async_trait,

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

impl<Txn, FE> TryCastFrom<Collection<Txn, FE>> for Tensor<Txn, FE>

fn can_cast_from(collection: &Collection<Txn, FE>) -> bool

Test if value can be cast into Self.

fn opt_cast_from(collection: Collection<Txn, FE>) -> Option<Self>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>
where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

Auto Trait Implementations§

impl<Txn, FE> !RefUnwindSafe for Tensor<Txn, FE>

impl<Txn, FE> Send for Tensor<Txn, FE>
where FE: Sync + Send, Txn: Sync + Send,

impl<Txn, FE> Sync for Tensor<Txn, FE>
where FE: Sync + Send, Txn: Sync + Send,

impl<Txn, FE> Unpin for Tensor<Txn, FE>
where FE: Unpin, Txn: Unpin,

impl<Txn, FE> !UnwindSafe for Tensor<Txn, FE>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<F, T> CastFrom<F> for T
where T: From<F>,

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.

impl<T, F> CastInto<F> for T
where F: CastFrom<T>,

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<F> Match for F

fn matches<T>(&self) -> bool
where T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<State, T> Public<State> for T
where State: StateInstance, T: Route<State> + Debug,

fn get<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value ) -> Pin<Box<dyn Future<Output = Result<State, TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value, value: State ) -> Pin<Box<dyn Future<Output = Result<(), TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

fn post<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], params: Map<State> ) -> Pin<Box<dyn Future<Output = Result<State, TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

fn delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value ) -> Pin<Box<dyn Future<Output = Result<(), TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<State, T> ToState<State> for T
where State: StateInstance, T: Clone + Into<State>,

fn to_state(&self) -> State

impl<F, T> TryCastFrom<F> for T
where T: CastFrom<F>,

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.

fn opt_cast_from(f: F) -> Option<T>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>
where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

impl<F, T> TryCastInto<T> for F
where T: TryCastFrom<F>,

fn can_cast_into(&self) -> bool

Test if self can be cast into T.

fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err>
where OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> ThreadSafe for T
where T: Send + Sync + 'static,