NAG Library Function Document

nag_zgesdd (f08krc)

void	nag_zgesdd (Nag_OrderType order, Nag_JobType job, Integer m, Integer n, Complex a[], Integer pda, double s[], Complex u[], Integer pdu, Complex vt[], Integer pdvt, NagError *fail)

3 Description

The SVD is written as

A = U Σ V^{H},

where

Σ

is an

m

n

matrix which is zero except for its

\min (m, n)

diagonal elements,

U

is an

m

m

unitary matrix, and

V

is an

n

n

unitary matrix. The diagonal elements of

Σ

are the singular values of

A

; they are real and non-negative, and are returned in descending order. The first

\min (m, n)

columns of

U

and

V

are the left and right singular vectors of

A

Note that the function returns

V^{H}

, not

V

4 References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia http://www.netlib.org/lapack/lug

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

1: $order$ – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by

order = Nag_RowMajor

. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.

Constraint:

order = Nag_RowMajor

Nag_ColMajor

2: $job$ – Nag_JobTypeInput

On entry: specifies options for computing all or part of the matrix

U

$job = Nag_DoAll$: All $m$ columns of $U$ and all $n$ rows of $V^{H}$ are returned in the arrays u and vt.
$job = Nag_DoSquare$: The first $\min (m, n)$ columns of $U$ and the first $\min (m, n)$ rows of $V^{H}$ are returned in the arrays u and vt.
$job = Nag_DoOverwrite$: If $m \geq n$ , the first $n$ columns of $U$ are overwritten on the array a and all rows of $V^{H}$ are returned in the array vt. Otherwise, all columns of $U$ are returned in the array u and the first $m$ rows of $V^{H}$ are overwritten in the array vt.
$job = Nag_DoNothing$: No columns of $U$ or rows of $V^{H}$ are computed.

Constraint:

job = Nag_DoAll

Nag_DoSquare

Nag_DoOverwrite

Nag_DoNothing

3: $m$ – IntegerInput

On entry:

m

, the number of rows of the matrix

A

Constraint:

m \geq 0

4: $n$ – IntegerInput

On entry:

n

, the number of columns of the matrix

A

Constraint:

n \geq 0

5: $a [\dim]$ – ComplexInput/Output

Note: the dimension, dim, of the array a must be at least

$\max (1, pda \times n)$ when $order = Nag_ColMajor$ ;
$\max (1, m \times pda)$ when $order = Nag_RowMajor$ .

The

(i, j)

th element of the matrix

A

is stored in

$a [(j - 1) \times pda + i - 1]$ when $order = Nag_ColMajor$ ;
$a [(i - 1) \times pda + j - 1]$ when $order = Nag_RowMajor$ .

On entry: the

m

n

matrix

A

On exit: if

job = Nag_DoOverwrite

, a is overwritten with the first

n

columns of

U

(the left singular vectors, stored column-wise) if

m \geq n

; a is overwritten with the first

m

rows of

V^{H}

(the right singular vectors, stored row-wise) otherwise.

job \neq Nag_DoOverwrite

, the contents of a are destroyed.

6: $pda$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array a.

Constraints:

if $order = Nag_ColMajor$ , $pda \geq \max (1, m)$ ;
if $order = Nag_RowMajor$ , $pda \geq \max (1, n)$ .

7: $s [\min (m, n)]$ – doubleOutput

On exit: the singular values of

A

, sorted so that

s [i - 1] \geq s [i]

8: $u [\dim]$ – ComplexOutput

Note: the dimension, dim, of the array u must be at least

$\max (1, pdu \times m)$ when $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m < n$ ;
$\max (1, pdu \times \min (m, n))$ when $job = Nag_DoSquare$ and $order = Nag_ColMajor$ ;
$\max (1, m \times pdu)$ when $job = Nag_DoSquare$ and $order = Nag_RowMajor$ ;
$\max (1, m)$ otherwise.

The

(i, j)

th element of the matrix

U

is stored in

$u [(j - 1) \times pdu + i - 1]$ when $order = Nag_ColMajor$ ;
$u [(i - 1) \times pdu + j - 1]$ when $order = Nag_RowMajor$ .

On exit:

job = Nag_DoAll

job = Nag_DoOverwrite

and

m < n

, u contains the

m

m

unitary matrix

U

job = Nag_DoSquare

, u contains the first

\min (m, n)

columns of

U

(the left singular vectors, stored column-wise).

job = Nag_DoOverwrite

and

m \geq n

, or

job = Nag_DoNothing

, u is not referenced.

9: $pdu$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array u.

Constraints:

if order=Nag_ColMajor,
- if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m < n$ , $pdu \geq \max (1, m)$ ;
- if $job = Nag_DoSquare$ , $pdu \geq \max (1, m)$ ;
- otherwise $pdu \geq 1$ ;
if order=Nag_RowMajor,
- if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m < n$ , $pdu \geq \max (1, m)$ ;
- if $job = Nag_DoSquare$ , $pdu \geq \max (1, \min (m, n))$ ;
- otherwise $pdu \geq 1$ .

10: $vt [\dim]$ – ComplexOutput

Note: the dimension, dim, of the array vt must be at least

$\max (1, pdvt \times n)$ when $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m \geq n$ ;
$\max (1, pdvt \times n)$ when $job = Nag_DoSquare$ and $order = Nag_ColMajor$ ;
$\max (1, \min (m, n) \times pdvt)$ when $job = Nag_DoSquare$ and $order = Nag_RowMajor$ ;
$\max (1, \min (m, n))$ otherwise.

The

(i, j)

th element of the matrix is stored in

