SparseMatrix<T>.GetSingularValueDecomposition Method

Definition

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

GetSingularValueDecomposition() Returns the singular value decomposition of the matrix.
GetSingularValueDecomposition(Matrix<T>) Returns the generalized singular value decomposition of the matrix and another matrix.
GetSingularValueDecomposition(SingularValueDecompositionFactors) Returns the singular value decomposition of the matrix.
GetSingularValueDecomposition(Matrix<T>, GeneralizedSingularValueDecompositionFactors) Returns the generalized singular value decomposition of the matrix and another matrix.
GetSingularValueDecomposition(SingularValueDecompositionFactors, Boolean) Returns the singular value decomposition of the matrix.
GetSingularValueDecomposition(Matrix<T>, GeneralizedSingularValueDecompositionFactors, Boolean) Returns the generalized singular value decomposition of the matrix and another matrix.
GetSingularValueDecomposition(SingularValueDecompositionFactors, Int32, Double, Int32, Int32, Int32, Double, Double) Returns the singular value decomposition of the matrix.

GetSingularValueDecomposition(SingularValueDecompositionFactors, Boolean)

Returns the singular value decomposition of the matrix.
C#
public override SingularValueDecomposition<T> GetSingularValueDecomposition(
	SingularValueDecompositionFactors requestedFactors,
	bool overwriteMatrix
)

Parameters

requestedFactors  SingularValueDecompositionFactors
A SingularValueDecompositionFactors value that specifies which factors of the decomposition should be computed.
overwriteMatrix  Boolean
A boolean value that indicates whether the contents of the matrix may be overwritten by the decomposition.

Return Value

SingularValueDecomposition<T>
An SingularValueDecomposition<T> object that represents the singular value decomposition of the matrix.

GetSingularValueDecomposition(SingularValueDecompositionFactors, Int32, Double, Int32, Int32, Int32, Double, Double)

Returns the singular value decomposition of the matrix.
C#
public SingularValueDecomposition<T> GetSingularValueDecomposition(
	SingularValueDecompositionFactors requestedFactors,
	int maxSingularValues,
	double tolerance = 3.5527136788005E-15,
	int maxDimension = -1,
	int shiftsPerRestart = -1,
	int maxIterations = 1000,
	double orthogonalityTolerance = 1E-12,
	double minRelativeGap = 0.002
)

Parameters

requestedFactors  SingularValueDecompositionFactors
A SingularValueDecompositionFactors value that specifies which factors of the decomposition should be computed.
maxSingularValues  Int32
Specifies the maximum number of singular values that should be returned.
tolerance  Double  (Optional)
The desired relative accuracy of the singular values.
maxDimension  Int32  (Optional)
Specifies the maximum dimension of the Krylov subspace.
shiftsPerRestart  Int32  (Optional)
Specifies the number of shifts per restart.
maxIterations  Int32  (Optional)
Maximum number of restarts.
orthogonalityTolerance  Double  (Optional)
Specifies the tolerance for determining the orthogonality of Lanczos vectors.
minRelativeGap  Double  (Optional)
Minimum relative gap between shifts and Ritz values.

Return Value

SingularValueDecomposition<T>
A SingularValueDecomposition<T> object that represents the singular value decomposition of the matrix.

See Also