NAG CL Interface
f08bhc (dtzrzf)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{order}$ – Nag_OrderType Input

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 $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.

Constraint: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

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

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

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

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

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

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

4: $\mathbf{a}\left[\mathit{dim}\right]$ – double Input/Output

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

• $\max (1,\mathbf{pda}\times \mathbf{n})$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\max (1,\mathbf{m}\times \mathbf{pda})$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

The $(i,j)$th element of the matrix $A$ is stored in

• $\mathbf{a}\left[(j-1)\times \mathbf{pda}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{a}\left[(i-1)\times \mathbf{pda}+j-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On entry: the leading $m\times n$ upper trapezoidal part of the array a must contain the matrix to be factorized.

On exit: the leading $m\times m$ upper triangular part of a contains the upper triangular matrix $R$, and elements $\mathbf{m}+1$ to n of the first $m$ rows of a, with the array tau, represent the orthogonal matrix $Z$ as a product of $m$ elementary reflectors (see Section 3.4.6 in the F08 Chapter Introduction).

5: $\mathbf{pda}$ – Integer Input

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

Constraints:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $\mathbf{pda}\ge \max (1,\mathbf{m})$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $\mathbf{pda}\ge \max (1,\mathbf{n})$.

6: $\mathbf{tau}\left[\mathit{dim}\right]$ – double Output

Note: the dimension, dim, of the array tau must be at least $\max (1,\mathbf{m})$.

On exit: the scalar factors of the elementary reflectors.

7: $\mathbf{fail}$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.

NE_BAD_PARAM

On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_INT

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

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

NE_INT_2

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

On entry, $\mathbf{pda}=⟨\mathit{\text{value}}⟩$ and $\mathbf{m}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pda}\ge \max (1,\mathbf{m})$.

On entry, $\mathbf{pda}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pda}\ge \max (1,\mathbf{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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL 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