NAG Library Function Document

nag_complex_gen_lin_solve (f04cac)

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 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:    $\mathbf{n}$ – IntegerInput

On entry: the number of linear equations $n$, i.e., the order of the matrix $A$.

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

3:    $\mathbf{nrhs}$ – IntegerInput

On entry: the number of right-hand sides $r$, i.e., the number of columns of the matrix $B$.

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

4:    $\mathbf{a}\left[\mathit{dim}\right]$ – ComplexInput/Output

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 $n$ by $n$ coefficient matrix $A$.

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, the factors $L$ and $U$ from the factorization $A=PLU$. The unit diagonal elements of $L$ are not stored.

5:    $\mathbf{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)$.

6:    $\mathbf{ipiv}\left[\mathbf{n}\right]$ – IntegerOutput

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, the pivot indices that define the permutation matrix $P$; at the $i$th step row $i$ of the matrix was interchanged with row $\mathbf{ipiv}\left[i-1\right]$. $\mathbf{ipiv}\left[i-1\right]=i$ indicates a row interchange was not required.

7:    $\mathbf{b}\left[\mathit{dim}\right]$ – ComplexInput/Output

Note: the dimension, dim, of the array b must be at least

• $\max \left(1,\mathbf{pdb}\times \mathbf{nrhs}\right)$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\max \left(1,\mathbf{n}\times \mathbf{pdb}\right)$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

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

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

On entry: the $n$ by $r$ matrix of right-hand sides $B$.

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR or NE_RCOND, the $n$ by $r$ solution matrix $X$.

8:    $\mathbf{pdb}$ – IntegerInput

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

Constraints:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $\mathbf{pdb}\ge \max \left(1,\mathbf{n}\right)$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $\mathbf{pdb}\ge \max \left(1,\mathbf{nrhs}\right)$.

9:    $\mathbf{rcond}$ – double *Output

On exit: if no constraints are violated, an estimate of the reciprocal of the condition number of the matrix $A$, computed as $\mathbf{rcond}=1/\left({‖A‖}_1{‖A^{-1}‖}_1\right)$.

10:  $\mathbf{errbnd}$ – double *Output

On exit: if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR or NE_RCOND, an estimate of the forward error bound for a computed solution $\hat{x}$, such that ${‖\hat{x}-x‖}_1/{‖x‖}_1\le \mathbf{errbnd}$, where $\hat{x}$ is a column of the computed solution returned in the array b and $x$ is the corresponding column of the exact solution $X$. If rcond is less than machine precision, then errbnd is returned as unity.

11:  $\mathbf{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.
See Section 3.2.1.2 in the Essential Introduction for further information.

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{nrhs}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nrhs}\ge 0$.

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

On entry, $\mathbf{pdb}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pdb}>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)$.

On entry, $\mathbf{pdb}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pdb}\ge \max \left(1,\mathbf{n}\right)$.

On entry, $\mathbf{pdb}=〈\mathit{\text{value}}〉$ and $\mathbf{nrhs}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pdb}\ge \max \left(1,\mathbf{nrhs}\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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.

NE_RCOND

A solution has been computed, but rcond is less than machine precision so that the matrix $A$ is numerically singular.

NE_SINGULAR

Diagonal element $〈\mathit{\text{value}}〉$ of the upper triangular factor is zero. The factorization has been completed, but the solution could not be computed.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f04cace.c)

10.2  Program Data

Program Data (f04cace.d)

10.3  Program Results

Program Results (f04cace.r)