NAG Library Routine Document
F11XNF computes a matrix-vector or conjugate transposed matrix-vector product involving a complex sparse non-Hermitian matrix stored in coordinate storage format.
||N, NNZ, IROW(NNZ), ICOL(NNZ), IFAIL
||A(NNZ), X(N), Y(N)
F11XNF computes either the matrix-vector product
, or the conjugate transposed matrix-vector product
, according to the value of the argument TRANS
is a complex
sparse non-Hermitian matrix, of arbitrary sparsity pattern. The matrix
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
, while arrays IROW
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 9
- 1: TRANS – CHARACTER(1)Input
: specifies whether or not the matrix
is conjugate transposed.
- is computed.
- is computed.
- 2: N – INTEGERInput
On entry: , the order of the matrix .
- 3: NNZ – INTEGERInput
On entry: the number of nonzero elements in the matrix .
- 4: A(NNZ) – COMPLEX (KIND=nag_wp) arrayInput
: the nonzero elements in the matrix
, 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: IROW(NNZ) – INTEGER arrayInput
- 6: ICOL(NNZ) – INTEGER arrayInput
: the row and column indices of the nonzero elements supplied in array A
- and , for ;
- or and , for .
- 7: CHECK – CHARACTER(1)Input
: specifies whether or not the CS representation of the matrix
, values of N
should be checked.
- Checks are carried on the values of N, NNZ, IROW and ICOL.
- None of these checks are carried out.
- 8: X(N) – COMPLEX (KIND=nag_wp) arrayInput
On entry: the vector .
- 9: Y(N) – COMPLEX (KIND=nag_wp) arrayOutput
On exit: the vector .
- 10: IFAIL – INTEGERInput/Output
must be set to
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
. When the value is used it is essential to test the value of IFAIL on exit.
unless the routine detects an error or a warning has been flagged (see Section 6
6 Error Indicators and Warnings
If on entry
, explanatory error messages are output on the current error message unit (as defined by X04AAF
Errors or warnings detected by the routine:
|On entry,|| or ,|
|or|| or .|
On entry, the arrays IROW
fail to satisfy the following constraints:
- and , for ;
- , or and , for .
Therefore a nonzero element has been supplied which does not lie within the matrix
, is out of order, or has duplicate row and column indices. Call F11ZNF
to reorder and sum or remove duplicates.
The computed vector
satisfies the error bound:
- , if , or
is a modest linear function of
is the machine precision
The time taken for a call to F11XNF is proportional to NNZ
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
. In the interests of both reliability and efficiency you are recommended to set
for the first of such calls, and to set
for all subsequent calls.
This example reads in a complex sparse matrix and a vector . It then calls F11XNF to compute the matrix-vector product and the conjugate transposed matrix-vector product .
9.1 Program Text
Program Text (f11xnfe.f90)
9.2 Program Data
Program Data (f11xnfe.d)
9.3 Program Results
Program Results (f11xnfe.r)