Skip to main content

Eigen

Struct Eigen 

Source
pub struct Eigen<R> { /* private fields */ }
Expand description

The eigendecomposition A·V = V·Λ of a square matrix: its eigenvalues, the diagonal of Λ, and its eigenvectors, the columns of V, complex in general, each of length 1. When A has a full set of independent eigenvectors, A = V·Λ·V⁻¹. From Matrix::eigen.

§Examples

use a::math::complex::Complex;
use a::math::matrix::Matrix;

let a: Matrix<f64> = Matrix::from_rows(&[[2.0, 1.0], [1.0, 2.0]]);
let e = a.eigen();
let (v, w) = (e.vectors(), e.values());
// Each column is an eigenvector: A·v = λ·v.
let a = a.map(|&x| Complex::from(x));
for (j, &w) in w.iter().enumerate() {
    let v = Matrix::from_columns(&[v.column(j)]);
    let d = &(&a * &v) - &(&v * w);
    assert!(d.as_slice().iter().all(|x| x.abs() < 1e-14));
}

Implementations§

Source§

impl<R: Float> Eigen<R>

Source

pub fn values(&self) -> &[Complex<R>]

The eigenvalues, in the order of the columns of vectors.

Source

pub fn vectors(&self) -> &Matrix<Complex<R>>

The eigenvectors, each a column of length 1 in the 2-norm.

Trait Implementations§

Source§

impl<R: Clone> Clone for Eigen<R>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R: Debug> Debug for Eigen<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for Eigen<R>

§

impl<R> RefUnwindSafe for Eigen<R>

§

impl<R> Send for Eigen<R>
where Vec<Complex<R>>: Send, Matrix<Complex<R>>: Send,

§

impl<R> Sync for Eigen<R>
where Vec<Complex<R>>: Sync, Matrix<Complex<R>>: Sync,

§

impl<R> Unpin for Eigen<R>
where Vec<Complex<R>>: Unpin, Matrix<Complex<R>>: Unpin,

§

impl<R> UnsafeUnpin for Eigen<R>

§

impl<R> UnwindSafe for Eigen<R>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.