NAG FL Interface
f02wgf (real_​gen_​partialsvd)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{m}$ – Integer Input

On entry: $m$, the number of rows of the matrix $A$.

Constraint: $\mathbf{m}\ge 0$.

If $\mathbf{m}=0$, an immediate return is effected.

2: $\mathbf{n}$ – Integer Input

On entry: $n$, the number of columns of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

If $\mathbf{n}=0$, an immediate return is effected.

3: $\mathbf{k}$ – Integer Input

On entry: $k$, the number of singular values to be computed.

Constraint: $0<\mathbf{k}<\min (\mathbf{m},\mathbf{n})-1$.

4: $\mathbf{ncv}$ – Integer Input

On entry: the dimension of the arrays sigma and resid and the second dimension of the arrays u and v as declared in the (sub)program from which f02wgf is called. This is the number of Lanczos basis vectors to use during the computation of the largest eigenvalues of $A^{\mathrm{T}}A$ ($m\ge n$) or $A{A}^{\mathrm{T}}$ ($m<n$).

At present there is no a priori analysis to guide the selection of ncv relative to k. However, it is recommended that $\mathbf{ncv}\ge 2\times \mathbf{k}+1$. If many problems of the same type are to be solved, you should experiment with varying ncv while keeping k fixed for a given test problem. This will usually decrease the required number of matrix-vector operations but it also increases the internal storage required to maintain the orthogonal basis vectors. The optimal ‘cross-over’ with respect to CPU time is problem dependent and must be determined empirically.

Constraint: $\mathbf{k}<\mathbf{ncv}\le \min (\mathbf{m},\mathbf{n})$.

5: $\mathbf{av}$ – Subroutine, supplied by the user. External Procedure

av must return the vector result of the matrix-vector product $Ax$ or $A^{\mathrm{T}}x$, as indicated by the input value of iflag, for the given vector $x$.

av is called from f02wgf with the argument iuser and ruser as supplied to f02wgf. You are free to use these arrays to supply information to av.

The specification of av is:

Fortran Interface copy

Subroutine av ( iflag, m, n, x, ax, iuser, ruser) Integer, Intent (In) :: m, n Integer, Intent (Inout) :: iflag, iuser(*) Real (Kind=nag_wp), Intent (In) :: x(*) Real (Kind=nag_wp), Intent (Inout) :: ax(*), ruser(*)

C Header Interface copy

void  av (Integer *iflag, const Integer *m, const Integer *n, const double x[], double ax[], Integer iuser[], double ruser[])

C++ Header Interface copy

#include <nag.h> extern "C" { void  av (Integer &iflag, const Integer &m, const Integer &n, const double x[], double ax[], Integer iuser[], double ruser[]) }

1: $\mathbf{iflag}$ – Integer Input/Output

On entry: if $\mathbf{iflag}=1$, ax must return the $m$-vector result of the matrix-vector product $Ax$.

If $\mathbf{iflag}=2$, ax must return the $n$-vector result of the matrix-vector product $A^{\mathrm{T}}x$.

On exit: may be used as a flag to indicate a failure in the computation of $Ax$ or $A^{\mathrm{T}}x$. If iflag is negative on exit from av, f02wgf will exit immediately with ifail set to iflag.

2: $\mathbf{m}$ – Integer Input

On entry: the number of rows of the matrix $A$.

3: $\mathbf{n}$ – Integer Input

On entry: the number of columns of the matrix $A$.

4: $\mathbf{x}\left(*\right)$ – Real (Kind=nag_wp) array Input

On entry: the vector to be pre-multiplied by the matrix $A$ or $A^{\mathrm{T}}$.

5: $\mathbf{ax}\left(*\right)$ – Real (Kind=nag_wp) array Output

On exit: if $\mathbf{iflag}=1$, contains the $m$-vector result of the matrix-vector product $Ax$.

If $\mathbf{iflag}=2$, contains the $n$-vector result of the matrix-vector product $A^{\mathrm{T}}x$.

6: $\mathbf{iuser}\left(*\right)$ – Integer array User Workspace

7: $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array User Workspace

av is called with the arguments iuser and ruser as supplied to f02wgf. You should use the arrays iuser and ruser to supply information to av.

av must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which f02wgf is called. Arguments denoted as Input must not be changed by this procedure.

Note: av should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by f02wgf. If your code inadvertently does return any NaNs or infinities, f02wgf is likely to produce unexpected results.

6: $\mathbf{nconv}$ – Integer Output

On exit: the number of converged singular values found.

7: $\mathbf{sigma}\left(\mathbf{ncv}\right)$ – Real (Kind=nag_wp) array Output

On exit: the nconv converged singular values are stored in the first nconv elements of sigma.

8: $\mathbf{u}(\mathbf{ldu},\mathbf{ncv})$ – Real (Kind=nag_wp) array Output

On exit: the left singular vectors corresponding to the singular values stored in sigma.

The $\mathit{i}$th element of the $\mathit{j}$th left singular vector $u_{\mathit{j}}$ is stored in $\mathbf{u}(\mathit{i},\mathit{j})$, for $\mathit{i}=1,2,\dots ,m$ and $\mathit{j}=1,2,\dots ,\mathbf{nconv}$.

9: $\mathbf{ldu}$ – Integer Input

On entry: the first dimension of the array u as declared in the (sub)program from which f02wgf is called.

Constraint: $\mathbf{ldu}\ge \max (1,\mathbf{m})$.

10: $\mathbf{v}(\mathbf{ldv},\mathbf{ncv})$ – Real (Kind=nag_wp) array Output

On exit: the right singular vectors corresponding to the singular values stored in sigma.

The $\mathit{i}$th element of the $\mathit{j}$th right singular vector $v_{\mathit{j}}$ is stored in $\mathbf{v}(\mathit{i},\mathit{j})$, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,\mathbf{nconv}$.

11: $\mathbf{ldv}$ – Integer Input

On entry: the first dimension of the array v as declared in the (sub)program from which f02wgf is called.

Constraint: $\mathbf{ldv}\ge \max (1,\mathbf{n})$.

12: $\mathbf{resid}\left(\mathbf{ncv}\right)$ – Real (Kind=nag_wp) array Output

On exit: the residual $\Vert A{v}_j-{\sigma }_j{u}_j\Vert$, for $m\ge n$, or $\Vert A^{\mathrm{T}}{u}_j-{\sigma }_j{v}_j\Vert$, for $m<n$, for each of the converged singular values ${\sigma }_j$ and corresponding left and right singular vectors $u_j$ and $v_j$.

13: $\mathbf{iuser}\left(*\right)$ – Integer array User Workspace

14: $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array User Workspace

iuser and ruser are not used by f02wgf, but are passed directly to av and may be used to pass information to this routine.

15: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $\mathrm{-1}$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $\mathrm{-1}$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $\mathrm{-1}$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

f02wgf returns with $\mathbf{ifail}=\mathbf{0}$ if at least $k$ singular values have converged and the corresponding left and right singular vectors have been computed.

6 Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry, $\mathbf{m}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{m}\ge 0$.

$\mathbf{ifail}=2$

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 0$.

$\mathbf{ifail}=3$

On entry, $\mathbf{k}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{k}>0$.

$\mathbf{ifail}=4$

On entry, $\mathbf{k}=⟨\mathit{\text{value}}⟩$, $\mathbf{ncv}=⟨\mathit{\text{value}}⟩$, $\mathbf{m}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{k}<\mathbf{ncv}\le \min (\mathbf{m},\mathbf{n})$.

$\mathbf{ifail}=5$

On entry, $\mathbf{ldu}=⟨\mathit{\text{value}}⟩$ and $\mathbf{m}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{ldu}\ge \mathbf{m}$.

$\mathbf{ifail}=6$

On entry, $\mathbf{ldv}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{ldv}\ge \mathbf{n}$.

$\mathbf{ifail}=8$

The maximum number of iterations has been reached. The maximum number of iterations $=⟨\mathit{\text{value}}⟩$. The number of converged eigenvalues $=⟨\mathit{\text{value}}⟩$.

$\mathbf{ifail}=9$

No shifts could be applied during a cycle of the implicitly restarted Lanczos iteration.

$\mathbf{ifail}=10$

Could not build a full Lanczos factorization.

$\mathbf{ifail}=11$

The number of eigenvalues found to sufficient accuracy is zero.

$\mathbf{ifail}=20$

An error occurred during an internal call. Consider increasing the size of ncv relative to k.

$\mathbf{ifail}<0$

On output from user-defined routine av, iflag was set to a negative value, $\mathbf{iflag}=⟨\mathit{\text{value}}⟩$.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results