Integer, Intent (In)	::	m, n, lda, lwork
Integer, Intent (Out)	::	info
Real (Kind=nag_wp), Intent (Inout)	::	d(), e()
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,), tauq(), taup(*)
Complex (Kind=nag_wp), Intent (Out)	::	work(max(1,lwork))

C Header Interface

#include <nag.h>

void	f08ksf_ (const Integer m, const Integer n, Complex a[], const Integer lda, double d[], double e[], Complex tauq[], Complex taup[], Complex work[], const Integer lwork, Integer *info)

The routine may be called by the names f08ksf, nagf_lapackeig_zgebrd or its LAPACK name zgebrd.

3 Description

f08ksf reduces a complex

m \times n

matrix

A

to real bidiagonal form

B

by a unitary transformation:

A = Q B P^{H}

, where

Q

and

P^{H}

are unitary matrices of order

m

and

n

respectively.

m \geq n

, the reduction is given by:

A = Q (\begin{matrix} B_{1} \\ 0 \end{matrix}) P^{H} = Q_{1} B_{1} P^{H},

where

B_{1}

is a real

n \times n

upper bidiagonal matrix and

Q_{1}

consists of the first

n

columns of

Q

m < n

, the reduction is given by

A = Q (\begin{matrix} B_{1} & 0 \end{matrix}) P^{H} = Q B_{1} P_{1}^{H},

where

B_{1}

is a real

m \times m

lower bidiagonal matrix and

P_{1}^{H}

consists of the first

m

rows of

P^{H}

The unitary matrices

Q

and

P

are not formed explicitly but are represented as products of elementary reflectors (see the F08 Chapter Introduction for details). Routines are provided to work with

Q

and

P

in this representation (see Section 9).

4 References

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

5 Arguments

1: $m$ – Integer Input: On entry: $m$ , the number of rows of the matrix $A$ .

Constraint: $m \geq 0$ .
2: $n$ – Integer Input: On entry: $n$ , the number of columns of the matrix $A$ .

Constraint: $n \geq 0$ .
3: $a (lda, *)$ – Complex (Kind=nag_wp) array Input/Output: Note: the second dimension of the array a must be at least $\max (1, n)$ .

On entry: the $m \times n$ matrix $A$ .

On exit: if $m \geq n$ , the diagonal and first superdiagonal are overwritten by the upper bidiagonal matrix $B$ , elements below the diagonal are overwritten by details of the unitary matrix $Q$ and elements above the first superdiagonal are overwritten by details of the unitary matrix $P$ .
If $m < n$ , the diagonal and first subdiagonal are overwritten by the lower bidiagonal matrix $B$ , elements below the first subdiagonal are overwritten by details of the unitary matrix $Q$ and elements above the diagonal are overwritten by details of the unitary matrix $P$ .
4: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f08ksf is called.

Constraint: $lda \geq \max (1, m)$ .
5: $d (*)$ – Real (Kind=nag_wp) array Output: Note: the dimension of the array d must be at least $\max (1, \min (m, n))$ .

On exit: the diagonal elements of the bidiagonal matrix $B$ .
6: $e (*)$ – Real (Kind=nag_wp) array Output: Note: the dimension of the array e must be at least $\max (1, \min (m, n) - 1)$ .

On exit: the off-diagonal elements of the bidiagonal matrix $B$ .
7: $tauq (*)$ – Complex (Kind=nag_wp) array Output: Note: the dimension of the array tauq must be at least $\max (1, \min (m, n))$ .

On exit: further details of the unitary matrix $Q$ .
8: $taup (*)$ – Complex (Kind=nag_wp) array Output: Note: the dimension of the array taup must be at least $\max (1, \min (m, n))$ .

On exit: further details of the unitary matrix $P$ .
9: $work (\max (1, lwork))$ – Complex (Kind=nag_wp) array Workspace: On exit: if $info = 0$ , the real part of $work (1)$ contains the minimum value of lwork required for optimal performance.
10: $lwork$ – Integer Input: On entry: the dimension of the array work as declared in the (sub)program from which f08ksf is called.
If $lwork = −1$ , 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.

Suggested value: for optimal performance, $lwork \geq (m + n) \times nb$ , where $nb$ is the optimal block size.

Constraint: $lwork \geq \max (1, m, n)$ or $lwork = −1$ .
11: $info$ – Integer Output: On exit: $info = 0$ unless the routine detects an error (see Section 6).

6 Error Indicators and Warnings

$info < 0$: If $info = - i$ , argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

7 Accuracy

The computed bidiagonal form

B

satisfies

Q B P^{H} = A + E

, where

{‖ E ‖}_{2} \leq c (n) ε {‖ A ‖}_{2},

c (n)

is a modestly increasing function of

n

, and

ε

is the machine precision.

The elements of

B

themselves may be sensitive to small perturbations in

A

or to rounding errors in the computation, but this does not affect the stability of the singular values and vectors.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

f08ksf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f08ksf 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 routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The total number of real floating-point operations is approximately

16 n^{2} (3 m - n) / 3

m \geq n

16 m^{2} (3 n - m) / 3

m < n

m ≫ n

, it can be more efficient to first call f08asf to perform a

Q R

factorization of

A

, and then to call f08ksf to reduce the factor

R

to bidiagonal form. This requires approximately

8 n^{2} (m + n)

floating-point operations.

m ≪ n

, it can be more efficient to first call f08avf to perform an

L Q

factorization of

A

, and then to call f08ksf to reduce the factor

L

to bidiagonal form. This requires approximately

8 m^{2} (m + n)

operations.

To form the

m \times m

unitary matrix

Q

f08ksf may be followed by calls to f08ktf . For example

Call zungbr('Q',m,m,n,a,lda,tauq,work,lwork,info)

but note that the second dimension of the array a must be at least m, which may be larger than was required by f08ksf.

To form the

n \times n

unitary matrix

P^{H}

another call to f08kff may be made . For example

Call zungbr('P',n,n,m,a,lda,taup,work,lwork,info)

but note that the first dimension of the array a must be at least n, which may be larger than was required by f08ksf.

To apply

Q

P

to a complex rectangular matrix

C

, f08ksf may be followed by a call to f08kuf.

The real analogue of this routine is f08kef.

10 Example

This example reduces the matrix

A

to bidiagonal form, where

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

f08ks: FL CL CPP AD PY MB

NAG FL Interfacef08ksf (zgebrd)

▸▿ 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 FL Interface
f08ksf (zgebrd)