Struct TensorList

pub struct TensorList<T, const N: usize>(/* private fields */)
where
    T: Tensor;

Implementations

impl<T, const N: usize> TensorList<T, N>

where T: Tensor,

pub const fn const_from(array: [T; N]) -> Self

Associated function for const type conversion.

Trait Implementations

impl<T, const N: usize> Add<&TensorList<T, N>> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, const N: usize> Add for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, const N: usize> AddAssign<&TensorList<T, N>> for TensorList<T, N>

where T: Tensor,

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

Performs the += operation.

impl<T, const N: usize> AddAssign for TensorList<T, N>

where T: Tensor,

fn add_assign(&mut self, tensor_list: Self)

Performs the += operation.

impl<T, const N: usize> Clone for TensorList<T, N>

where T: Tensor + Clone,

fn clone(&self) -> TensorList<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, const N: usize> Debug for TensorList<T, N>

where T: Tensor + Debug,

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for TensorList<T, N>

where T: Tensor,

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Display for TensorList<T, N>

where T: Tensor,

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

Formats the value using the given formatter.

impl<T, const N: usize> Div<&f64> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, const N: usize> Div<f64> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, const N: usize> DivAssign<&f64> for TensorList<T, N>

where T: Tensor,

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

Performs the /= operation.

impl<T, const N: usize> DivAssign<f64> for TensorList<T, N>

where T: Tensor,

fn div_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the /= operation.

impl<T, const N: usize> From<[T; N]> for TensorList<T, N>

where T: Tensor,

fn from(tensor_array: [T; N]) -> Self

Converts to this type from the input type.

impl From<TensorList<TensorRank1<3, 0>, 10>> for TensorRank1List<3, 1, 10>

fn from(tensor_rank_1_list: TensorRank1List<3, 0, 10>) -> Self

Converts to this type from the input type.

impl From<TensorList<TensorRank1<3, 0>, 3>> for TensorRank1List<3, 1, 3>

fn from(tensor_rank_1_list: TensorRank1List<3, 0, 3>) -> Self

Converts to this type from the input type.

impl From<TensorList<TensorRank1<3, 0>, 4>> for TensorRank1List<3, 1, 4>

fn from(tensor_rank_1_list: TensorRank1List<3, 0, 4>) -> Self

Converts to this type from the input type.

impl From<TensorList<TensorRank1<3, 0>, 8>> for TensorRank1List<3, 1, 8>

fn from(tensor_rank_1_list: TensorRank1List<3, 0, 8>) -> Self

Converts to this type from the input type.

impl<T, const N: usize> FromIterator<T> for TensorList<T, N>

where T: Tensor,

fn from_iter<Ii: IntoIterator<Item = T>>(into_iterator: Ii) -> Self

Creates a value from an iterator.

impl<T, const N: usize> Index<usize> for TensorList<T, N>

where T: Tensor,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const N: usize> IndexMut<usize> for TensorList<T, N>

where T: Tensor,

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

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

impl<T, const N: usize> IntoIterator for TensorList<T, N>

where T: Tensor,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<TensorList<T, N> as IntoIterator>::Item, N>

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 W: usize> Mul<&TensorList<TensorRank1<D, J>, W>> for &TensorRank1List<D, I, W>

type Output = TensorRank2<D, I, J>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: &TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<&TensorList<TensorRank1<D, J>, W>> for &TensorRank2<D, I, J>

type Output = TensorList<TensorRank1<D, I>, W>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: &TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<&TensorList<TensorRank1<D, J>, W>> for TensorRank1List<D, I, W>

type Output = TensorRank2<D, I, J>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: &TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<&TensorList<TensorRank1<D, J>, W>> for TensorRank2<D, I, J>

type Output = TensorList<TensorRank1<D, I>, W>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: &TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const W: usize> Mul<&TensorList<f64, W>> for TensorRank0List<W>

type Output = f64

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, const N: usize> Mul<&f64> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

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, const W: usize, const X: usize> Mul<TensorList<TensorList<TensorRank2<D, J, K>, W>, X>> for &TensorRank2<D, I, J>

type Output = TensorList<TensorList<TensorRank2<D, I, K>, W>, X>

The resulting type after applying the * operator.

fn mul( self, tensor_rank_2_list_2d: TensorRank2List2D<D, J, K, W, X>, ) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize, const W: usize, const X: usize> Mul<TensorList<TensorList<TensorRank2<D, J, K>, W>, X>> for TensorRank2<D, I, J>

type Output = TensorList<TensorList<TensorRank2<D, I, K>, W>, X>

The resulting type after applying the * operator.

fn mul( self, tensor_rank_2_list_2d: TensorRank2List2D<D, J, K, W, X>, ) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<TensorList<TensorRank1<D, J>, W>> for &TensorRank1List<D, I, W>

type Output = TensorRank2<D, I, J>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<TensorList<TensorRank1<D, J>, W>> for &TensorRank2<D, I, J>

type Output = TensorList<TensorRank1<D, I>, W>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<TensorList<TensorRank1<D, J>, W>> for TensorRank1List<D, I, W>

type Output = TensorRank2<D, I, J>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const W: usize> Mul<TensorList<TensorRank1<D, J>, W>> for TensorRank2<D, I, J>

type Output = TensorList<TensorRank1<D, I>, W>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_list: TensorRank1List<D, J, W>) -> Self::Output

Performs the * operation.

impl<const W: usize> Mul<TensorList<f64, W>> for &TensorRank0List<W>

type Output = f64

The resulting type after applying the * operator.

fn mul(self, tensor_rank_0_list: TensorRank0List<W>) -> Self::Output

Performs the * operation.

impl<T, const N: usize> Mul<f64> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, const N: usize> MulAssign<&f64> for TensorList<T, N>

where T: Tensor,

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

Performs the *= operation.

impl<T, const N: usize> MulAssign<f64> for TensorList<T, N>

where T: Tensor,

fn mul_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the *= operation.

impl<T, const N: usize> Sub<&TensorList<T, N>> for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, const N: usize> Sub for TensorList<T, N>

where T: Tensor,

type Output = TensorList<T, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, const N: usize> SubAssign<&TensorList<T, N>> for TensorList<T, N>

where T: Tensor,

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

Performs the -= operation.

impl<T, const N: usize> SubAssign for TensorList<T, N>

where T: Tensor,

fn sub_assign(&mut self, tensor_list: Self)

Performs the -= operation.

impl<T, const N: usize> Sum for TensorList<T, N>

where T: 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<T, const N: usize> Tensor for TensorList<T, N>

where T: Tensor,

type Item = T

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<T, const N: usize> TensorArray for TensorList<T, N>

where T: Tensor + TensorArray,

type Array = [<T as TensorArray>::Array; N]

The type of array corresponding to the tensor.

type Item = T

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.