Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

mkl_?cscmv

Computes matrix-vector product for a sparse matrix in the CSC format (deprecated).

Syntax

void mkl_scscmv (const char *transa , const MKL_INT *m , const MKL_INT *k , const float *alpha , const char *matdescra , const float *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const float *x , const float *beta , float *y );

void mkl_dcscmv (const char *transa , const MKL_INT *m , const MKL_INT *k , const double *alpha , const char *matdescra , const double *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const double *x , const double *beta , double *y );

void mkl_ccscmv (const char *transa , const MKL_INT *m , const MKL_INT *k , const MKL_Complex8 *alpha , const char *matdescra , const MKL_Complex8 *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const MKL_Complex8 *x , const MKL_Complex8 *beta , MKL_Complex8 *y );

void mkl_zcscmv (const char *transa , const MKL_INT *m , const MKL_INT *k , const MKL_Complex16 *alpha , const char *matdescra , const MKL_Complex16 *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const MKL_Complex16 *x , const MKL_Complex16 *beta , MKL_Complex16 *y );

Include Files

  • mkl.h

Description

This routine is deprecated. Use mkl_sparse_?_mvfrom the Intel® oneAPI Math Kernel Library (oneMKL) Inspector-executor Sparse BLAS interface instead.

The mkl_?cscmv routine performs a matrix-vector operation defined as

y := alpha*A*x + beta*y

or

y := alpha*AT*x + beta*y,

where:

alpha and beta are scalars,

x and y are vectors,

A is an m-by-k sparse matrix in compressed sparse column (CSC) format, AT is the transpose of A.

NOTE:

This routine supports CSC format both with one-based indexing and zero-based indexing.

Input Parameters

transa

Specifies the operation.

If transa = 'N' or 'n', then y := alpha*A*x + beta*y

If transa = 'T' or 't' or 'C' or 'c', then y := alpha*AT*x + beta*y,

m

Number of rows of the matrix A.

k

Number of columns of the matrix A.

alpha

Specifies the scalar alpha.

matdescra

Array of six elements, specifies properties of the matrix used for operation. Only first four array elements are used, their possible values are given in Table “Possible Values of the Parameter matdescra (descra)”. Possible combinations of element values of this parameter are given in Table “Possible Combinations of Element Values of the Parameter matdescra.

val

Array containing non-zero elements of the matrix A.

Its length is pntre[k-1] - pntrb[0].

Refer to values array description in CSC Format for more details.

indx

For one-based indexing, array containing the column indices plus one for each non-zero element of the matrix A. For zero-based indexing, array containing the column indices for each non-zero element of the matrix A.

Its length is equal to length of the val array.

Refer to rows array description in CSC Format for more details.

pntrb

Array of length k.

This array contains column indices, such that pntrb[i] - pntrb[0] + 1 is the first index of column i in the arrays val and indx.

Refer to pointerb array description in CSC Format for more details.

pntre

Array of length k.

For one-based indexing this array contains column indices, such that pntre[i] - pntrb[1] is the last index of column i in the arrays val and indx.

For zero-based indexing this array contains column indices, such that pntre[i] - pntrb[1] - 1 is the last index of column i in the arrays val and indx.

Refer to pointerE array description in CSC Format for more details.

x

Array, size at least k if transa = 'N' or 'n' and at least m otherwise. On entry, the array x must contain the vector x.

beta

Specifies the scalar beta.

y

Array, size at least m if transa = 'N' or 'n' and at least k otherwise. On entry, the array y must contain the vector y.

Output Parameters

y

Overwritten by the updated vector y.