NAG Library Function Document

nag_ztr_copy (f16tec)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{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 $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.

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

2:    $\mathbf{uplo}$ – Nag_UploTypeInput

On entry: specifies whether the upper or lower triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Upper}$

The upper triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Lower}$

The lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\mathrm{Nag\_Upper}$ or $\mathrm{Nag\_Lower}$.

3:    $\mathbf{trans}$ – Nag_TransTypeInput

On entry: specifies the operation to be performed.

$\mathbf{trans}=\mathrm{Nag\_NoTrans}$

$B\leftarrow A$.

$\mathbf{trans}=\mathrm{Nag\_Trans}$

$B\leftarrow A^{\mathrm{T}}$.

$\mathbf{trans}=\mathrm{Nag\_ConjTrans}$

$B\leftarrow A^{\mathrm{H}}$.

Constraint: $\mathbf{trans}=\mathrm{Nag\_NoTrans}$, $\mathrm{Nag\_Trans}$ or $\mathrm{Nag\_ConjTrans}$.

4:    $\mathbf{diag}$ – Nag_DiagTypeInput

On entry: specifies whether $A$ has nonunit or unit diagonal elements.

$\mathbf{diag}=\mathrm{Nag\_NonUnitDiag}$

The diagonal elements are stored explicitly.

$\mathbf{diag}=\mathrm{Nag\_UnitDiag}$

The diagonal elements are assumed to be $1$ and are not referenced.

Constraint: $\mathbf{diag}=\mathrm{Nag\_NonUnitDiag}$ or $\mathrm{Nag\_UnitDiag}$.

5:    $\mathbf{n}$ – IntegerInput

On entry: $n$, the order of the matrices $A$ and $B$.

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

6:    $\mathbf{a}\left[\mathit{dim}\right]$ – const ComplexInput

Note: the dimension, dim, of the array a must be at least $\max \left(1,\mathbf{pda}\times \mathbf{n}\right)$.

On entry: the $n$ by $n$ triangular matrix $A$.

If $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $A_{ij}$ is stored in $\mathbf{a}\left[\left(j-1\right)\times \mathbf{pda}+i-1\right]$.

If $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $A_{ij}$ is stored in $\mathbf{a}\left[\left(i-1\right)\times \mathbf{pda}+j-1\right]$.

If $\mathbf{uplo}=\mathrm{Nag\_Upper}$, the upper triangular part of $A$ must be stored and the elements of the array below the diagonal are not referenced.

If $\mathbf{uplo}=\mathrm{Nag\_Lower}$, the lower triangular part of $A$ must be stored and the elements of the array above the diagonal are not referenced.

If $\mathbf{diag}=\mathrm{Nag\_UnitDiag}$, the diagonal elements of $A$ are assumed to be $1$, and are not referenced.

7:    $\mathbf{pda}$ – IntegerInput

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

Constraint: $\mathbf{pda}\ge \max \left(1,\mathbf{n}\right)$.

8:    $\mathbf{b}\left[\mathit{dim}\right]$ – ComplexOutput

Note: the dimension, dim, of the array b must be at least $\max \left(1,\mathbf{pdb}\times \mathbf{n}\right)$.

On exit: the $n$ by $n$ triangular matrix $B$.

If $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $B_{ij}$ is stored in $\mathbf{b}\left[\left(j-1\right)\times \mathbf{pdb}+i-1\right]$.

If $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $B_{ij}$ is stored in $\mathbf{b}\left[\left(i-1\right)\times \mathbf{pdb}+j-1\right]$.

If $\mathbf{uplo}=\mathrm{Nag\_Upper}$ and $\mathbf{trans}=\mathrm{Nag\_NoTrans}$ or if $\mathbf{uplo}=\mathrm{Nag\_Lower}$ and $\mathbf{trans}=\mathrm{Nag\_Trans}$ or $\mathbf{trans}=\mathrm{Nag\_ConjTrans}$, $B$ is upper triangular and the elements of the array below the diagonal are not set.

If $\mathbf{uplo}=\mathrm{Nag\_Lower}$ and $\mathbf{trans}=\mathrm{Nag\_NoTrans}$ or if $\mathbf{uplo}=\mathrm{Nag\_Upper}$ and $\mathbf{trans}=\mathrm{Nag\_Trans}$ or $\mathbf{trans}=\mathrm{Nag\_ConjTrans}$, $B$ is lower triangular and the elements of the array above the diagonal are not set.

9:    $\mathbf{pdb}$ – IntegerInput

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

Constraint: $\mathbf{pdb}\ge \max \left(1,\mathbf{n}\right)$.

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

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_INT

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

NE_INT_2

On entry, $\mathbf{pda}=〈\mathit{\text{value}}〉$, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pda}\ge \max \left(1,\mathbf{n}\right)$.

On entry, $\mathbf{pdb}=〈\mathit{\text{value}}〉$, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pdb}\ge \max \left(1,\mathbf{n}\right)$.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f16tece.c)

10.2

Program Data

Program Data (f16tece.d)

10.3

Program Results

Program Results (f16tece.r)