Struct TensorTuple 

pub struct TensorTuple<T1, T2>(/* private fields */)
where
    T1: Tensor,
    T2: Tensor;

Trait Implementations

impl<T1, T2> Add<&TensorTuple<T1, T2>> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the + operator.

fn add(self, tensor_tuple: &Self) -> Self::Output

Performs the + operation.

impl<T1, T2> Add for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the + operator.

fn add(self, tensor_tuple: Self) -> Self::Output

Performs the + operation.

impl<T1, T2> AddAssign<&TensorTuple<T1, T2>> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn add_assign(&mut self, tensor_tuple: &Self)

Performs the += operation.

impl<T1, T2> AddAssign for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn add_assign(&mut self, tensor_tuple: Self)

Performs the += operation.

impl<T1, T2> Clone for TensorTuple<T1, T2>

where T1: Tensor + Clone, T2: Tensor + Clone,

fn clone(&self) -> TensorTuple<T1, T2>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T1, T2> Debug for TensorTuple<T1, T2>

where T1: Tensor + Debug, T2: Tensor + Debug,

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

Formats the value using the given formatter.

impl<T1, T2> Default for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn default() -> Self

Returns the “default value” for a type.

impl<T1, T2> Display for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

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

Formats the value using the given formatter.

impl<T1, T2> Div<&f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the / operator.

fn div(self, tensor_rank_0: &TensorRank0) -> Self::Output

Performs the / operation.

impl<T0, T1, T4, T5> Div<TensorTuple<T0, T1>> for &TensorTuple<T4, T5>

where T0: Tensor, T1: Tensor, T4: Tensor, T5: Tensor,

type Output = TensorTuple<T4, T5>

The resulting type after applying the / operator.

fn div(self, _tensor_tuple: TensorTuple<T0, T1>) -> Self::Output

Performs the / operation.

impl<T1, T2> Div<f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the / operator.

fn div(self, tensor_rank_0: TensorRank0) -> Self::Output

Performs the / operation.

impl<T1, T2> DivAssign<&f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn div_assign(&mut self, tensor_rank_0: &TensorRank0)

Performs the /= operation.

impl<T1, T2> DivAssign<f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn div_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the /= operation.

impl<'a, T1, T2> From<&'a TensorTuple<T1, T2>> for (&'a T1, &'a T2)

where T1: Tensor, T2: Tensor,

fn from(tensor_tuple: &'a TensorTuple<T1, T2>) -> Self

Converts to this type from the input type.

impl<T1, T2> From<(T1, T2)> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn from(tuple: (T1, T2)) -> Self

Converts to this type from the input type.

impl<T1, T2> From<TensorTuple<T1, T2>> for (T1, T2)

where T1: Tensor, T2: Tensor,

fn from(tensor_tuple: TensorTuple<T1, T2>) -> Self

Converts to this type from the input type.

impl<T1, T2> From<Vector> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn from(_vector: Vector) -> Self

Converts to this type from the input type.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Hessian for TensorTuple<TensorRank4<D, I, J, I, J>, TensorTuple<TensorRank4<D, K, L, I, J>, TensorTuple<TensorRank4<D, I, J, K, L>, TensorRank4<D, K, L, K, L>>>>

fn fill_into(self, square_matrix: &mut SquareMatrix)

Fills the Hessian into a square matrix.

fn retain_from(self, _retained: &[bool]) -> SquareMatrix

Return only the retained indices.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Jacobian for TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

fn fill_into(self, vector: &mut Vector)

Fills the Jacobian into a vector.

fn fill_into_chained(self, other: Vector, vector: &mut Vector)

Fills the Jacobian chained with a vector into another vector.

fn retain_from(self, _retained: &[bool]) -> Vector

Return only the retained indices.

fn zero_out(&mut self, _indices: &[usize])

Zero out the specified indices.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Mul<&TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>> for &Matrix

type Output = Vector

The resulting type after applying the * operator.

fn mul( self, tensor_tuple: &TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>, ) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Mul<&TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>> for &Vector

type Output = f64

The resulting type after applying the * operator.

fn mul( self, tensor_tuple: &TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>, ) -> Self::Output

Performs the * operation.

impl<T1, T2> Mul<&f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_0: &TensorRank0) -> Self::Output

Performs the * operation.

impl<T1, T2> Mul<f64> for &TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_0: TensorRank0) -> Self::Output

Performs the * operation.

impl<T1, T2> Mul<f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_0: TensorRank0) -> Self::Output

Performs the * operation.

impl<T1, T2> MulAssign<&f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn mul_assign(&mut self, tensor_rank_0: &TensorRank0)

Performs the *= operation.

impl<T1, T2> MulAssign<f64> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn mul_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the *= operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Solution for TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

fn decrement_from(&mut self, other: &Vector)

Decrements the solution from another vector.

fn decrement_from_chained(&mut self, other: &mut Vector, vector: Vector)

Decrements the solution chained with a vector from another vector.

fn decrement_from_retained(&mut self, _retained: &[bool], _other: &Vector)

Decrements the solution from another vector on retained entries.

impl<T1, T2> Sub<&TensorTuple<T1, T2>> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the - operator.

fn sub(self, tensor_tuple: &Self) -> Self::Output

Performs the - operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Sub<&Vector> for TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

type Output = TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

The resulting type after applying the - operator.

fn sub(self, vector: &Vector) -> Self::Output

Performs the - operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> Sub<Vector> for TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

type Output = TensorTuple<TensorRank2<D, I, J>, TensorRank2<D, K, L>>

The resulting type after applying the - operator.

fn sub(self, vector: Vector) -> Self::Output

Performs the - operation.

impl<T1, T2> Sub for &TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the - operator.

fn sub(self, _tensor_tuple: Self) -> Self::Output

Performs the - operation.

impl<T1, T2> Sub for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Output = TensorTuple<T1, T2>

The resulting type after applying the - operator.

fn sub(self, tensor_tuple: Self) -> Self::Output

Performs the - operation.

impl<T1, T2> SubAssign<&TensorTuple<T1, T2>> for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn sub_assign(&mut self, tensor_tuple: &Self)

Performs the -= operation.

impl<T1, T2> SubAssign for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn sub_assign(&mut self, tensor_tuple: Self)

Performs the -= operation.

impl<T1, T2> Sum for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

fn sum<Ii>(iter: Ii) -> Self

where Ii: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T1, T2> Tensor for TensorTuple<T1, T2>

where T1: Tensor, T2: Tensor,

type Item = <T1 as Tensor>::Item

The type of item encountered when iterating over the tensor.

fn full_contraction(&self, tensor_tuple: &Self) -> TensorRank0

Returns the full contraction with another tensor.

fn iter(&self) -> impl Iterator<Item = &Self::Item>

Returns an iterator.

fn iter_mut(&mut self) -> impl Iterator<Item = &mut Self::Item>

Returns an iterator that allows modifying each value.

fn len(&self) -> usize

Returns the number of elements, also referred to as the ‘length’.

fn norm_inf(&self) -> TensorRank0

Returns the infinity norm.

fn size(&self) -> usize

Returns the total number of entries.

fn error_count( &self, other: &Self, tol_abs: Scalar, tol_rel: Scalar, ) -> Option<usize>

Returns number of different entries given absolute and relative tolerances.

fn is_zero(&self) -> bool

Checks whether the tensor is the zero tensor.

fn norm(&self) -> TensorRank0

Returns the tensor norm.

fn norm_squared(&self) -> TensorRank0

Returns the tensor norm squared.

fn normalize(&mut self)

Normalizes the tensor.

fn normalized(self) -> Self

Returns the tensor normalized.

fn sub_abs(&self, other: &Self) -> Self

Returns the positive difference of the two tensors.

fn sub_rel(&self, other: &Self) -> Self

Returns the relative difference of the two tensors.