Struct SVD

pub struct SVD { /* private fields */ }

Singular Value Decomposition

Class for computing Singular Value Decomposition of a floating-point matrix. The Singular Value Decomposition is used to solve least-square problems, under-determined linear systems, invert matrices, compute condition numbers, and so on.

If you want to compute a condition number of a matrix or an absolute value of its determinant, you do not need u and vt. You can pass flags=SVD::NO_UV|… . Another flag SVD::FULL_UV indicates that full-size u and vt must be computed, which is not necessary most of the time.

See also

invert, solve, eigen, determinant

Implementations

impl SVD

pub fn default() -> Result<SVD>

the default constructor

initializes an empty SVD structure

pub fn new(src: &impl ToInputArray, flags: i32) -> Result<SVD>

the default constructor

initializes an empty SVD structure

Overloaded parameters

initializes an empty SVD structure and then calls SVD::operator()

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• flags: operation flags (SVD::Flags)

C++ default parameters

• flags: 0

pub fn new_def(src: &impl ToInputArray) -> Result<SVD>

@overload initializes an empty SVD structure and then calls SVD::operator()

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• flags: operation flags (SVD::Flags)

Note

This alternative version of [new] function uses the following default values for its arguments:

• flags: 0

pub fn compute_ext( src: &impl ToInputArray, w: &mut impl ToOutputArray, u: &mut impl ToOutputArray, vt: &mut impl ToOutputArray, flags: i32, ) -> Result<()>

decomposes matrix and stores the results to user-provided matrices

The methods/functions perform SVD of matrix. Unlike SVD::SVD constructor and SVD::operator(), they store the results to the user-provided matrices:

Mat A, w, u, vt;
SVD::compute(A, w, u, vt);

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• w: calculated singular values
• u: calculated left singular vectors
• vt: transposed matrix of right singular vectors
• flags: operation flags - see SVD::Flags.

C++ default parameters

• flags: 0

pub fn compute_ext_def( src: &impl ToInputArray, w: &mut impl ToOutputArray, u: &mut impl ToOutputArray, vt: &mut impl ToOutputArray, ) -> Result<()>

decomposes matrix and stores the results to user-provided matrices

The methods/functions perform SVD of matrix. Unlike SVD::SVD constructor and SVD::operator(), they store the results to the user-provided matrices:

Mat A, w, u, vt;
SVD::compute(A, w, u, vt);

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• w: calculated singular values
• u: calculated left singular vectors
• vt: transposed matrix of right singular vectors
• flags: operation flags - see SVD::Flags.

Note

This alternative version of SVD::compute_ext function uses the following default values for its arguments:

• flags: 0

pub fn compute( src: &impl ToInputArray, w: &mut impl ToOutputArray, flags: i32, ) -> Result<()>

decomposes matrix and stores the results to user-provided matrices

The methods/functions perform SVD of matrix. Unlike SVD::SVD constructor and SVD::operator(), they store the results to the user-provided matrices:

Mat A, w, u, vt;
SVD::compute(A, w, u, vt);

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• w: calculated singular values
• u: calculated left singular vectors
• vt: transposed matrix of right singular vectors
• flags: operation flags - see SVD::Flags.

Overloaded parameters

computes singular values of a matrix

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• w: calculated singular values
• flags: operation flags - see SVD::Flags.

C++ default parameters

• flags: 0

pub fn compute_def( src: &impl ToInputArray, w: &mut impl ToOutputArray, ) -> Result<()>

@overload computes singular values of a matrix

Parameters

• src: decomposed matrix. The depth has to be CV_32F or CV_64F.
• w: calculated singular values
• flags: operation flags - see SVD::Flags.

Note

This alternative version of SVD::compute function uses the following default values for its arguments:

• flags: 0

pub fn back_subst_multi( w: &impl ToInputArray, u: &impl ToInputArray, vt: &impl ToInputArray, rhs: &impl ToInputArray, dst: &mut impl ToOutputArray, ) -> Result<()>

performs back substitution

pub fn solve_z( src: &impl ToInputArray, dst: &mut impl ToOutputArray, ) -> Result<()>

solves an under-determined singular linear system

The method finds a unit-length solution x of a singular linear system A*x = 0. Depending on the rank of A, there can be no solutions, a single solution or an infinite number of solutions. In general, the algorithm solves the following problem:

Parameters

• src: left-hand-side matrix.
• dst: found solution.

Trait Implementations

impl Boxed for SVD

unsafe fn from_raw(ptr: <SVD as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <SVD as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <SVD as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> <SVD as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for SVD

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

Formats the value using the given formatter.

impl Drop for SVD

fn drop(&mut self)

Executes the destructor for this type.

impl SVDTrait for SVD

fn as_raw_mut_SVD(&mut self) -> *mut c_void

fn set_u(&mut self, val: Mat)

fn set_w(&mut self, val: Mat)

fn set_vt(&mut self, val: Mat)

fn apply(&mut self, src: &impl ToInputArray, flags: i32) -> Result<SVD>

the operator that performs SVD. The previously allocated u, w and vt are released.

fn apply_def(&mut self, src: &impl ToInputArray) -> Result<SVD>

the operator that performs SVD. The previously allocated u, w and vt are released.

impl SVDTraitConst for SVD

fn as_raw_SVD(&self) -> *const c_void

fn u(&self) -> Mat

fn w(&self) -> Mat

fn vt(&self) -> Mat

fn back_subst( &self, rhs: &impl ToInputArray, dst: &mut impl ToOutputArray, ) -> Result<()>

performs a singular value back substitution.

impl Send for SVD