NAG Library Function Document

nag_dsptri (f07pjc)

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 how $A$ has been factorized.

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

$A=PUD{U}^{\mathrm{T}}{P}^{\mathrm{T}}$, where $U$ is upper triangular.

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

$A=PLD{L}^{\mathrm{T}}{P}^{\mathrm{T}}$, where $L$ is lower triangular.

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

3:     n – IntegerInput

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

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

4:     ap[$\mathit{dim}$] – doubleInput/Output

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 factorization of $A$ stored in packed form, as returned by nag_dsptrf (f07pdc).

On exit: the factorization is overwritten by the $n$ by $n$ matrix $A^{-1}$.

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

5:     ipiv[$\mathit{dim}$] – const IntegerInput

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

On entry: details of the interchanges and the block structure of $D$, as returned by nag_dsptrf (f07pdc).

6:     fail – NagError *Input/Output

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

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.

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

NE_SINGULAR

$d\left(〈\mathit{\text{value}}〉,〈\mathit{\text{value}}〉\right)$ is exactly zero. $D$ is singular and the inverse of $A$ cannot be computed.

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (f07pjce.c)

9.2  Program Data

Program Data (f07pjce.d)

9.3  Program Results

Program Results (f07pjce.r)