NAG Library Function Document

nag_dtbmv (f16pgc)

1  Purpose

2  Specification

3  Description

4  References

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

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

2:     uplo – Nag_UploTypeInput

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:     trans – Nag_TransTypeInput

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:     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:     n – IntegerInput

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

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

6:     k – IntegerInput

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

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

7:     alpha – doubleInput

On entry: the scalar $\alpha$.

8:     ab[$\mathit{dim}$] – const doubleInput

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

On entry: the $n$ by $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+\left(j-1\right)\times \mathbf{pdab}\right]$, for $j=1,\dots ,n$ and $i=\max \left(1,j-k\right),\dots ,j$;
• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ab}\left[i-j+\left(j-1\right)\times \mathbf{pdab}\right]$, for $j=1,\dots ,n$ and $i=j,\dots ,\min \left(n,j+k\right)$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ab}\left[j-i+\left(i-1\right)\times \mathbf{pdab}\right]$, for $i=1,\dots ,n$ and $j=i,\dots ,\min \left(n,i+k\right)$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ab}\left[k+j-i+\left(i-1\right)\times \mathbf{pdab}\right]$, for $i=1,\dots ,n$ and $j=\max \left(1,i-k\right),\dots ,i$.

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

9:     pdab – IntegerInput

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:   x[$\mathit{dim}$] – doubleInput/Output

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

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

On exit: the solution vector $x$.

11:   incx – IntegerInput

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

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

12:   fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

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

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (f16pgce.c)

9.2  Program Data

Program Data (f16pgce.d)

9.3  Program Results

Program Results (f16pgce.r)