NAG CL Interface
f01duc (complex_​tri_​matmul_​inplace)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{side}$ – Nag_SideType Input

On entry: specifies whether $B$ is operated on from the left or the right.

$\mathbf{side}=\mathrm{Nag\_LeftSide}$

$B$ is pre-multiplied from the left.

$\mathbf{side}=\mathrm{Nag\_RightSide}$

$B$ is post-multiplied from the right.

Constraint: $\mathbf{side}=\mathrm{Nag\_LeftSide}$ or $\mathrm{Nag\_RightSide}$.

2: $\mathbf{uplo}$ – Nag_UploType Input

On entry: specifies whether $A$ and $B$ are upper or lower triangular.

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

$A$ and $B$ are upper triangular.

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

$A$ and $B$ are lower triangular.

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

3: $\mathbf{transa}$ – Nag_TransType Input

On entry: specifies whether the operation involves $A$, $A^{\mathrm{T}}$ or $A^{\mathrm{H}}$.

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

The operation involves $A$.

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

The operation involves $A^{\mathrm{T}}$.

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

The operation involves $A^{\mathrm{H}}$.

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

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

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

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

5: $\mathbf{alpha}$ – Complex Input

On entry: the scalar $\alpha$.

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

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

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

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

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

On entry: the stride separating row elements 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]$ – Complex Input/Output

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

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

$B_{ij}$ is stored in $\mathbf{b}\left[\left(i-1\right)\times \mathbf{pdb}+j-1\right]$.

If $\mathbf{uplo}=\mathrm{Nag\_Upper}$, the upper triangular part of $B$ 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 $B$ must be stored and the elements of the array above the diagonal are not referenced.

If $\mathbf{alpha}=0$, b need not be set.

On exit: $B$ is overwritten.

$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{transa}=\mathrm{Nag\_NoTrans}$, $B$ is upper triangular and the elements of the array below the diagonal are not set.

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

If $\mathbf{transa}=\mathrm{Nag\_Trans}$ or $\mathbf{transa}=\mathrm{Nag\_ConjTrans}$, $B$ is a general matrix.

9: $\mathbf{pdb}$ – Integer Input

On entry: the stride separating row elements of the matrix $B$ 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 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{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_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