mkl_?coomm

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 7/13/2023

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-E501A66C-9833-4A19-8808-9D749D7DFB6C

View Details

mkl_?coomm

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

Syntax

call mkl_scoomm(transa, m, n, k, alpha, matdescra, val, rowind, colind, nnz, b, ldb, beta, c, ldc)

call mkl_dcoomm(transa, m, n, k, alpha, matdescra, val, rowind, colind, nnz, b, ldb, beta, c, ldc)

call mkl_ccoomm(transa, m, n, k, alpha, matdescra, val, rowind, colind, nnz, b, ldb, beta, c, ldc)

call mkl_zcoomm(transa, m, n, k, alpha, matdescra, val, rowind, colind, nnz, 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_?coomm 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 coordinate format, A^T is the transpose of A, and A^H is the conjugate 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 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_scoomm.

DOUBLE PRECISION for mkl_dcoomm.

COMPLEX for mkl_ccoomm.

DOUBLE COMPLEX for mkl_zcoomm.

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

DOUBLE PRECISION for mkl_dcoomm.

COMPLEX for mkl_ccoomm.

DOUBLE COMPLEX for mkl_zcoomm.

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.

b

REAL for mkl_scoomm.

DOUBLE PRECISION for mkl_dcoomm.

COMPLEX for mkl_ccoomm.

DOUBLE COMPLEX for mkl_zcoomm.

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 for mkl_scoomm.

DOUBLE PRECISION for mkl_dcoomm.

COMPLEX for mkl_ccoomm.

DOUBLE COMPLEX for mkl_zcoomm.

Specifies the scalar beta.

c

REAL for mkl_scoomm.

DOUBLE PRECISION for mkl_dcoomm.

COMPLEX for mkl_ccoomm.

DOUBLE COMPLEX for mkl_zcoomm.

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), (alpha*A^T*B + beta*C), or (alpha*A^H*B + beta*C).

Interfaces

FORTRAN 77:

SUBROUTINE mkl_scoomm(transa, m, n, k, alpha, matdescra, val,

 rowind, colind, nnz, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, nnz

  INTEGER       rowind(*), colind(*)

  REAL          alpha, beta

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

SUBROUTINE mkl_dcoomm(transa, m, n, k, alpha, matdescra, val,

 rowind, colind, nnz, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, nnz

  INTEGER       rowind(*), colind(*)

  DOUBLE PRECISION        alpha, beta

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

SUBROUTINE mkl_ccoomm(transa, m, n, k, alpha, matdescra, val,

 rowind, colind, nnz, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, nnz

  INTEGER       rowind(*), colind(*)

  COMPLEX        alpha, beta

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

SUBROUTINE mkl_zcoomm(transa, m, n, k, alpha, matdescra, val,

 rowind, colind, nnz, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ldb, ldc, nnz

  INTEGER       rowind(*), colind(*)

  DOUBLE COMPLEX        alpha, beta

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

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: