F11MEF (PDF version)
F11 Chapter Contents
F11 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentF11MEF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

F11MEF computes the $LU$ factorization of a real sparse matrix in compressed column (Harwell–Boeing), column-permuted format.

## 2  Specification

 SUBROUTINE F11MEF ( N, IROWIX, A, IPRM, THRESH, NZLMX, NZLUMX, NZUMX, IL, LVAL, IU, UVAL, NNZL, NNZU, FLOP, IFAIL)
 INTEGER N, IROWIX(*), IPRM(7*N), NZLMX, NZLUMX, NZUMX, IL(7*N+NZLMX+4), IU(2*N+NZUMX+1), NNZL, NNZU, IFAIL REAL (KIND=nag_wp) A(*), THRESH, LVAL(NZLUMX), UVAL(NZUMX), FLOP

## 3  Description

Given a real sparse matrix $A$, F11MEF computes an $LU$ factorization of $A$ with partial pivoting, ${P}_{r}A{P}_{c}=LU$, where ${P}_{r}$ is a row permutation matrix (computed by F11MEF), ${P}_{c}$ is a (supplied) column permutation matrix, $L$ is unit lower triangular and $U$ is upper triangular. The column permutation matrix, ${P}_{c}$, must be computed by a prior call to F11MDF. The matrix $A$ must be presented in the column permuted, compressed column (Harwell–Boeing) format.
The $LU$ factorization is output in the form of four one-dimensional arrays: integer arrays IL and IU and real-valued arrays LVAL and UVAL. These describe the sparsity pattern and numerical values in the $L$ and $U$ matrices. The minimum required dimensions of these arrays cannot be given as a simple function of the size parameters (order and number of nonzero values) of the matrix $A$. This is due to unpredictable fill-in created by partial pivoting. F11MEF will, on return, indicate which dimensions of these arrays were not adequate for the computation or (in the case of one of them) give a firm bound. You should then allocate more storage and try again.
Demmel J W, Eisenstat S C, Gilbert J R, Li X S and Li J W H (1999) A supernodal approach to sparse partial pivoting SIAM J. Matrix Anal. Appl. 20 720–755
Demmel J W, Gilbert J R and Li X S (1999) An asynchronous parallel supernodal algorithm for sparse gaussian elimination SIAM J. Matrix Anal. Appl. 20 915–952

## 5  Parameters

