naginterfaces.library.sparse.complex_​herm_​matvec

naginterfaces.library.sparse.complex_herm_matvec(a, irow, icol, x, check='N')[source]

complex_herm_matvec computes a matrix-vector product involving a complex sparse Hermitian matrix stored in symmetric coordinate storage format.

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

https://www.nag.com/numeric/nl/nagdoc_28.5/flhtml/f11/f11xsf.html

Parameters
acomplex, array-like, shape

The nonzero elements in the lower triangular part of 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 function complex_herm_sort() may be used to order the elements in this way.

irowint, array-like, shape

The row indices of the nonzero elements supplied in array .

icolint, array-like, shape

The column indices of the nonzero elements supplied in array .

xcomplex, array-like, shape

The vector .

checkstr, length 1, optional

Specifies whether or not the SCS representation of the matrix , values of , , and should be checked.

Checks are carried out on the values of , , and .

None of these checks are carried out.

Returns
ycomplex, ndarray, shape

The vector .

Raises
NagValueError
(errno )

On entry, .

Constraint: or .

(errno )

On entry, and .

Constraint: .

(errno )

On entry, .

Constraint: .

(errno )

On entry, .

Constraint: .

(errno )

On entry, the location () is a duplicate: .

(errno )

On entry, is out of order: .

(errno )

On entry, , and .

Constraint: and .

(errno )

On entry, , and .

Constraint: and .

Notes

complex_herm_matvec computes the matrix-vector product

where is an complex Hermitian sparse matrix, of arbitrary sparsity pattern, stored in symmetric coordinate storage (SCS) format (see the F11 Introduction). The array stores all the nonzero elements in the lower triangular part of , while arrays and store the corresponding row and column indices respectively.