mkl_?cscmv

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 11/07/2023

Version

Public

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

Visible to Intel only — GUID: GUID-C2EE93F0-B573-4538-A994-202CB3ADFFC2

View Details

mkl_?cscmv

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

Syntax

call mkl_scscmv(transa, m, k, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_dcscmv(transa, m, k, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_ccscmv(transa, m, k, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_zcscmv(transa, m, k, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

Include Files

mkl.fi

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

y := alpha*A^T*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, A^T is the transpose of A.

NOTE:

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

Input Parameters

Parameter descriptions are common for all implemented interfaces with the exception of data types that refer here to the FORTRAN 77 standard types. Data types specific to the different interfaces are described in the section "Interfaces" below.

transa

CHARACTER*1. 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*A^T*x + beta*y,

m

INTEGER. Number of rows of the matrix A.

k

INTEGER. Number of columns of the matrix A.

alpha

REAL for mkl_scscmv.

DOUBLE PRECISION for mkl_dcscmv.

COMPLEX for mkl_ccscmv.

DOUBLE COMPLEX for mkl_zcscmv.

Specifies the scalar alpha.

matdescra

CHARACTER. 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

REAL for mkl_scscmv.

DOUBLE PRECISION for mkl_dcscmv.

COMPLEX for mkl_ccscmv.

DOUBLE COMPLEX for mkl_zcscmv.

Array containing non-zero elements of the matrix A.

For one-based indexing its length is pntre(k) - pntrb(1).

For zero-based indexing its length is pntre(m-1) - pntrb(0).

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

indx

INTEGER. Array containing the row 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

INTEGER. Array of length k.

For one-based indexing this array contains column indices, such that pntrb(i) - pntrb(1) + 1 is the first index of column i in the arrays val and indx.

For zero-based indexing this array contains column indices, such that pntrb(i) - pntrb(0) 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

INTEGER. 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

REAL for mkl_scscmv.

DOUBLE PRECISION for mkl_dcscmv.

COMPLEX for mkl_ccscmv.

DOUBLE COMPLEX for mkl_zcscmv.

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

REAL for mkl_scscmv.

DOUBLE PRECISION for mkl_dcscmv.

COMPLEX for mkl_ccscmv.

DOUBLE COMPLEX for mkl_zcscmv.

Specifies the scalar beta.

y

REAL for mkl_scscmv.

DOUBLE PRECISION for mkl_dcscmv.

COMPLEX for mkl_ccscmv.

DOUBLE COMPLEX for mkl_zcscmv.

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.

Interfaces

FORTRAN 77:

SUBROUTINE mkl_scscmv(transa, m, k, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  REAL         alpha, beta

  REAL         val(*), x(*), y(*)

SUBROUTINE mkl_dcscmv(transa, m, k, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  DOUBLE PRECISION        alpha, beta

  DOUBLE PRECISION        val(*), x(*), y(*)

SUBROUTINE mkl_ccscmv(transa, m, k, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  COMPLEX        alpha, beta

  COMPLEX        val(*), x(*), y(*)

SUBROUTINE mkl_zcscmv(transa, m, k, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  DOUBLE COMPLEX        alpha, beta

  DOUBLE COMPLEX        val(*), x(*), y(*)

Parent topic: Sparse BLAS Level 2 and Level 3 Routines.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

mkl_?cscmv

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: