Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

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

Document Table of Contents

mkl_?coomv

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

Syntax

call mkl_scoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)

call mkl_dcoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)

call mkl_ccoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)

call mkl_zcoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, 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_?coomv 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 coordinate format, AT is the transpose of A.

NOTE:

This routine supports a coordinate 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*AT*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_scoomv.

DOUBLE PRECISION for mkl_dcoomv.

COMPLEX for mkl_ccoomv.

DOUBLE COMPLEX for mkl_zcoomv.

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

DOUBLE PRECISION for mkl_dcoomv.

COMPLEX for mkl_ccoomv.

DOUBLE COMPLEX for mkl_zcoomv.

Array of length nnz, contains non-zero elements of the matrix A in the arbitrary order.

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

rowind

INTEGER. Array of length nnz, contains the row indices for each non-zero element of the matrix A.

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

colind

INTEGER. Array of length nnz, contains the column indices for each non-zero element of the matrix A.

Refer to columns array description in Coordinate Format for more details.

nnz

INTEGER. Specifies the number of non-zero element of the matrix A.

Refer to nnz description in Coordinate Format for more details.

x

REAL for mkl_scoomv.

DOUBLE PRECISION for mkl_dcoomv.

COMPLEX for mkl_ccoomv.

DOUBLE COMPLEX for mkl_zcoomv.

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

DOUBLE PRECISION for mkl_dcoomv.

COMPLEX for mkl_ccoomv.

DOUBLE COMPLEX for mkl_zcoomv.

Specifies the scalar beta.

y

REAL for mkl_scoomv.

DOUBLE PRECISION for mkl_dcoomv.

COMPLEX for mkl_ccoomv.

DOUBLE COMPLEX for mkl_zcoomv.

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_scoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, k, nnz
  INTEGER       rowind(*), colind(*)
  REAL         alpha, beta
  REAL         val(*), x(*), y(*)

SUBROUTINE mkl_dcoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, k, nnz
  INTEGER       rowind(*), colind(*)
  DOUBLE PRECISION        alpha, beta
  DOUBLE PRECISION        val(*), x(*), y(*)

SUBROUTINE mkl_ccoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, k, nnz
  INTEGER       rowind(*), colind(*)
  COMPLEX        alpha, beta
  COMPLEX        val(*), x(*), y(*)

SUBROUTINE mkl_zcoomv(transa, m, k, alpha, matdescra, val, rowind, colind, nnz, x, beta, y)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, k, nnz
  INTEGER       rowind(*), colind(*)
  DOUBLE COMPLEX        alpha, beta
  DOUBLE COMPLEX        val(*), x(*), y(*)