Struct TensorRank3

pub struct TensorRank3<const D: usize, const I: usize, const J: usize, const K: usize>(/* private fields */);

A d-dimensional tensor of rank 3.

D is the dimension, I, J, K are the configurations.

Trait Implementations

impl<const D: usize, const I: usize, const J: usize, const K: usize> Add<&TensorRank3<D, I, J, K>> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Add<TensorRank3<D, I, J, K>> for &TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the + operator.

fn add(self, tensor_rank_3: TensorRank3<D, I, J, K>) -> Self::Output

Performs the + operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Add for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> AddAssign<&TensorRank3<D, I, J, K>> for TensorRank3<D, I, J, K>

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

Performs the += operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> AddAssign for TensorRank3<D, I, J, K>

fn add_assign(&mut self, tensor_rank_3: Self)

Performs the += operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Clone for TensorRank3<D, I, J, K>

fn clone(&self) -> TensorRank3<D, I, J, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Debug for TensorRank3<D, I, J, K>

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

Formats the value using the given formatter.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Default for TensorRank3<D, I, J, K>

fn default() -> Self

Returns the “default value” for a type.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Display for TensorRank3<D, I, J, K>

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

Formats the value using the given formatter.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Div<&f64> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Div<f64> for &TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Div<f64> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> DivAssign<&f64> for TensorRank3<D, I, J, K>

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

Performs the /= operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> DivAssign<f64> for TensorRank3<D, I, J, K>

fn div_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the /= operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> FromIterator<TensorRank2<D, J, K>> for TensorRank3<D, I, J, K>

fn from_iter<Ii: IntoIterator<Item = TensorRank2<D, J, K>>>( into_iterator: Ii, ) -> Self

Creates a value from an iterator.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const L: usize> FromIterator<TensorRank3<D, J, K, L>> for TensorRank4<D, I, J, K, L>

fn from_iter<Ii: IntoIterator<Item = TensorRank3<D, J, K, L>>>( into_iterator: Ii, ) -> Self

Creates a value from an iterator.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Index<usize> for TensorRank3<D, I, J, K>

type Output = TensorRank2<D, J, K>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> IndexMut<usize> for TensorRank3<D, I, J, K>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> IntoIterator for TensorRank3<D, I, J, K>

type Item = TensorRank2<D, J, K>

The type of the elements being iterated over.

type IntoIter = IntoIter<<TensorRank3<D, I, J, K> as IntoIterator>::Item, D>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Mul<&f64> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Mul<f64> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> MulAssign<&f64> for TensorRank3<D, I, J, K>

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> MulAssign<f64> for TensorRank3<D, I, J, K>

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> PartialEq for TensorRank3<D, I, J, K>

fn eq(&self, other: &TensorRank3<D, I, J, K>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Sub<&TensorRank3<D, I, J, K>> for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Sub for &TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Sub for TensorRank3<D, I, J, K>

type Output = TensorRank3<D, I, J, K>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> SubAssign<&TensorRank3<D, I, J, K>> for TensorRank3<D, I, J, K>

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

Performs the -= operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> SubAssign for TensorRank3<D, I, J, K>

fn sub_assign(&mut self, tensor_rank_3: Self)

Performs the -= operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Sum for TensorRank3<D, I, J, K>

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<const D: usize, const I: usize, const J: usize, const K: usize> Tensor for TensorRank3<D, I, J, K>

type Item = TensorRank2<D, J, K>

The type of item encountered when iterating over the 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 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 full_contraction(&self, tensor: &Self) -> TensorRank0

Returns the full contraction with another tensor.

fn is_zero(&self) -> bool

Checks whether the tensor is the zero tensor.

fn norm(&self) -> TensorRank0

Returns the tensor norm.

fn norm_inf(&self) -> TensorRank0

Returns the infinity 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.

impl<const D: usize, const I: usize, const J: usize, const K: usize> TensorArray for TensorRank3<D, I, J, K>

type Array = [[[f64; D]; D]; D]

The type of array corresponding to the tensor.

type Item = TensorRank2<D, J, K>

The type of item encountered when iterating over the tensor.

fn as_array(&self) -> Self::Array

Returns the tensor as an array.

fn identity() -> Self

Returns the identity tensor.

fn new(array: Self::Array) -> Self

Returns a tensor given an array.

fn zero() -> Self

Returns the zero tensor.

impl<const D: usize, const I: usize, const J: usize, const K: usize> StructuralPartialEq for TensorRank3<D, I, J, K>