$vt [(j - 1) \times pdvt + i - 1]$ when $order = Nag_ColMajor$ ;
$vt [(i - 1) \times pdvt + j - 1]$ when $order = Nag_RowMajor$ .

On exit: if

job = Nag_DoAll

job = Nag_DoOverwrite

and

m \geq n

, vt contains the

n

n

unitary matrix

V^{H}

job = Nag_DoSquare

, vt contains the first

\min (m, n)

rows of

V^{H}

(the right singular vectors, stored row-wise).

job = Nag_DoOverwrite

and

m < n

, or

job = Nag_DoNothing

, vt is not referenced.

11: $pdvt$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array vt.

Constraints:

if order=Nag_ColMajor,
- if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m \geq n$ , $pdvt \geq \max (1, n)$ ;
- if $job = Nag_DoSquare$ , $pdvt \geq \max (1, \min (m, n))$ ;
- otherwise $pdvt \geq 1$ ;
if order=Nag_RowMajor,
- if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m \geq n$ , $pdvt \geq \max (1, n)$ ;
- if $job = Nag_DoSquare$ , $pdvt \geq \max (1, n)$ ;
- otherwise $pdvt \geq 1$ .

12: $fail$ – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.
NE_BAD_PARAM: On entry, argument $〈value〉$ had an illegal value.
NE_CONVERGENCE: nag_zgesdd (f08krc) did not converge, the updating process failed.
NE_ENUM_INT_3: On entry, $job = 〈value〉$ , $pdu = 〈value〉$ , $m = 〈value〉$ and $n = 〈value〉$ .
Constraint: if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m < n$ , $pdu \geq \max (1, m)$ ;
if $job = Nag_DoSquare$ , $pdu \geq \max (1, m)$ ;
otherwise $pdu \geq 1$ .

On entry, $job = 〈value〉$ , $pdu = 〈value〉$ , $m = 〈value〉$ and $n = 〈value〉$ .
Constraint: if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m < n$ , $pdu \geq \max (1, m)$ ;
if $job = Nag_DoSquare$ , $pdu \geq \max (1, \min (m, n))$ ;
otherwise $pdu \geq 1$ .

On entry, $job = 〈value〉$ , $pdvt = 〈value〉$ , $m = 〈value〉$ and $n = 〈value〉$ .
Constraint: if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m \geq n$ , $pdvt \geq \max (1, n)$ ;
if $job = Nag_DoSquare$ , $pdvt \geq \max (1, \min (m, n))$ ;
otherwise $pdvt \geq 1$ .

On entry, $job = 〈value〉$ , $pdvt = 〈value〉$ , $m = 〈value〉$ and $n = 〈value〉$ .
Constraint: if $job = Nag_DoAll$ or $job = Nag_DoOverwrite$ and $m \geq n$ , $pdvt \geq \max (1, n)$ ;
if $job = Nag_DoSquare$ , $pdvt \geq \max (1, n)$ ;
otherwise $pdvt \geq 1$ .
NE_INT: On entry, $m = 〈value〉$ .
Constraint: $m \geq 0$ .

On entry, $n = 〈value〉$ .
Constraint: $n \geq 0$ .

On entry, $pda = 〈value〉$ .
Constraint: $pda > 0$ .

On entry, $pdu = 〈value〉$ .
Constraint: $pdu > 0$ .

On entry, $pdvt = 〈value〉$ .
Constraint: $pdvt > 0$ .
NE_INT_2: On entry, $pda = 〈value〉$ and $m = 〈value〉$ .
Constraint: $pda \geq \max (1, m)$ .

On entry, $pda = 〈value〉$ and $n = 〈value〉$ .
Constraint: $pda \geq \max (1, n)$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.

7 Accuracy

The computed singular value decomposition is nearly the exact singular value decomposition for a nearby matrix

(A + E)

, where

{‖E‖}_{2} = O (ε) {‖A‖}_{2},

and

ε

is the machine precision. In addition, the computed singular vectors are nearly orthogonal to working precision. See Section 4.9 of Anderson et al. (1999) for further details.

8 Parallelism and Performance

nag_zgesdd (f08krc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

nag_zgesdd (f08krc) makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The total number of floating-point operations is approximately proportional to

m n^{2}

when

m > n

and

m^{2} n

otherwise.

The singular values are returned in descending order.

The real analogue of this function is nag_dgesdd (f08kdc).

10 Example

This example finds the singular values and left and right singular vectors of the

4

6

matrix

A = (\begin{array}{r} 0.96 + 0.81 i & - 0.98 - 1.98 i & 0.62 + 0.46 i & - 0.37 - 0.38 i & 0.83 - 0.51 i & 1.08 + 0.28 i \\ - 0.03 - 0.96 i & - 1.20 - 0.19 i & 1.01 - 0.02 i & 0.19 + 0.54 i & 0.20 - 0.01 i & 0.20 + 0.12 i \\ - 0.91 - 2.06 i & - 0.66 - 0.42 i & 0.63 + 0.17 i & - 0.98 + 0.36 i & - 0.17 + 0.46 i & - 0.07 - 1.23 i \\ - 0.05 - 0.41 i & - 0.81 - 0.56 i & - 1.11 - 0.60 i & 0.22 + 0.20 i & 1.47 - 1.59 i & 0.26 - 0.26 i \end{array}),

together with approximate error bounds for the computed singular values and vectors.

The example program for nag_zgesvd (f08kpc) illustrates finding a singular value decomposition for the case

m \geq n

NAG Library Function Documentnag_zgesdd (f08krc)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG Library Function Document

nag_zgesdd (f08krc)