naginterfaces.library.matop.real_​gen_​blkdiag_​lu

naginterfaces.library.matop.real_gen_blkdiag_lu(n, blkstr, a, tol)

real_gen_blkdiag_lu factorizes a real almost block diagonal matrix.

For full information please refer to the NAG Library document for f01lh

https://support.nag.com/numeric/nl/nagdoc_30.1/flhtml/f01/f01lhf.html

Parameters

nint

$n$, the order of the matrix $A$.

blkstrint, array-like, shape $(3,\text{nbloks})$

Information which describes the block structure of $A$ as follows:

$blkstr[0,k-1]$ must contain the number of rows in the $k$th block, $k=1,2,\dots ,\text{nbloks}$;

$blkstr[1,k-1]$ must contain the number of columns in the $k$th block, $k=1,2,\dots ,\text{nbloks}$;

$blkstr[2,k-1]$ must contain the number of columns of overlap between the $k$th and $(k+1)$th blocks, $k=1,2,\dots ,\text{nbloks}-1$. $blkstr[2,\text{nbloks}-1]$ need not be set.

The following conditions delimit the structure of $A$:

$blkstr[0,k-1],blkstr[1,k-1]>0\text{,}k=1,2,\dots ,\text{nbloks}$,

$blkstr[2,k-1]\ge 0\text{,}k=1,2,\dots ,\text{nbloks}-1$,

(there must be at least one column and one row in each block and a non-negative number of columns of overlap);

$blkstr[2,k-2]+blkstr[2,k-1]\le blkstr[1,k-1]\text{,}k=2,3,\dots ,\text{nbloks}-1$,

(the total number of columns in overlaps in each block must not exceed the number of columns in that block);

$blkstr[1,0]\ge blkstr[0,0]$,

$blkstr[1,0]+{\sum }_{k=2}^j\left[blkstr\right[1,k-1]-blkstr[2,k-1-1\left]\right]\ge {\sum }_{k=1}^{j}blkstr[0,k-1]$, $j=2,3,\dots ,\text{nbloks}-1$,

${\sum }_{k=1}^j\left[blkstr\right[1,k-1]-blkstr[2,k-1\left]\right]\le {\sum }_{k=1}^{j}blkstr[0,k-1]\text{,}j=1,2,\dots ,\text{nbloks}-1$,

(the index of the first column of the overlap between the $j$th and $(j+1)$th blocks must be $\le$ the index of the last row of the $j$th block, and the index of the last column of overlap must be $\ge$ the index of the last row of the $j$th block);

${\sum }_{k=1}^{\text{nbloks}}blkstr[0,k-1]=n$,

$blkstr[1,0]+{\sum }_{k=2}^{\text{nbloks}}\left[blkstr\right[1,k-1]-blkstr[2,k-1-1\left]\right]=nk$,

(both the number of rows and the number of columns of $A$ must equal $n$).

afloat, array-like, shape $\left(\text{lena}\right)$

The elements of the almost block diagonal matrix stored block by block, with each block stored column by column. The sizes of the blocks and the overlaps are defined by the argument $blkstr$.

If $a_{rs}$ is the first element in the $k$th block, then an arbitrary element $a_{ij}$ in the $k$th block must be stored in the array element:

$$a[p_k+(j-r)m_k+(i-s)+1-1]$$

where

$$p_k=\sum _{l=1}^{k-1}blkstr[0,l-1]\times blkstr[1,l-1]$$

is the base address of the $k$th block, and

$$m_k=blkstr[0,k-1]$$

is the number of rows of the $k$th block.

See Further Comments for comments on scaling.

tolfloat

A relative tolerance to be used to indicate whether or not the matrix is singular. For a discussion on how $tol$ is used see Further Comments. If $tol$ is non-positive, $tol$ is reset to $10ϵ$, where $ϵ$ is the machine precision.

Returns

afloat, ndarray, shape $\left(\text{lena}\right)$

The factorized form of the matrix.

pivotint, ndarray, shape $\left(n\right)$

