Trait Rank2

pub trait Rank2: Sized {
    type Transpose;

    // Required methods
    fn cholesky_decomposition(&self) -> Result<Self, TensorError>;
    fn deviatoric(&self) -> Self;
    fn deviatoric_and_trace(&self) -> (Self, TensorRank0);
    fn is_diagonal(&self) -> bool;
    fn is_identity(&self) -> bool;
    fn squared_trace(&self) -> TensorRank0;
    fn trace(&self) -> TensorRank0;
    fn transpose(&self) -> Self::Transpose;

    // Provided method
    fn second_invariant(&self) -> TensorRank0 { ... }
}

Common methods for rank-2 tensors.

Required Associated Types

type Transpose

The type that is the transpose of the tensor.

Required Methods

fn cholesky_decomposition(&self) -> Result<Self, 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.

Provided Methods

fn second_invariant(&self) -> TensorRank0

Returns the second invariant of the rank-2 tensor.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Rank2 for SquareMatrix

type Transpose = SquareMatrix

impl<const D: usize, const I: usize, const J: usize> Rank2 for TensorRank2<D, I, J>

type Transpose = TensorRank2<D, J, I>