Struct MatrixLuciFactors

Source

pub struct MatrixLuciFactors<T> {
    pub row_indices: Vec<usize>,
    pub col_indices: Vec<usize>,
    pub pivot_errors: Vec<f64>,
    pub rank: usize,
    pub left: Matrix<T>,
    pub right: Matrix<T>,
}

Expand description

High-level factors produced by MatrixLUCI.

This is the public result of the LUCI factorization facade. It exposes the selected pivot metadata and the left and right factors needed by higher-level tensor-network code without exposing the low-level pivot kernel substrate.

Related types: MatrixLUCI is the owning CI wrapper, while MatrixACA and RrLU are related matrix factorization entry points.

§Examples

use tensor4all_core::matrix_luci_factors_from_matrix;
use tensor4all_tensorbackend::from_vec2d;

let m = from_vec2d(vec![
    vec![1.0_f64, 2.0],
    vec![3.0, 4.0],
]);
let factors = matrix_luci_factors_from_matrix(&m, None).unwrap();
assert!(factors.rank >= 1);
assert_eq!(factors.row_indices.len(), factors.rank);
assert_eq!(factors.left.nrows(), m.nrows());
assert_eq!(factors.right.ncols(), m.ncols());

Fields§

§row_indices: Vec<usize>

Selected row indices.

§col_indices: Vec<usize>

Selected column indices.

§pivot_errors: Vec<f64>

Pivot error history.

§rank: usize

Selected rank.

§left: Matrix<T>

Left factor.

§right: Matrix<T>

Right factor.

Trait Implementations§

Source §

impl<T: Clone> Clone for MatrixLuciFactors<T>

Source §

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

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<T: Debug> Debug for MatrixLuciFactors<T>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> UnwindSafe for MatrixLuciFactors<T>
where T: UnwindSafe,

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

§

impl As for U

§

fn as_<T>(self) -> T
where T: CastFrom, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_:: can be used in the same way as T as U for numeric conversions. 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

§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§