Struct Eigensystem 

pub struct Eigensystem<T> { /* private fields */ }

A non-empty collection of eigenpairs.

Implementations

impl<T> Eigensystem<T>

pub fn new(pairs: Vec<Eigenpair<T>>) -> Result<Eigensystem<T>, EigenError>

Creates a new eigensystem.

Errors

Returns EigenError::EmptyEigensystem when pairs is empty.

pub fn try_new(pairs: Vec<Eigenpair<T>>) -> Result<Eigensystem<T>, EigenError>

Creates a new eigensystem.

Errors

Returns EigenError::EmptyEigensystem when pairs is empty.

pub fn from_pairs( pairs: Vec<Eigenpair<T>>, ) -> Result<Eigensystem<T>, EigenError>

Creates a new eigensystem from eigenpairs.

Errors

Returns EigenError::EmptyEigensystem when pairs is empty.

pub fn pairs(&self) -> &[Eigenpair<T>]

Returns the stored eigenpairs.

pub fn into_inner(self) -> Vec<Eigenpair<T>>

Returns the stored eigenpairs.

pub const fn len(&self) -> usize

Returns the number of stored eigenpairs.

pub const fn is_empty(&self) -> bool

Returns whether the eigensystem is empty.

Trait Implementations

impl<T> AsRef<[Eigenpair<T>]> for Eigensystem<T>

fn as_ref(&self) -> &[Eigenpair<T>]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Eigensystem<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Eigensystem<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for Eigensystem<T>

where T: PartialEq,

fn eq(&self, other: &Eigensystem<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> Eq for Eigensystem<T>

where T: Eq,

impl<T> StructuralPartialEq for Eigensystem<T>