NAG Library Routine Document

1Purpose

f11xnf computes a matrix-vector or conjugate transposed matrix-vector product involving a complex sparse non-Hermitian matrix stored in coordinate storage format.

2Specification

Fortran Interface
 Subroutine f11xnf ( n, nnz, a, irow, icol, x, y,
 Integer, Intent (In) :: n, nnz, irow(nnz), icol(nnz) Integer, Intent (Inout) :: ifail Complex (Kind=nag_wp), Intent (In) :: a(nnz), x(n) Complex (Kind=nag_wp), Intent (Out) :: y(n) Character (1), Intent (In) :: trans, check
#include nagmk26.h
 void f11xnf_ (const char *trans, const Integer *n, const Integer *nnz, const Complex a[], const Integer irow[], const Integer icol[], const char *check, const Complex x[], Complex y[], Integer *ifail, const Charlen length_trans, const Charlen length_check)

3Description

f11xnf computes either the matrix-vector product $y=Ax$, or the conjugate transposed matrix-vector product $y={A}^{\mathrm{H}}x$, according to the value of the argument trans, where $A$ is a complex $n$ by $n$ sparse non-Hermitian matrix, of arbitrary sparsity pattern. The matrix $A$ is stored in coordinate storage (CS) format (see Section 2.1.1 in the F11 Chapter Introduction). The array a stores all the nonzero elements of $A$, while arrays irow and icol store the corresponding row and column indices respectively.
It is envisaged that a common use of f11xnf will be to compute the matrix-vector product required in the application of f11bsf to sparse complex linear systems. This is illustrated in Section 10 in f11drf.

None.

5Arguments

1:     $\mathbf{trans}$ – Character(1)Input
On entry: specifies whether or not the matrix $A$ is conjugate transposed.
${\mathbf{trans}}=\text{'N'}$
$y=Ax$ is computed.
${\mathbf{trans}}=\text{'T'}$
$y={A}^{\mathrm{H}}x$ is computed.
Constraint: ${\mathbf{trans}}=\text{'N'}$ or $\text{'T'}$.
2:     $\mathbf{n}$ – IntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 1$.
3:     $\mathbf{nnz}$ – IntegerInput
On entry: the number of nonzero elements in the matrix $A$.
Constraint: $1\le {\mathbf{nnz}}\le {{\mathbf{n}}}^{2}$.
4:     $\mathbf{a}\left({\mathbf{nnz}}\right)$ – Complex (Kind=nag_wp) arrayInput
On entry: the nonzero elements in the matrix $A$, ordered by increasing row index, and by increasing column index within each row. Multiple entries for the same row and column indices are not permitted. The routine f11znf may be used to order the elements in this way.
5:     $\mathbf{irow}\left({\mathbf{nnz}}\right)$ – Integer arrayInput
6:     $\mathbf{icol}\left({\mathbf{nnz}}\right)$ – Integer arrayInput
On entry: the row and column indices of the nonzero elements supplied in array a.
Constraints:
• $1\le {\mathbf{irow}}\left(\mathit{i}\right)\le {\mathbf{n}}$ and $1\le {\mathbf{icol}}\left(\mathit{i}\right)\le {\mathbf{n}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{nnz}}$;
• ${\mathbf{irow}}\left(\mathit{i}-1\right)<{\mathbf{irow}}\left(\mathit{i}\right)$ or ${\mathbf{irow}}\left(\mathit{i}-1\right)={\mathbf{irow}}\left(\mathit{i}\right)$ and ${\mathbf{icol}}\left(\mathit{i}-1\right)<{\mathbf{icol}}\left(\mathit{i}\right)$, for $\mathit{i}=2,3,\dots ,{\mathbf{nnz}}$.
7:     $\mathbf{check}$ – Character(1)Input
On entry: specifies whether or not the CS representation of the matrix $A$, values of n, nnz, irow and icol should be checked.
${\mathbf{check}}=\text{'C'}$
Checks are carried on the values of n, nnz, irow and icol.
${\mathbf{check}}=\text{'N'}$
None of these checks are carried out.
Constraint: ${\mathbf{check}}=\text{'C'}$ or $\text{'N'}$.
8:     $\mathbf{x}\left({\mathbf{n}}\right)$ – Complex (Kind=nag_wp) arrayInput
On entry: the vector $x$.
9:     $\mathbf{y}\left({\mathbf{n}}\right)$ – Complex (Kind=nag_wp) arrayOutput
On exit: the vector $y$.
10:   $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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).

6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-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{trans}}\ne \text{'N'}$ or $\text{'T'}$, or ${\mathbf{check}}\ne \text{'C'}$ or $\text{'N'}$.
${\mathbf{ifail}}=2$
 On entry, ${\mathbf{n}}<1$, or ${\mathbf{nnz}}<1$, or ${\mathbf{nnz}}>{{\mathbf{n}}}^{2}$.
${\mathbf{ifail}}=3$
On entry, the arrays irow and icol fail to satisfy the following constraints:
• $1\le {\mathbf{irow}}\left(i\right)\le {\mathbf{n}}$ and $1\le {\mathbf{icol}}\left(i\right)\le {\mathbf{n}}$, for $i=1,2,\dots ,{\mathbf{nnz}}$;
• ${\mathbf{irow}}\left(i-1\right)<{\mathbf{irow}}\left(i\right)$, or ${\mathbf{irow}}\left(i-1\right)={\mathbf{irow}}\left(i\right)$ and ${\mathbf{icol}}\left(i-1\right)<{\mathbf{icol}}\left(i\right)$, for $i=2,3,\dots ,{\mathbf{nnz}}$.
Therefore a nonzero element has been supplied which does not lie within the matrix $A$, is out of order, or has duplicate row and column indices. Call f11znf to reorder and sum or remove duplicates.
${\mathbf{ifail}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7Accuracy

The computed vector $y$ satisfies the error bound:
• ${‖y-Ax‖}_{\infty }\le c\left(n\right)\epsilon {‖A‖}_{\infty }{‖x‖}_{\infty }$, if ${\mathbf{trans}}=\text{'N'}$, or
• ${‖y-{A}^{\mathrm{H}}x‖}_{\infty }\le c\left(n\right)\epsilon {‖{A}^{\mathrm{H}}‖}_{\infty }{‖x‖}_{\infty }$, if ${\mathbf{trans}}=\text{'T'}$,
where $c\left(n\right)$ is a modest linear function of $n$, and $\epsilon$ is the machine precision.

8Parallelism and Performance

f11xnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f11xnf 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.1Timing

The time taken for a call to f11xnf is proportional to nnz.

9.2Use of check

It is expected that a common use of f11xnf will be to compute the matrix-vector product required in the application of f11bsf to sparse complex linear systems. In this situation f11xnf is likely to be called many times with the same matrix $A$. In the interests of both reliability and efficiency you are recommended to set ${\mathbf{check}}=\text{'C'}$ for the first of such calls, and to set ${\mathbf{check}}=\text{'N'}$ for all subsequent calls.

10Example

This example reads in a complex sparse matrix $A$ and a vector $x$. It then calls f11xnf to compute the matrix-vector product $y=Ax$ and the conjugate transposed matrix-vector product $y={A}^{\mathrm{H}}x$.

10.1Program Text

Program Text (f11xnfe.f90)

10.2Program Data

Program Data (f11xnfe.d)

10.3Program Results

Program Results (f11xnfe.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017