Struct TensorVector

pub struct TensorVector<T>(/* private fields */)
where
    T: Tensor;

Implementations

impl<const D: usize, const I: usize> TensorVector<TensorRank1<D, I>>

pub fn zero(len: usize) -> Self

impl<const D: usize, const I: usize, const J: usize> TensorVector<TensorRank2<D, I, J>>

pub fn zero(len: usize) -> Self

impl<const D: usize, const I: usize, const J: usize> TensorVector<TensorVector<TensorRank2<D, I, J>>>

pub fn zero(len: usize) -> Self

impl<T> TensorVector<T>

where T: Tensor,

pub const fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer, or a dangling raw pointer valid for zero sized reads if the vector didn’t allocate.

Trait Implementations

impl<T> Add<&TensorVector<T>> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<&TensorVector<T>> for TensorVector<T>

where T: Tensor,

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

Performs the += operation.

impl<T> AddAssign for TensorVector<T>

where T: Tensor,

fn add_assign(&mut self, tensor_vec: Self)

Performs the += operation.

impl<T> Clone for TensorVector<T>

where T: Tensor + Clone,

fn clone(&self) -> TensorVector<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TensorVector<T>

where T: Tensor + Debug,

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

Formats the value using the given formatter.

impl<T> Default for TensorVector<T>

where T: Tensor,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for TensorVector<T>

where T: Tensor,

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

Formats the value using the given formatter.

impl<T> Div<&f64> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

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> Div<TensorVector<TensorVector<TensorRank2<D, I, J>>>> for &TensorRank1Vec<D, I>

type Output = TensorVector<TensorRank1<D, J>>

The resulting type after applying the / operator.

fn div(self, _tensor_rank_2_vec_2d: TensorRank2Vec2D<D, I, J>) -> Self::Output

Performs the / operation.

impl<T> Div<f64> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<&f64> for TensorVector<T>

where T: Tensor,

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

Performs the /= operation.

impl<T> DivAssign<f64> for TensorVector<T>

where T: Tensor,

fn div_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the /= operation.

impl<T> From<&[T]> for TensorVector<T>

where T: Tensor,

fn from(slice: &[T]) -> Self

Converts to this type from the input type.

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

where T: Tensor,

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

Converts to this type from the input type.

impl From<TensorVector<TensorRank1<3, 0>>> for TensorRank1Vec<3, 1>

fn from(tensor_rank_1_vec: TensorRank1Vec<3, 0>) -> Self

Converts to this type from the input type.

impl From<TensorVector<TensorRank1<3, 1>>> for TensorRank1Vec<3, 0>

fn from(tensor_rank_1_vec: TensorRank1Vec<3, 1>) -> Self

Converts to this type from the input type.

impl<const D: usize, const I: usize> From<TensorVector<TensorRank1<D, I>>> for Vec<[TensorRank0; D]>

fn from(tensor_rank_1_vec: TensorRank1Vec<D, I>) -> Self

Converts to this type from the input type.

impl<const D: usize, const I: usize> From<TensorVector<TensorRank1<D, I>>> for Vec<Vec<TensorRank0>>

fn from(tensor_rank_1_vec: TensorRank1Vec<D, I>) -> Self

Converts to this type from the input type.

impl<const D: usize, const I: usize> From<TensorVector<TensorRank1<D, I>>> for Vector

fn from(tensor_rank_1_vec: TensorRank1Vec<D, I>) -> Self

Converts to this type from the input type.

impl<const D: usize, const I: usize, const J: usize> From<TensorVector<TensorVector<TensorRank2<D, I, J>>>> for SquareMatrix

fn from(tensor_rank_2_vec_2d: TensorRank2Vec2D<D, I, J>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for TensorVector<T>

where T: Tensor,

fn from(vec: Vec<T>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for TensorVector<T>

where T: Tensor,

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

Creates a value from an iterator.

impl<T> Index<usize> for TensorVector<T>

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> IndexMut<usize> for TensorVector<T>

where T: Tensor,

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

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

impl<T> IntoIterator for TensorVector<T>

where T: Tensor,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<TensorVector<T> as IntoIterator>::Item>

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> Mul<&TensorVector<TensorRank1<D, I>>> for &Matrix

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: &TensorRank1Vec<D, I>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize> Mul<&TensorVector<TensorRank1<D, I>>> for &Vector

type Output = f64

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: &TensorRank1Vec<D, I>) -> Self::Output

Performs the * operation.

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

type Output = TensorVector<TensorRank1<D, I>>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: &TensorRank1Vec<D, J>) -> Self::Output

Performs the * operation.

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

type Output = TensorVector<TensorRank1<D, I>>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: &TensorRank1Vec<D, J>) -> Self::Output

Performs the * operation.

impl<T> Mul<&f64> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

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> Mul<TensorVector<TensorRank1<D, J>>> for &TensorRank2<D, I, J>

type Output = TensorVector<TensorRank1<D, I>>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: TensorRank1Vec<D, J>) -> Self::Output

Performs the * operation.

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

type Output = TensorVector<TensorRank1<D, I>>

The resulting type after applying the * operator.

fn mul(self, tensor_rank_1_vec: TensorRank1Vec<D, J>) -> Self::Output

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Mul<TensorVector<TensorVector<TensorRank2<D, J, K>>>> for &TensorRank2<D, I, J>

type Output = TensorVector<TensorVector<TensorRank2<D, I, K>>>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const D: usize, const I: usize, const J: usize, const K: usize> Mul<TensorVector<TensorVector<TensorRank2<D, J, K>>>> for TensorRank2<D, I, J>

type Output = TensorVector<TensorVector<TensorRank2<D, I, K>>>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<f64> for &TensorVector<T>

where T: Tensor, for<'a> &'a T: Mul<&'a TensorRank0, Output = T>,

type Output = TensorVector<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<f64> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<&f64> for TensorVector<T>

where T: Tensor,

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

Performs the *= operation.

impl<T> MulAssign<f64> for TensorVector<T>

where T: Tensor,

fn mul_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the *= operation.

impl<T> PartialEq for TensorVector<T>

where T: Tensor + PartialEq,

fn eq(&self, other: &TensorVector<T>) -> 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<T> Sub<&TensorVector<T>> for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub for &TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub for TensorVector<T>

where T: Tensor,

type Output = TensorVector<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<&TensorVector<T>> for TensorVector<T>

where T: Tensor,

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

Performs the -= operation.

impl<T> SubAssign for TensorVector<T>

where T: Tensor,

fn sub_assign(&mut self, tensor_vec: Self)

Performs the -= operation.

impl<T> Sum for TensorVector<T>

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> Tensor for TensorVector<T>

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> TensorVec for TensorVector<T>

where T: Tensor,

type Item = T

The type of element encountered when iterating over the tensor.

fn append(&mut self, other: &mut Self)

Moves all the elements of other into self, leaving other empty.

fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without reallocating.

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

fn new() -> Self

Constructs a new, empty Vec, not allocating until elements are pushed onto it.

fn push(&mut self, item: Self::Item)

Appends an element to the back of the Vec.

fn remove(&mut self, index: usize) -> Self::Item

Removes an element from the Vec and returns it, shifting elements to the left.

fn retain<F>(&mut self, f: F)

where F: FnMut(&Self::Item) -> bool,

Retains only the elements specified by the predicate.

fn swap_remove(&mut self, index: usize) -> Self::Item

Removes an element from the Vec and returns it, replacing it with the last element.

impl<T> StructuralPartialEq for TensorVector<T>

where T: Tensor,