Skip to main content

MatrixLuciFactors

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, or one measured maximum residual for fixed pivots.

One entry per accepted pivot, then a trailing entry holding the largest magnitude of the remaining residual (0.0 once the full rank is reached). Both kernels report that same quantity for the pivots they selected, so the trailing entry is a residual and never a lower or upper bound standing in for one.

§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) -> 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<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> Freeze for MatrixLuciFactors<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for MatrixLuciFactors<T>

§

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<U> As for U

§

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

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> 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<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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V