Struct ndarray_linalg::least_squares::LeastSquaresResult
source · [−]pub struct LeastSquaresResult<E: Scalar, I: Dimension> {
pub singular_values: Array1<E::Real>,
pub solution: Array<E, I>,
pub rank: i32,
pub residual_sum_of_squares: Option<Array<E::Real, I::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: Array1<E::Real>The singular values of the matrix A in Ax = b
solution: Array<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: i32The rank of the matrix A in Ax = b
residual_sum_of_squares: Option<Array<E::Real, I::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
sourceimpl<E: Clone + Scalar, I: Clone + Dimension> Clone for LeastSquaresResult<E, I> where
E::Real: Clone,
E::Real: Clone,
I::Smaller: Clone,
impl<E: Clone + Scalar, I: Clone + Dimension> Clone for LeastSquaresResult<E, I> where
E::Real: Clone,
E::Real: Clone,
I::Smaller: Clone,
sourcefn clone(&self) -> LeastSquaresResult<E, I>
fn clone(&self) -> LeastSquaresResult<E, I>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl<E, I> RefUnwindSafe for LeastSquaresResult<E, I> where
E: RefUnwindSafe,
I: RefUnwindSafe,
<E as Scalar>::Real: RefUnwindSafe,
<I as Dimension>::Smaller: RefUnwindSafe,
impl<E, I> Send for LeastSquaresResult<E, I> where
E: Send,
<E as Scalar>::Real: Send,
impl<E, I> Sync for LeastSquaresResult<E, I> where
E: Sync,
<E as Scalar>::Real: 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> where
E: RefUnwindSafe,
I: UnwindSafe,
<E as Scalar>::Real: RefUnwindSafe,
<I as Dimension>::Smaller: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more