1:     $\mathrm{N}$ – INTEGERInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{N}}\ge 0$.
2:     $\mathrm{IROWIX}\left(*\right)$ – INTEGER arrayInput
Note: the dimension of the array IROWIX must be at least $\mathit{nnz}$, the number of nonzeros of the sparse matrix $A$.
On entry: the row index array of sparse matrix $A$.
3:     $\mathrm{A}\left(*\right)$ – REAL (KIND=nag_wp) arrayInput
Note: the dimension of the array A must be at least $\mathit{nnz}$, the number of nonzeros of the sparse matrix $A$.
On entry: the array of nonzero values in the sparse matrix $A$.
4:     $\mathrm{IPRM}\left(7×{\mathbf{N}}\right)$ – INTEGER arrayInput/Output
On entry: contains the column permutation which defines the permutation ${P}_{c}$ and associated data structures as computed by routine F11MDF.
On exit: part of the array is modified to record the row permutation ${P}_{r}$ determined by pivoting.
5:     $\mathrm{THRESH}$ – REAL (KIND=nag_wp)Input
On entry: the diagonal pivoting threshold, $t$. At step $j$ of the Gaussian elimination, if $\left|{A}_{jj}\right|\ge t\left(\underset{i\ge j}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}\left|{A}_{ij}\right|\right)$, use ${A}_{jj}$ as a pivot, otherwise use $\underset{i\ge j}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}\left|{A}_{ij}\right|$. A value of $t=1$ corresponds to partial pivoting, a value of $t=0$ corresponds to always choosing the pivot on the diagonal (unless it is zero).
Suggested value: ${\mathbf{THRESH}}=1.0$. Smaller values may result in a faster factorization, but the benefits are likely to be small in most cases. It might be possible to use ${\mathbf{THRESH}}=0.0$ if you are confident about the stability of the factorization, for example, if $A$ is diagonally dominant.
Constraint: $0.0\le {\mathbf{THRESH}}\le 1.0$.
6:     $\mathrm{NZLMX}$ – INTEGERInput
On entry: indicates the available size of array IL. The dimension of IL should be at least $7×{\mathbf{N}}+{\mathbf{NZLMX}}+4$. A good range for NZLMX that works for many problems is $\mathit{nnz}$ to $8×\mathit{nnz}$, where $\mathit{nnz}$ is the number of nonzeros in the sparse matrix $A$. If, on exit, ${\mathbf{IFAIL}}={\mathbf{2}}$, the given NZLMX was too small and you should attempt to provide more storage and call the routine again.
Constraint: ${\mathbf{NZLMX}}\ge 1$.
7:     $\mathrm{NZLUMX}$ – INTEGERInput/Output
On entry: indicates the available size of array LVAL. The dimension of LVAL should be at least NZLUMX.
Constraint: ${\mathbf{NZLUMX}}\ge 1$.
On exit: if ${\mathbf{IFAIL}}={\mathbf{4}}$, the given NZLUMX was too small and is reset to a value that will be sufficient. You should then provide the indicated storage and call the routine again.
8:     $\mathrm{NZUMX}$ – INTEGERInput
On entry: indicates the available sizes of arrays IU and UVAL. The dimension of IU should be at least $2×{\mathbf{N}}+{\mathbf{NZUMX}}+1$ and the dimension of UVAL should be at least NZUMX. A good range for NZUMX that works for many problems is $\mathit{nnz}$ to $8×\mathit{nnz}$, where $\mathit{nnz}$ is the number of nonzeros in the sparse matrix $A$. If, on exit, ${\mathbf{IFAIL}}={\mathbf{3}}$, the given NZUMX was too small and you should attempt to provide more storage and call the routine again.
Constraint: ${\mathbf{NZUMX}}\ge 1$.
9:     $\mathrm{IL}\left(7×{\mathbf{N}}+{\mathbf{NZLMX}}+4\right)$ – INTEGER arrayOutput
On exit: encapsulates the sparsity pattern of matrix $L$.
10:   $\mathrm{LVAL}\left({\mathbf{NZLUMX}}\right)$ – REAL (KIND=nag_wp) arrayOutput
On exit: records the nonzero values of matrix $L$ and some of the nonzero values of matrix $U$.
11:   $\mathrm{IU}\left(2×{\mathbf{N}}+{\mathbf{NZUMX}}+1\right)$ – INTEGER arrayOutput
On exit: encapsulates the sparsity pattern of matrix $U$.
12:   $\mathrm{UVAL}\left({\mathbf{NZUMX}}\right)$ – REAL (KIND=nag_wp) arrayOutput
On exit: records some of the nonzero values of matrix $U$.
13:   $\mathrm{NNZL}$ – INTEGEROutput
On exit: the number of nonzero values in the matrix $L$.
14:   $\mathrm{NNZU}$ – INTEGEROutput
On exit: the number of nonzero values in the matrix $U$.
15:   $\mathrm{FLOP}$ – REAL (KIND=nag_wp)Output
On exit: the number of floating-point operations performed.
16:   $\mathrm{IFAIL}$ – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{N}}<0$, or ${\mathbf{NZLMX}}<1$, or ${\mathbf{NZLUMX}}<1$, or ${\mathbf{NZUMX}}<1$, or ${\mathbf{THRESH}}<0.0$, or ${\mathbf{THRESH}}>1.0$.
${\mathbf{IFAIL}}=2$
${\mathbf{NZLMX}}$ was not large enough. You should repeat the call with a larger value of ${\mathbf{NZLMX}}$, providing more storage for the output array ${\mathbf{IL}}$.
${\mathbf{IFAIL}}=3$
${\mathbf{NZUMX}}$ was not large enough. You should repeat the call with a larger value of ${\mathbf{NZUMX}}$, providing more storage for the output arrays ${\mathbf{IU}}$ and ${\mathbf{UVAL}}$.
${\mathbf{IFAIL}}=4$
${\mathbf{NZLUMX}}$ was not large enough. You should repeat the call with the value of ${\mathbf{NZLUMX}}$ returned on exit, providing more storage for the output array ${\mathbf{LVAL}}$.
${\mathbf{IFAIL}}=5$
The matrix $A$ is singular and no factorization will be attempted.
${\mathbf{IFAIL}}=301$
Unable to allocate required internal workspace.
${\mathbf{IFAIL}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-999$
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

## 7  Accuracy

The computed factors $L$ and $U$ are the exact factors of a perturbed matrix $A+E$, where
 $E ≤ c n ε L U ,$
$c\left(n\right)$ is a modest linear function of $n$, and $\epsilon$ is the machine precision, when partial pivoting is used. If no partial pivoting is used, the factorization accuracy can be considerably worse. A call to F11MMF after F11MEF can help determine the quality of the factorization.

## 8  Parallelism and Performance

F11MEF is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
F11MEF makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

## 9  Further Comments

The total number of floating-point operations depends on the sparsity pattern of the matrix $A$.
A call to F11MEF may be followed by calls to the routines:
• F11MFF to solve $AX=B$ or ${A}^{\mathrm{T}}X=B$;
• F11MGF to estimate the condition number of $A$;
• F11MMF to estimate the reciprocal pivot growth of the $LU$ factorization.

## 10  Example

This example computes the $LU$ factorization of the matrix $A$, where
 $A= 2.00 1.00 0 0 0 0 0 1.00 -1.00 0 4.00 0 1.00 0 1.00 0 0 0 1.00 2.00 0 -2.00 0 0 3.00 .$

### 10.1  Program Text

Program Text (f11mefe.f90)

### 10.2  Program Data

Program Data (f11mefe.d)

### 10.3  Program Results

Program Results (f11mefe.r)

F11MEF (PDF version)
F11 Chapter Contents
F11 Chapter Introduction
NAG Library Manual