NAG CL Interface
f16pgc (dtbmv)

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{uplo}$ – Nag_UploType Input

On entry: specifies whether $A$ is upper or lower triangular.

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

$A$ is upper triangular.

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

$A$ is lower triangular.

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

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

On entry: specifies the operation to be performed.

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

$x\leftarrow \alpha Ax$.

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

$x\leftarrow \alpha A^{\mathrm{T}}x$.

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

4: $\mathbf{diag}$ – Nag_DiagType Input

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}$ – Integer Input

On entry: $n$, the order of the matrix $A$.

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

6: $\mathbf{k}$ – Integer Input

On entry: $k$, the number of subdiagonals or superdiagonals of the matrix $A$.

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

7: $\mathbf{alpha}$ – double Input

On entry: the scalar $\alpha$.

8: $\mathbf{ab}\left[\mathit{dim}\right]$ – const double Input

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

On entry: the $n\times n$ triangular band matrix $A$.

This is stored as a notional two-dimensional array with row elements or column elements stored contiguously. The storage of elements of $A_{ij}$, depends on the order and uplo arguments as follows:

if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,

$A_{ij}$ is stored in $\mathbf{ab}\left[k+i-j+(j-1)\times \mathbf{pdab}\right]$, for $j=1,\dots ,n$ and $i=\max (1,j-k),\dots ,j$;

if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,

$A_{ij}$ is stored in $\mathbf{ab}\left[i-j+(j-1)\times \mathbf{pdab}\right]$, for $j=1,\dots ,n$ and $i=j,\dots ,\min (n,j+k)$;

if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,

$A_{ij}$ is stored in $\mathbf{ab}\left[j-i+(i-1)\times \mathbf{pdab}\right]$, for $i=1,\dots ,n$ and $j=i,\dots ,\min (n,i+k)$;

if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,

$A_{ij}$ is stored in $\mathbf{ab}\left[k+j-i+(i-1)\times \mathbf{pdab}\right]$, for $i=1,\dots ,n$ and $j=\max (1,i-k),\dots ,i$.

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

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

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

Constraint: $\mathbf{pdab}\ge \mathbf{k}+1$.

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

Note: the dimension, dim, of the array x must be at least $\max (1,1+(\mathbf{n}-1)\left|\mathbf{incx}\right|)$.

On entry: the right-hand side vector $b$.

On exit: the solution vector $x$.

11: $\mathbf{incx}$ – Integer Input

On entry: the increment in the subscripts of x between successive elements of $x$.

Constraint: $\mathbf{incx}\ne 0$.

12: $\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{incx}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{incx}\ne 0$.

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

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

NE_INT_2

On entry, $\mathbf{pdab}=⟨\mathit{\text{value}}⟩$, $\mathbf{k}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdab}\ge \mathbf{k}+1$.

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