NAG Library Function Document

nag_dpoequ (f07ffc)

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 $\mathrm{Nag\_ColMajor}$.

2:     n – IntegerInput

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

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

3:     a[$\mathit{dim}$] – const doubleInput

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

The $\left(i,j\right)$th element of the matrix $A$ is stored in

• $\mathbf{a}\left[\left(j-1\right)\times \mathbf{pda}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{a}\left[\left(i-1\right)\times \mathbf{pda}+j-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On entry: the matrix $A$ whose scaling factors are to be computed. Only the diagonal elements of the array a are referenced.

4:     pda – IntegerInput

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

Constraint: $\mathbf{pda}\ge \max \left(1,\mathbf{n}\right)$.

5:     s[n] – doubleOutput

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, s contains the diagonal elements of the scaling matrix $S$.

6:     scond – double *Output

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, scond contains the ratio of the smallest value of s to the largest value of s. If $\mathbf{scond}\ge 0.1$ and amax is neither too large nor too small, it is not worth scaling by $S$.

7:     amax – double *Output

On exit: $\max \left|a_{ij}\right|$. If amax is very close to overflow or underflow, the matrix $A$ should be scaled.

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

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

NE_INT_2

On entry, $\mathbf{pda}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pda}\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.

NE_MAT_NOT_POS_DEF

The $⟨\mathit{\text{value}}⟩$th diagonal element of $A$ is not positive (and hence $A$ cannot be positive definite).

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f07ffce.c)

10.2  Program Data

Program Data (f07ffce.d)

10.3  Program Results

Program Results (f07ffce.r)