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

Computes matrix-matrix product of a sparse matrix stored in the CSC format (deprecated).

Syntax

call mkl_scscmm(transa, m, n, k, alpha, matdescra, val, indx, pntrb, pntre, b, ldb, beta, c, ldc)

call mkl_dcscmm(transa, m, n, k, alpha, matdescra, val, indx, pntrb, pntre, b, ldb, beta, c, ldc)

call mkl_ccscmm(transa, m, n, k, alpha, matdescra, val, indx, pntrb, pntre, b, ldb, beta, c, ldc)

call mkl_zcscmm(transa, m, n, k, alpha, matdescra, val, indx, pntrb, pntre, b, ldb, beta, c, ldc)

Include Files

  • mkl.fi

Description

This routine is deprecated. Use Use mkl_sparse_?_mmfrom the Intel® oneAPI Math Kernel Library (oneMKL) Inspector-executor Sparse BLAS interface instead.

The mkl_?cscmm 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 compressed sparse column (CSC) format, AT is the transpose of A, and AH is the conjugate 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 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_scscmm.

DOUBLE PRECISION for mkl_dcscmm.

COMPLEX for mkl_ccscmm.

DOUBLE COMPLEX for mkl_zcscmm.

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

DOUBLE PRECISION for mkl_dcscmm.

COMPLEX for mkl_ccscmm.

DOUBLE COMPLEX for mkl_zcscmm.

Array containing non-zero elements of the matrix A.

For one-based indexing its length is pntrb(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.

b

REAL for mkl_scscmm.

DOUBLE PRECISION for mkl_dcscmm.

COMPLEX for mkl_ccscmm.

DOUBLE COMPLEX for mkl_zcscmm.

Array, size ldb by at least n for non-transposed matrix A and at least m for transposed for one-based indexing, and (at least k for non-transposed matrix A and at least m for transposed, ldb) for zero-based indexing.

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 for one-based indexing, and the second dimension of b for zero-based indexing, as declared in the calling (sub)program.

beta

REAL*8. Specifies the scalar beta.

c

REAL for mkl_scscmm.

DOUBLE PRECISION for mkl_dcscmm.

COMPLEX for mkl_ccscmm.

DOUBLE COMPLEX for mkl_zcscmm.

Array, size ldc by n for one-based indexing, and (m, ldc) for zero-based indexing.

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 for one-based indexing, and the second dimension of c for zero-based indexing, as declared in the calling (sub)program.

Output Parameters

c

Overwritten by the matrix (alpha*A*B + beta* C) or (alpha*AT*B + beta*C) or (alpha*AH*B + beta*C).

Interfaces

FORTRAN 77:

SUBROUTINE mkl_scscmm(transa, m, n, k, alpha, matdescra, val, indx,
 pntrb, pntre, b, ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       indx(*), pntrb(k), pntre(k)
  REAL          alpha, beta
  REAL          val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_dcscmm(transa, m, n, k, alpha, matdescra, val, indx,
 pntrb, pntre, b, ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       indx(*), pntrb(k), pntre(k)
  DOUBLE PRECISION        alpha, beta
  DOUBLE PRECISION        val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_ccscmm(transa, m, n, k, alpha, matdescra, val, indx,
 pntrb, pntre, b, ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       indx(*), pntrb(k), pntre(k)
  COMPLEX        alpha, beta
  COMPLEX        val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_zcscmm(transa, m, n, k, alpha, matdescra, val, indx,
 pntrb, pntre, b, ldb, beta, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, k, ldb, ldc
  INTEGER       indx(*), pntrb(k), pntre(k)
  DOUBLE COMPLEX        alpha, beta
  DOUBLE COMPLEX        val(*), b(ldb,*), c(ldc,*)