NAG CL Interfacef11mlc (direct_​real_​gen_​norm)

Settings help

CL Name Style:

1Purpose

f11mlc computes the $1$-norm, the $\infty$-norm or the maximum absolute value of the elements of a real, square, sparse matrix which is held in compressed column (Harwell–Boeing) format.

2Specification

 #include
 void f11mlc (Nag_NormType norm, double *anorm, Integer n, const Integer icolzp[], const Integer irowix[], const double a[], NagError *fail)
The function may be called by the names: f11mlc, nag_sparse_direct_real_gen_norm or nag_superlu_matrix_norm.

3Description

f11mlc computes various quantities relating to norms of a real, sparse $n×n$ matrix $A$ presented in compressed column (Harwell–Boeing) format.

None.

5Arguments

1: $\mathbf{norm}$Nag_NormType Input
On entry: specifies the value to be returned in anorm.
${\mathbf{norm}}=\mathrm{Nag_RealOneNorm}$
The $1$-norm ${‖A‖}_{1}$ of the matrix is computed, that is $\underset{1\le j\le n}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}\sum _{i=1}^{n}|{A}_{ij}|$.
${\mathbf{norm}}=\mathrm{Nag_RealInfNorm}$
The $\infty$-norm ${‖A‖}_{\infty }$ of the matrix is computed, that is $\underset{1\le i\le n}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}\sum _{j=1}^{n}|{A}_{ij}|$.
${\mathbf{norm}}=\mathrm{Nag_RealMaxNorm}$
The value $\underset{1\le i,j\le n}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}|{A}_{ij}|$ (not a norm).
Constraint: ${\mathbf{norm}}=\mathrm{Nag_RealOneNorm}$, $\mathrm{Nag_RealInfNorm}$ or $\mathrm{Nag_RealMaxNorm}$.
2: $\mathbf{anorm}$double * Output
On exit: the computed quantity relating the matrix.
3: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
4: $\mathbf{icolzp}\left[\mathit{dim}\right]$const Integer Input
Note: the dimension, dim, of the array icolzp must be at least ${\mathbf{n}}+1$.
On entry: the new column index array of sparse matrix $A$. See Section 2.1.3 in the F11 Chapter Introduction.
5: $\mathbf{irowix}\left[\mathit{dim}\right]$const Integer Input
Note: the dimension, dim, of the array irowix must be at least ${\mathbf{icolzp}}\left[{\mathbf{n}}\right]-1$, the number of nonzeros of the sparse matrix $A$.
On entry: the row index array of sparse matrix $A$. See Section 2.1.3 in the F11 Chapter Introduction.
6: $\mathbf{a}\left[\mathit{dim}\right]$const double Input
Note: the dimension, dim, of the array a must be at least ${\mathbf{icolzp}}\left[{\mathbf{n}}\right]-1$, the number of nonzeros of the sparse matrix $A$.
On entry: the array of nonzero values in the sparse matrix $A$.
7: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

Not applicable.

8Parallelism and Performance

f11mlc 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

None.

10Example

This example computes norms and maximum absolute value 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.1Program Text

Program Text (f11mlce.c)

10.2Program Data

Program Data (f11mlce.d)

10.3Program Results

Program Results (f11mlce.r)