Details of the interchanges.

tolfloat

Unchanged unless $tol\le 0.0$ on entry, in which case it is set to $10ϵ$.

kpivotint

If $errno$ = 2, $kpivot$ contains the value $k$, where $k$ is the first position on the diagonal of the matrix $A$ where too small a pivot was detected. Otherwise $kpivot$ is set to $0$.

Raises

NagValueError

(errno $1$)

On entry, $\text{lena}$ is too small. $\text{lena}=⟨value⟩$. Minimum possible dimension: $⟨value⟩$.

(errno $1$)

On entry, the following equality does not hold: $blkstr[1,0]+sum(blkstr[1,k-1]-blkstr[2,k-2]:k=2,\text{nbloks})=n$.

(errno $1$)

On entry, the following equality does not hold: $sum(blkstr[0,k-1]:k=1,\text{nbloks})=n$.

(errno $1$)

On entry, $K=⟨value⟩$ $blkstr[2,K-1]=⟨value⟩$ $blkstr[2,K-2]=⟨value⟩$ and $blkstr[1,K-1]=⟨value⟩$.

Constraint: $blkstr[2,K-1]+blkstr[2,K-2]\ge blkstr[1,K-1]$.

(errno $1$)

On entry, the following inequality was not satisfied for: $J=⟨value⟩$. $sum(blkstr[1,k-1]-blkstr[2,k-1]:k=1,J)\le$ $sum(blkstr[0,k-1]:k=1,J)\le$ $blkstr[1,0]+sum(blkstr[1,k-1]-blkstr[2,k-2]:k=2,J)$.

(errno $1$)

On entry, $K=⟨value⟩$, $blkstr[1,K-1]=⟨value⟩$ $blkstr[2,K-1]=⟨value⟩$ and $blkstr[0,K-1]=⟨value⟩$.

Constraint: $blkstr[1,K-1]-blkstr[2,K-1]\le blkstr[0,K-1]$.

(errno $1$)

On entry, $K=⟨value⟩$, $blkstr[1,K-1]=⟨value⟩$ and $blkstr[0,K-1]=⟨value⟩$.

Constraint: $blkstr[1,K-1]\ge blkstr[0,K-1]$.

(errno $1$)

On entry, $K=⟨value⟩$ and $blkstr[2,K-1]=⟨value⟩$.

Constraint: $blkstr[2,K-1]\ge 0$.

(errno $1$)

On entry, $K=⟨value⟩$ and $blkstr[1,K-1]=⟨value⟩$.

Constraint: $blkstr[1,K-1]\ge 1$.

(errno $1$)

On entry, $K=⟨value⟩$ and $blkstr[0,K-1]=⟨value⟩$.

Constraint: $blkstr[0,K-1]\ge 1$.

(errno $1$)

On entry, $n=⟨value⟩$ and $\text{nbloks}=⟨value⟩$.

Constraint: $n\ge \text{nbloks}$.

(errno $1$)

On entry, $\text{nbloks}=⟨value⟩$.

Constraint: $\text{nbloks}\ge 1$.

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 1$.

Warns

NagAlgorithmicWarning

(errno $2$)

Factorization completed, but pivot in diagonal $I$ was small: $I=⟨value⟩$.

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

real_gen_blkdiag_lu factorizes a real almost block diagonal matrix, $A$, by row elimination with alternate row and column pivoting such that no ‘fill-in’ is produced. The code, which is derived from ARCECO described in Diaz et al. (1983), uses Level 1 and Level 2 BLAS. No three successive diagonal blocks may have columns in common and, therefore, the almost block diagonal matrix must have the form shown in the following diagram:

[figure omitted]

This function may be followed by linsys.real_blkdiag_fac_solve, which is designed to solve sets of linear equations $AX=B$ or $A^{T}X=B$.

References

Diaz, J C, Fairweather, G and Keast, P, 1983, Fortran packages for solving certain almost block diagonal linear systems by modified alternate row and column elimination, ACM Trans. Math. Software (9), 358–375