mkl_?diamv

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 6/24/2024

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-1F721705-F9EB-4FDD-82CC-2C7B5C66A898

View Details

mkl_?diamv

Computes matrix - vector product for a sparse matrix in the diagonal format with one-based indexing (deprecated).

Syntax

call mkl_sdiamv(transa, m, k, alpha, matdescra, val, lval, idiag, ndiag, x, beta, y)

call mkl_ddiamv(transa, m, k, alpha, matdescra, val, lval, idiag, ndiag, x, beta, y)

call mkl_cdiamv(transa, m, k, alpha, matdescra, val, lval, idiag, ndiag, x, beta, y)

call mkl_zdiamv(transa, m, k, alpha, matdescra, val, lval, idiag, ndiag, x, beta, y)

Include Files

mkl.fi

Description

This routine is deprecated, but no replacement is available yet in the Inspector-Executor Sparse BLAS API interfaces. You can continue using this routine until a replacement is provided and this can be fully removed.

The mkl_?diamv 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 stored in the diagonal format, A^T is the transpose of A.

NOTE:

This routine supports only one-based indexing of the input arrays.

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

DOUBLE PRECISION for mkl_ddiamv.

COMPLEX for mkl_cdiamv.

DOUBLE COMPLEX for mkl_zdiamv.

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

DOUBLE PRECISION for mkl_ddiamv.

COMPLEX for mkl_cdiamv.

DOUBLE COMPLEX for mkl_zdiamv.

Two-dimensional array of size lval by ndiag, contains non-zero diagonals of the matrix A. Refer to values array description in Diagonal Storage Scheme for more details.

lval

INTEGER. Leading dimension of val, lval≥m. Refer to lval description in Diagonal Storage Scheme for more details.

idiag

INTEGER. Array of length ndiag, contains the distances between main diagonal and each non-zero diagonals in the matrix A.

Refer to distance array description in Diagonal Storage Scheme for more details.

ndiag

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

x

REAL for mkl_sdiamv.

DOUBLE PRECISION for mkl_ddiamv.

COMPLEX for mkl_cdiamv.

DOUBLE COMPLEX for mkl_zdiamv.

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

DOUBLE PRECISION for mkl_ddiamv.

COMPLEX for mkl_cdiamv.

DOUBLE COMPLEX for mkl_zdiamv.

Specifies the scalar beta.

y

REAL for mkl_sdiamv.

DOUBLE PRECISION for mkl_ddiamv.

COMPLEX for mkl_cdiamv.

DOUBLE COMPLEX for mkl_zdiamv.

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_sdiamv(transa, m, k, alpha, matdescra, val, lval, idiag,

ndiag, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lval, ndiag

  INTEGER      idiag(*)

  REAL          alpha, beta

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

SUBROUTINE mkl_ddiamv(transa, m, k, alpha, matdescra, val, lval, idiag,

ndiag, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lval, ndiag

  INTEGER      idiag(*)

  DOUBLE PRECISION          alpha, beta

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

SUBROUTINE mkl_cdiamv(transa, m, k, alpha, matdescra, val, lval, idiag,

ndiag, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lval, ndiag

  INTEGER      idiag(*)

  COMPLEX          alpha, beta

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

SUBROUTINE mkl_zdiamv(transa, m, k, alpha, matdescra, val, lval, idiag,

ndiag, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lval, ndiag

  INTEGER      idiag(*)

  DOUBLE COMPLEX          alpha, beta

  DOUBLE COMPLEX          val(lval,*), 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_?diamv

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: