mkl_?diamm

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-5B40BBEC-E095-4151-A5E1-11CDBB494A2E

View Details

mkl_?diamm

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

Syntax

call mkl_sdiamm(transa, m, n, k, alpha, matdescra, val, lval, idiag, ndiag, b, ldb, beta, c, ldc)

call mkl_ddiamm(transa, m, n, k, alpha, matdescra, val, lval, idiag, ndiag, b, ldb, beta, c, ldc)

call mkl_cdiamm(transa, m, n, k, alpha, matdescra, val, lval, idiag, ndiag, b, ldb, beta, c, ldc)

call mkl_zdiamm(transa, m, n, k, alpha, matdescra, val, lval, idiag, ndiag, b, ldb, beta, c, ldc)

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_?diamm routine performs a matrix-matrix operation defined as

C := alpha*A*B + beta*C

C := alpha*A^T*B + beta*C,

C := alpha*A^H*B + beta*C,

where:

alpha and beta are scalars,

B and C are dense matrices, A is an m-by-k sparse matrix in the diagonal format, A^T is the transpose of A, and A^H is the conjugate 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 C := alpha*A*B + beta*C,

If transa = 'T' or 't', then C := alpha*A^T*B + beta*C,

If transa = 'C' or 'c', then C := alpha*A^H*B + beta*C.

m

INTEGER. Number of rows of the matrix A.

n

INTEGER. Number of columns of the matrix C.

k

INTEGER. Number of columns of the matrix A.

alpha

REAL for mkl_sdiamm.

DOUBLE PRECISION for mkl_ddiamm.

COMPLEX for mkl_cdiamm.

DOUBLE COMPLEX for mkl_zdiamm.

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

DOUBLE PRECISION for mkl_ddiamm.

COMPLEX for mkl_cdiamm.

DOUBLE COMPLEX for mkl_zdiamm.

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.

b

REAL for mkl_sdiamm.

DOUBLE PRECISION for mkl_ddiamm.

COMPLEX for mkl_cdiamm.

DOUBLE COMPLEX for mkl_zdiamm.

Array, size (ldb, n).

On entry with transa = 'N' or 'n', the leading k-by-n part of the array b must contain the matrix B, otherwise the leading m-by-n part of the array b must contain the matrix B.

ldb

INTEGER. Specifies the leading dimension of b as declared in the calling (sub)program.

beta

REAL for mkl_sdiamm.

DOUBLE PRECISION for mkl_ddiamm.

COMPLEX for mkl_cdiamm.

DOUBLE COMPLEX for mkl_zdiamm.

Specifies the scalar beta.

c

REAL for mkl_sdiamm.

DOUBLE PRECISION for mkl_ddiamm.

COMPLEX for mkl_cdiamm.

DOUBLE COMPLEX for mkl_zdiamm.

Array, size ldc by n.

On entry, the leading m-by-n part of the array c must contain the matrix C, otherwise the leading k-by-n part of the array c must contain the matrix C.

ldc

INTEGER. Specifies the leading dimension of c as declared in the calling (sub)program.

Output Parameters

c: Overwritten by the matrix (alpha*A*B + beta*C), (alpha*A^T*B + beta*C), or (alpha*A^H*B + beta*C).

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sdiamm(transa, m, n, k, alpha, matdescra, val, lval,

 idiag, ndiag, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, lval, ndiag

  INTEGER      idiag(*)

  REAL          alpha, beta

  REAL          val(lval,*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_ddiamm(transa, m, n, k, alpha, matdescra, val, lval,

 idiag, ndiag, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, lval, ndiag

  INTEGER      idiag(*)

  DOUBLE PRECISION        alpha, beta

  DOUBLE PRECISION        val(lval,*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_cdiamm(transa, m, n, k, alpha, matdescra, val, lval,

 idiag, ndiag, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, lval, ndiag

  INTEGER      idiag(*)

  COMPLEX        alpha, beta

  COMPLEX        val(lval,*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_zdiamm(transa, m, n, k, alpha, matdescra, val, lval,

 idiag, ndiag, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, lval, ndiag

  INTEGER      idiag(*)

  DOUBLE COMPLEX        alpha, beta

  DOUBLE COMPLEX        val(lval,*), b(ldb,*), c(ldc,*)

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_?diamm

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: