Struct SquareMatrix

pub struct SquareMatrix(/* private fields */);

A square matrix.

Trait Implementations

impl Add<&SquareMatrix> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&SquareMatrix> for SquareMatrix

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

Performs the += operation.

impl AddAssign for SquareMatrix

fn add_assign(&mut self, vector: Self)

Performs the += operation.

impl Clone for SquareMatrix

fn clone(&self) -> SquareMatrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SquareMatrix

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

Formats the value using the given formatter.

impl Display for SquareMatrix

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

Formats the value using the given formatter.

impl Div<&f64> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&f64> for SquareMatrix

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

Performs the /= operation.

impl DivAssign<f64> for SquareMatrix

fn div_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the /= operation.

impl FromIterator<Vector> for SquareMatrix

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

Creates a value from an iterator.

impl Hessian for SquareMatrix

fn is_positive_definite(&self) -> bool

Checks whether the Hessian is positive-definite.

impl Index<usize> for SquareMatrix

type Output = Vector

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for SquareMatrix

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

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

impl Mul<&f64> for &SquareMatrix

type Output = SquareMatrix

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&f64> for SquareMatrix

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

Performs the *= operation.

impl MulAssign<f64> for SquareMatrix

fn mul_assign(&mut self, tensor_rank_0: TensorRank0)

Performs the *= operation.

impl PartialEq for SquareMatrix

fn eq(&self, other: &Self) -> 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 Rank2 for SquareMatrix

type Transpose = SquareMatrix

The type that is the transpose of the tensor.

fn cholesky_decomposition(&self) -> Result<SquareMatrix, TensorError>

Returns the Cholesky decomposition of the rank-2 tensor.

fn deviatoric(&self) -> Self

Returns the deviatoric component of the rank-2 tensor.

fn deviatoric_and_trace(&self) -> (Self, TensorRank0)

Returns the deviatoric component and trace of the rank-2 tensor.

fn is_diagonal(&self) -> bool

Checks whether the tensor is a diagonal tensor.

fn is_identity(&self) -> bool

Checks whether the tensor is the identity tensor.

fn squared_trace(&self) -> TensorRank0

Returns the trace of the rank-2 tensor squared.

fn trace(&self) -> TensorRank0

Returns the trace of the rank-2 tensor.

fn transpose(&self) -> Self::Transpose

Returns the transpose of the rank-2 tensor.

fn second_invariant(&self) -> TensorRank0

Returns the second invariant of the rank-2 tensor.

impl Sub<&SquareMatrix> for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for SquareMatrix

type Output = SquareMatrix

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&SquareMatrix> for SquareMatrix

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

Performs the -= operation.

impl SubAssign for SquareMatrix

fn sub_assign(&mut self, vector: Self)

Performs the -= operation.

impl Tensor for SquareMatrix

type Item = Vector

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 full_contraction(&self, tensor: &Self) -> TensorRank0

Returns the full contraction with another tensor.

fn get_at(&self, _indices: &[usize]) -> &TensorRank0

Returns a reference to the entry at the specified indices.

fn get_at_mut(&mut self, _indices: &[usize]) -> &mut TensorRank0

Returns a mutable reference to the entry at the specified indices.

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.

impl TensorVec for SquareMatrix

type Item = Vector

The type of item encountered when iterating over the tensor.

type Slice<'a> = &'a [&'a [f64]]

The type of slice corresponding to the tensor.

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

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

fn is_empty(&self) -> bool

Returns true if the vector contains no items.

fn len(&self) -> usize

Returns the number of items in the vector, also referred to as its ‘length’.

fn new(slice: Self::Slice<'_>) -> Self

Returns a tensor given a slice.

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

Appends an item to the back of the Vec.

fn zero(len: usize) -> Self

Returns the zero tensor.