Purpose
=======
DGELSD computes the minimum-norm solution to a real linear least
squares problem:
minimize 2-norm(| b - A*x |)
using the singular value decomposition (SVD) of A. A is an M-by-N
matrix which may be rank-deficient.
Several right hand side vectors b and solution vectors x can be
handled in a single call; they are stored as the columns of the
M-by-NRHS right hand side matrix B and the N-by-NRHS solution
matrix X.
The problem is solved in three steps:
(1) Reduce the coefficient matrix A to bidiagonal form with
Householder transformations, reducing the original problem
into a "bidiagonal least squares problem" (BLS)
(2) Solve the BLS using a divide and conquer approach.
(3) Apply back all the Householder tranformations to solve
the original least squares problem.
The effective rank of A is determined by treating as zero those
singular values which are less than RCOND times the largest singular
value.
The divide and conquer algorithm makes very mild assumptions about
floating point arithmetic. It will work on machines with a guard
digit in add/subtract, or on those binary machines without guard
digits which subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or
Cray-2. It could conceivably fail on hexadecimal or decimal machines
without guard digits, but we know of none.
Namespace: DotNumerics.LinearAlgebra.CSLapackAssembly: DWSIM.MathOps.DotNumerics (in DWSIM.MathOps.DotNumerics.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax public void Run(
int M,
int N,
int NRHS,
ref double[] A,
int offset_a,
int LDA,
ref double[] B,
int offset_b,
int LDB,
ref double[] S,
int offset_s,
double RCOND,
ref int RANK,
ref double[] WORK,
int offset_work,
int LWORK,
ref int[] IWORK,
int offset_iwork,
ref int INFO
)
Public Sub Run (
M As Integer,
N As Integer,
NRHS As Integer,
ByRef A As Double(),
offset_a As Integer,
LDA As Integer,
ByRef B As Double(),
offset_b As Integer,
LDB As Integer,
ByRef S As Double(),
offset_s As Integer,
RCOND As Double,
ByRef RANK As Integer,
ByRef WORK As Double(),
offset_work As Integer,
LWORK As Integer,
ByRef IWORK As Integer(),
offset_iwork As Integer,
ByRef INFO As Integer
)
Request Example
View SourceParameters
- M Int32
-
(input) INTEGER
The number of rows of A. M .GE. 0.
- N Int32
-
(input) INTEGER
The number of columns of A. N .GE. 0.
- NRHS Int32
-
(input) INTEGER
The number of right hand sides, i.e., the number of columns
of the matrices B and X. NRHS .GE. 0.
- A Double
-
(input) DOUBLE PRECISION array, dimension (LDA,N)
On entry, the M-by-N matrix A.
On exit, A has been destroyed.
- offset_a Int32
-
- LDA Int32
-
(input) INTEGER
The leading dimension of the array A. LDA .GE. max(1,M).
- B Double
-
(input/output) DOUBLE PRECISION array, dimension (LDB,NRHS)
On entry, the M-by-NRHS right hand side matrix B.
On exit, B is overwritten by the N-by-NRHS solution
matrix X. If m .GE. n and RANK = n, the residual
sum-of-squares for the solution in the i-th column is given
by the sum of squares of elements n+1:m in that column.
- offset_b Int32
-
- LDB Int32
-
(input) INTEGER
The leading dimension of the array B. LDB .GE. max(1,max(M,N)).
- S Double
-
(output) DOUBLE PRECISION array, dimension (min(M,N))
The singular values of A in decreasing order.
The condition number of A in the 2-norm = S(1)/S(min(m,n)).
- offset_s Int32
-
- RCOND Double
-
(input) DOUBLE PRECISION
RCOND is used to determine the effective rank of A.
Singular values S(i) .LE. RCOND*S(1) are treated as zero.
If RCOND .LT. 0, machine precision is used instead.
- RANK Int32
-
(output) INTEGER
The effective rank of A, i.e., the number of singular values
which are greater than RCOND*S(1).
- WORK Double
-
(workspace/output) DOUBLE PRECISION array, dimension (MAX(1,LWORK))
On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
- offset_work Int32
-
- LWORK Int32
-
(input) INTEGER
The dimension of the array WORK. LWORK must be at least 1.
The exact minimum amount of workspace needed depends on M,
N and NRHS. As long as LWORK is at least
12*N + 2*N*SMLSIZ + 8*N*NLVL + N*NRHS + (SMLSIZ+1)**2,
if M is greater than or equal to N or
12*M + 2*M*SMLSIZ + 8*M*NLVL + M*NRHS + (SMLSIZ+1)**2,
if M is less than N, the code will execute correctly.
SMLSIZ is returned by ILAENV and is equal to the maximum
size of the subproblems at the bottom of the computation
tree (usually about 25), and
NLVL = MAX( 0, INT( LOG_2( MIN( M,N )/(SMLSIZ+1) ) ) + 1 )
For good performance, LWORK should generally be larger.
If LWORK = -1, then a workspace query is assumed; the routine
only calculates the optimal size of the WORK array, returns
this value as the first entry of the WORK array, and no error
message related to LWORK is issued by XERBLA.
- IWORK Int32
-
(workspace) INTEGER array, dimension (MAX(1,LIWORK))
LIWORK .GE. 3 * MINMN * NLVL + 11 * MINMN,
where MINMN = MIN( M,N ).
- offset_iwork Int32
-
- INFO Int32
-
(output) INTEGER
= 0: successful exit
.LT. 0: if INFO = -i, the i-th argument had an illegal value.
.GT. 0: the algorithm for computing the SVD failed to converge;
if INFO = i, i off-diagonal elements of an intermediate
bidiagonal form did not converge to zero.
See Also