NAG FL Interface
f11xaf (real_​gen_​matvec)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

f11xaf computes a matrix-vector or transposed matrix-vector product involving a real sparse nonsymmetric matrix stored in coordinate storage format.

2 Specification

Fortran Interface
Subroutine f11xaf ( trans, n, nnz, a, irow, icol, check, x, y, ifail)
Integer, Intent (In) :: n, nnz, irow(nnz), icol(nnz)
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: a(nnz), x(n)
Real (Kind=nag_wp), Intent (Out) :: y(n)
Character (1), Intent (In) :: trans, check
C Header Interface
#include <nag.h>
void  f11xaf_ (const char *trans, const Integer *n, const Integer *nnz, const double a[], const Integer irow[], const Integer icol[], const char *check, const double x[], double y[], Integer *ifail, const Charlen length_trans, const Charlen length_check)
The routine may be called by the names f11xaf or nagf_sparse_real_gen_matvec.

3 Description

f11xaf computes either the matrix-vector product y=Ax, or the transposed matrix-vector product y=ATx, according to the value of the argument trans, where A is an n×n sparse nonsymmetric 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 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 f11xaf will be to compute the matrix-vector product required in the application of f11bef to sparse linear systems. An illustration of this usage appears in Section 10 in f11ddf.

4 References


5 Arguments

1: trans Character(1) Input
On entry: specifies whether or not the matrix A is transposed.
y=Ax is computed.
y=ATx is computed.
Constraint: trans='N' or 'T'.
2: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n1.
3: nnz Integer Input
On entry: the number of nonzero elements in the matrix A.
Constraint: 1nnzn2.
4: a(nnz) Real (Kind=nag_wp) array Input
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 f11zaf may be used to order the elements in this way.
5: irow(nnz) Integer array Input
6: icol(nnz) Integer array Input
On entry: the row and column indices of the nonzero elements supplied in array a.
irow and icol must satisfy the following constraints (which may be imposed by a call to f11zaf):
  • 1irow(i)n and 1icol(i)n, for i=1,2,,nnz;
  • irow(i-1)<irow(i) or irow(i-1)=irow(i) and icol(i-1)<icol(i), for i=2,3,,nnz.
7: 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.
Checks are carried on the values of n, nnz, irow and icol.
None of these checks are carried out.
See also Section 9.2.
Constraint: check='C' or 'N'.
8: x(n) Real (Kind=nag_wp) array Input
On entry: the vector x.
9: y(n) Real (Kind=nag_wp) array Output
On exit: the vector y.
10: ifail Integer Input/Output
On entry: ifail must be set to 0, -1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of -1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value -1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry 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:
On entry, check=value.
Constraint: check='C' or 'N'.
On entry, trans=value.
Constraint: trans='N' or 'T'.
On entry, n=value.
Constraint: n1.
On entry, nnz=value.
Constraint: nnz1.
On entry, nnz=value and n=value.
Constraint: nnzn2.
On entry, a(i) is out of order: i=value.
On entry, i=value, icol(i)=value and n=value.
Constraint: icol(i)1 and icol(i)n.
On entry, i=value, irow(i)=value and n=value.
Constraint: irow(i)1 and irow(i)n.
On entry, the location (irow(I),icol(I)) is a duplicate: I=value.
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. Consider calling f11zaf to reorder and sum or remove duplicates.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The computed vector y satisfies the error bound: where c(n) is a modest linear function of n, and ε is the machine precision.

8 Parallelism and Performance

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

9.1 Timing

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

9.2 Use of check

It is expected that a common use of f11xaf will be to compute the matrix-vector product required in the application of f11bef to sparse linear systems. In this situation f11xaf 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 check='C' for the first of such calls, and to set check='N' for all subsequent calls.

10 Example

This example reads in a sparse matrix A and a vector x. It then calls f11xaf to compute the matrix-vector product y=Ax and the transposed matrix-vector product y=ATx.

10.1 Program Text

Program Text (f11xafe.f90)

10.2 Program Data

Program Data (f11xafe.d)

10.3 Program Results

Program Results (f11xafe.r)