LeastSquaresResult

Struct LeastSquaresResult 

Source
pub struct LeastSquaresResult<E, I>
where E: Scalar, I: Dimension,
{ pub singular_values: ArrayBase<OwnedRepr<<E as Scalar>::Real>, Dim<[usize; 1]>>, pub solution: ArrayBase<OwnedRepr<E>, I>, pub rank: i32, pub residual_sum_of_squares: Option<ArrayBase<OwnedRepr<<E as Scalar>::Real>, <I as Dimension>::Smaller>>, }
Expand description

Result of a LeastSquares computation

Takes two type parameters, E, the element type of the matrix (one of f32, f64, c32 or c64) and I, the dimension of b in the equation Ax = b (one of Ix1 or Ix2). If I is Ix1, the right-hand-side (RHS) is a n x 1 column vector and the solution is a m x 1 column vector. If I is Ix2, the RHS is a n x k matrix (which can be seen as solving Ax = b k times for different b) and the solution is a m x k matrix.

Fields§

§singular_values: ArrayBase<OwnedRepr<<E as Scalar>::Real>, Dim<[usize; 1]>>

The singular values of the matrix A in Ax = b

§solution: ArrayBase<OwnedRepr<E>, I>

The solution vector or matrix x which is the best solution to Ax = b, i.e. minimizing the 2-norm ||b - Ax||

§rank: i32

The rank of the matrix A in Ax = b

§residual_sum_of_squares: Option<ArrayBase<OwnedRepr<<E as Scalar>::Real>, <I as Dimension>::Smaller>>

If n < m and rank(A) == n, the sum of squares If b is a (m x 1) vector, this is a 0-dimensional array (single value) If b is a (m x k) matrix, this is a (k x 1) column vector

Trait Implementations§

Source§

impl<E, I> Clone for LeastSquaresResult<E, I>
where E: Clone + Scalar, I: Clone + Dimension, <E as Scalar>::Real: Clone, <I as Dimension>::Smaller: Clone,

Source§

fn clone(&self) -> LeastSquaresResult<E, I>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<E, I> Debug for LeastSquaresResult<E, I>
where E: Debug + Scalar, I: Debug + Dimension, <E as Scalar>::Real: Debug, <I as Dimension>::Smaller: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<E, I> Freeze for LeastSquaresResult<E, I>
where I: Freeze, <I as Dimension>::Smaller: Freeze,

§

impl<E, I> RefUnwindSafe for LeastSquaresResult<E, I>

§

impl<E, I> Send for LeastSquaresResult<E, I>
where <E as Scalar>::Real: Send, E: Send,

§

impl<E, I> Sync for LeastSquaresResult<E, I>
where <E as Scalar>::Real: Sync, E: Sync,

§

impl<E, I> Unpin for LeastSquaresResult<E, I>
where I: Unpin, <I as Dimension>::Smaller: Unpin,

§

impl<E, I> UnwindSafe for LeastSquaresResult<E, I>

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

Source§

fn vzip(self) -> V