Integer, Intent (In)	::	m, n, ncc, kl, ku, ldab, ldq, ldpt, ldc
Integer, Intent (Out)	::	info
Real (Kind=nag_wp), Intent (Out)	::	d(min(m,n)), e(min(m,n)-1), rwork(max(m,n))
Complex (Kind=nag_wp), Intent (Inout)	::	ab(ldab,), q(ldq,), pt(ldpt,), c(ldc,)
Complex (Kind=nag_wp), Intent (Out)	::	work(max(m,n))
Character (1), Intent (In)	::	vect

C Header Interface

#include <nag.h>

void

f08lsf_ (const char *vect, const Integer *m, const Integer *n, const Integer *ncc, const Integer *kl, const Integer *ku, Complex ab[], const Integer *ldab, double d[], double e[], Complex q[], const Integer *ldq, Complex pt[], const Integer *ldpt, Complex c[], const Integer *ldc, Complex work[], double rwork[], Integer *info, const Charlen length_vect)

The routine may be called by the names f08lsf, nagf_lapackeig_zgbbrd or its LAPACK name zgbbrd.

3 Description

f08lsf reduces a complex

m \times n

band matrix to real upper bidiagonal form

B

by a unitary transformation:

A = Q B P^{H}

. The unitary matrices

Q

and

P^{H}

, of order

m

and

n

respectively, are determined as a product of Givens rotation matrices, and may be formed explicitly by the routine if required. A matrix

C

may also be updated to give

\tilde{C} = Q^{H} C

The routine uses a vectorizable form of the reduction.

4 References

None.

5 Arguments

1: $vect$ – Character(1) Input

On entry: indicates whether the matrices

Q

and/or

P^{H}

are generated.

$vect ='N'$: Neither $Q$ nor $P^{H}$ is generated.
$vect ='Q'$: $Q$ is generated.
$vect ='P'$: $P^{H}$ is generated.
$vect ='B'$: Both $Q$ and $P^{H}$ are generated.

Constraint:

vect ='N'

'Q'

'P'

'B'

2: $m$ – Integer Input

On entry:

m

, the number of rows of the matrix

A

Constraint:

m \geq 0

3: $n$ – Integer Input

On entry:

n

, the number of columns of the matrix

A

Constraint:

n \geq 0

4: $ncc$ – Integer Input

On entry:

n_{C}

, the number of columns of the matrix

C

Constraint:

ncc \geq 0

5: $kl$ – Integer Input

On entry: the number of subdiagonals,

k_{l}

, within the band of

A

Constraint:

kl \geq 0

6: $ku$ – Integer Input

On entry: the number of superdiagonals,

k_{u}

, within the band of

A

Constraint:

ku \geq 0

7: $ab (ldab, *)$ – Complex (Kind=nag_wp) array Input/Output

Note: the second dimension of the array ab must be at least

\max (1, n)

On entry: the original

m \times n

band matrix

A

The matrix is stored in rows

1

k_{l} + k_{u} + 1

, more precisely, the element

A_{i j}

must be stored in

ab (k_{u} + 1 + i - j, j) for ​ \max (1, j - k_{u}) \leq i \leq \min (m, j + k_{l}) .

On exit: ab is overwritten by values generated during the reduction.

8: $ldab$ – Integer Input

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

Constraint:

ldab \geq kl + ku + 1

9: $d (\min (m, n))$ – Real (Kind=nag_wp) array Output

On exit: the diagonal elements of the bidiagonal matrix

B

10: $e (\min (m, n) - 1)$ – Real (Kind=nag_wp) array Output

On exit: the superdiagonal elements of the bidiagonal matrix

B

11: $q (ldq, *)$ – Complex (Kind=nag_wp) array Output

Note: the second dimension of the array q must be at least

\max (1, m)

vect ='Q'

'B'

, and at least

1

otherwise.

On exit: if

vect ='Q'

'B'

, contains the

m \times m

unitary matrix

Q

vect ='N'

'P'

, q is not referenced.

12: $ldq$ – Integer Input

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

Constraints:

if $vect ='Q'$ or $'B'$ , $ldq \geq \max (1, m)$ ;
otherwise $ldq \geq 1$ .

13: $pt (ldpt, *)$ – Complex (Kind=nag_wp) array Output

Note: the second dimension of the array pt must be at least

\max (1, n)

vect ='P'

'B'

, and at least

1

otherwise.

On exit: the

n \times n

unitary matrix

P^{H}

, if

vect ='P'

'B'

. If

vect ='N'

'Q'

, pt is not referenced.

14: $ldpt$ – Integer Input

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

Constraints:

if $vect ='P'$ or $'B'$ , $ldpt \geq \max (1, n)$ ;
otherwise $ldpt \geq 1$ .

15: $c (ldc, *)$ – Complex (Kind=nag_wp) array Input/Output

Note: the second dimension of the array c must be at least

\max (1, ncc)

On entry: an

m \times n_{C}

matrix

C

On exit: c is overwritten by

Q^{H} C

. If

ncc = 0

, c is not referenced.

16: $ldc$ – Integer Input

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

Constraints:

if $ncc > 0$ , $ldc \geq \max (1, m)$ ;
if $ncc = 0$ , $ldc \geq 1$ .

17: $work (\max (m, n))$ – Complex (Kind=nag_wp) array Workspace

18: $rwork (\max (m, n))$ – Real (Kind=nag_wp) array Workspace

19: $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.

The computed matrix

Q

differs from an exactly unitary matrix by a matrix

F

such that

{‖ F ‖}_{2} = O (ε) .

A similar statement holds for the computed matrix

P^{H}

8 Parallelism and Performance

f08lsf 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 the sum of:

$20 n^{2} k$ , if $vect ='N'$ and $ncc = 0$ , and
$10 n^{2} n_{C} (k - 1) / k$ , if $C$ is updated, and
$10 n^{3} (k - 1) / k$ , if either $Q$ or $P^{H}$ is generated (double this if both),

where

k = k_{l} + k_{u}

, assuming

n ≫ k

. For this section we assume that

m = n

The real analogue of this routine is f08lef.

10 Example

This example reduces the matrix

A

to upper bidiagonal form, where

A = (\begin{array}{r} 0.96 - 0.81 i & - 0.03 + 0.96 i & 0.00 + 0.00 i & 0.00 + 0.00 i \\ - 0.98 + 1.98 i & - 1.20 + 0.19 i & - 0.66 + 0.42 i & 0.00 + 0.00 i \\ 0.62 - 0.46 i & 1.01 + 0.02 i & 0.63 - 0.17 i & - 1.11 + 0.60 i \\ 0.00 + 0.00 i & 0.19 - 0.54 i & - 0.98 - 0.36 i & 0.22 - 0.20 i \\ 0.00 + 0.00 i & 0.00 + 0.00 i & - 0.17 - 0.46 i & 1.47 + 1.59 i \\ 0.00 + 0.00 i & 0.00 + 0.00 i & 0.00 + 0.00 i & 0.26 + 0.26 i \end{array}) .

f08ls: FL CL CPP AD

NAG FL Interfacef08lsf (zgbbrd)

▸▿ 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
f08lsf (zgbbrd)