Rate This Document
Findability
Accuracy
Completeness
Readability

KesMatrixSetShellMatVec

Interface Definition

KesReturnCode KesMatrixSetShellMatVec(KesMatrix A, UserData data, UserMatVec matvec);

Interface Description

Sets matrix-vector multiplication for the KES_SHELL matrix.

Parameters

Parameter

Type

Description

Input/Output

A

KesMatrix

Handle to the matrix. The matrix must be an existing matrix in KES_SHELL format.

Input/Output

data

void *

User-defined data type.

Input

matvec

void (*)(void *data, void *X, void *AX, int nRows, int nCols, int ld)

User-defined matrix-vector multiplication.

Input

Option of matvec

Type

Description

data

void *

The value of this parameter is the same as that of data in KesMatrixSetShellMatVec.

X

void *

Address to the leading element of the source vector X in matrix-vector multiplication AX = A * X. The data type of X must be the same as that of KES matrix A.

AX

void *

Address to the leading element of the result vector AX in matrix-vector multiplication AX = A * X. The data type of AX must be the same as that of KES matrix A.

nRows

int

Local vector length of X, which is also the local vector length of AX.

nCols

int

Number of vectors in X, which is also the number of vectors in AX.

ld

int

Leading dimension of X, which is also the leading dimension of AX.