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

Computes matrix-matrix product of a sparse matrix stored using the skyline storage scheme with one-based indexing (deprecated).

Syntax

call mkl_sskymm(transa, m, n, k, alpha, matdescra, val, pntr, b, ldb, beta, c, ldc)

call mkl_dskymm(transa, m, n, k, alpha, matdescra, val, pntr, b, ldb, beta, c, ldc)

call mkl_cskymm(transa, m, n, k, alpha, matdescra, val, pntr, b, ldb, beta, c, ldc)

call mkl_zskymm(transa, m, n, k, alpha, matdescra, val, pntr, 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_?skymm routine performs a matrix-matrix operation defined as

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

or

C := alpha*AT*B + beta*C,

or

C := alpha*AH*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 skyline storage format, AT is the transpose of A, and AH 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*AT*B + beta*C,

If transa = 'C' or 'c', then C := alpha*AH*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_sskymm.

DOUBLE PRECISION for mkl_dskymm.

COMPLEX for mkl_cskymm.

DOUBLE COMPLEX for mkl_zskymm.

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.

NOTE:

General matrices (matdescra (1)='G') is not supported.

val

REAL for mkl_sskymm.

DOUBLE PRECISION for mkl_dskymm.

COMPLEX for mkl_cskymm.

DOUBLE COMPLEX for mkl_zskymm.

Array containing the set of elements of the matrix A in the skyline profile form.

If matdescrsa(2)= 'L', then val contains elements from the low triangle of the matrix A.

If matdescrsa(2)= 'U', then val contains elements from the upper triangle of the matrix A.

Refer to values array description in Skyline Storage Scheme for more details.

pntr

INTEGER. Array of length (m + 1) for lower triangle, and (k + 1) for upper triangle.

It contains the indices specifying the positions of the first element of the matrix A in each row (for the lower triangle) or column (for upper triangle) in the val array. Refer to pointers array description in Skyline Storage Scheme for more details.

b

REAL for mkl_sskymm.

DOUBLE PRECISION for mkl_dskymm.

COMPLEX for mkl_cskymm.

DOUBLE COMPLEX for mkl_zskymm.

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

DOUBLE PRECISION for mkl_dskymm.

COMPLEX for mkl_cskymm.

DOUBLE COMPLEX for mkl_zskymm.

Specifies the scalar beta.

c

REAL for mkl_sskymm.

DOUBLE PRECISION for mkl_dskymm.

COMPLEX for mkl_cskymm.

DOUBLE COMPLEX for mkl_zskymm.

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*AT*B + beta*C), or (alpha*AH*B + beta*C).

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sskymm(transa, m, n, k, alpha, matdescra, val, pntr, b,
 ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       pntr(*)
  REAL          alpha, beta
  REAL          val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_dskymm(transa, m, n, k, alpha, matdescra, val, pntr, b,
 ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       pntr(*)
  DOUBLE PRECISION        alpha, beta
  DOUBLE PRECISION        val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_cskymm(transa, m, n, k, alpha, matdescra, val, pntr, b,
 ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       pntr(*)
  COMPLEX        alpha, beta
  COMPLEX        val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_zskymm(transa, m, n, k, alpha, matdescra, val, pntr, b,
 ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       pntr(*)
  DOUBLE COMPLEX        alpha, beta
  DOUBLE COMPLEX        val(*), b(ldb,*), c(ldc,*)