NAG Library Function Document

nag_zgebrd (f08ksc)

void	nag_zgebrd (Nag_OrderType order, Integer m, Integer n, Complex a[], Integer pda, double d[], double e[], Complex tauq[], Complex taup[], NagError *fail)

3 Description

nag_zgebrd (f08ksc) reduces a complex

m

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

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

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). Functions 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: $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: $m$ – IntegerInput

On entry:

m

, the number of rows of the matrix

A

Constraint:

m \geq 0

3: $n$ – IntegerInput

On entry:

n

, the number of columns of the matrix

A

Constraint:

n \geq 0

4: $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

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

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

5: $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)$ .

6: $d [\dim]$ – doubleOutput

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

\max (1, \min (m, n))

On exit: the diagonal elements of the bidiagonal matrix

B

7: $e [\dim]$ – doubleOutput

Note: the dimension, dim, 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

8: $tauq [\dim]$ – ComplexOutput

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

\max (1, \min (m, n))

On exit: further details of the unitary matrix

Q

9: $taup [\dim]$ – ComplexOutput

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

\max (1, \min (m, n))

On exit: further details of the unitary matrix

P

10: $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_INT: On entry, $m = 〈value〉$ .
Constraint: $m \geq 0$ .

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

On entry, $pda = 〈value〉$ .
Constraint: $pda > 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 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

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

nag_zgebrd (f08ksc) 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 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 nag_zgeqrf (f08asc) to perform a

Q R

factorization of

A

, and then to call nag_zgebrd (f08ksc) 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 nag_zgelqf (f08avc) to perform an

L Q

factorization of

A

, and then to call nag_zgebrd (f08ksc) to reduce the factor

L

to bidiagonal form. This requires approximately

8 m^{2} (m + n)

operations.

To form the unitary matrices

P^{H}

and/or

Q

nag_zgebrd (f08ksc) may be followed by calls to nag_zungbr (f08ktc):

to form the

m

m

unitary matrix

Q

nag_zungbr(order,Nag_FormQ,m,m,n,&a,pda,tauq,&fail)

but note that the second dimension of the array a must be at least m, which may be larger than was required by nag_zgebrd (f08ksc);

to form the

n

n

unitary matrix

P^{H}

nag_zungbr(order,Nag_FormP,n,n,m,&a,pda,taup,&fail)

but note that the first dimension of the array a, specified by the argument pda, must be at least n, which may be larger than was required by nag_zgebrd (f08ksc).

To apply

Q

P

to a complex rectangular matrix

C

, nag_zgebrd (f08ksc) may be followed by a call to nag_zunmbr (f08kuc).

The real analogue of this function is nag_dgebrd (f08kec).

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}) .

NAG Library Function Documentnag_zgebrd (f08ksc)

▸▿ 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_zgebrd (f08ksc)