NAG Library Function Document

nag_dtpmv (f16phc)

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 2.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 $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_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:    $\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 matrix $A$.

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

6:    $\mathbf{alpha}$ – doubleInput

On entry: the scalar $\alpha$.

7:    $\mathbf{ap}\left[\mathit{dim}\right]$ – const doubleInput

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

On entry: the $n$ by $n$ triangular matrix $A$, packed by rows or columns.

The storage of elements $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{ap}\left[\left(j-1\right)\times j/2+i-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-j\right)\times \left(j-1\right)/2+i-1\right]$, for $i\ge j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-i\right)\times \left(i-1\right)/2+j-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(i-1\right)\times i/2+j-1\right]$, for $i\ge j$.

8:    $\mathbf{x}\left[\mathit{dim}\right]$ – 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$.

9:    $\mathbf{incx}$ – IntegerInput

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

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

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

The NAG error argument (see Section 2.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{incx}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{incx}\ne 0$.

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

NE_INTERNAL_ERROR

An unexpected error has been triggered by this function. Please contact NAG.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

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 (f16phce.c)

10.2  Program Data

Program Data (f16phce.d)

10.3  Program Results

Program Results (f16phce.r)