mkl_?bsrmm

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-6A68573C-B953-475A-84B6-51EAF180DFFA

View Details

mkl_?bsrmm

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

Syntax

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

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

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

call mkl_zbsrmm(transa, m, n, k, lb, 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_?bsrmm 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 block sparse row (BSR) format, A^T is the transpose of A, and A^H is the conjugate transpose of A.

NOTE:

This routine supports a BSR 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 the matrix-matrix product is computed as C := alpha*A*B + beta*C

If transa = 'T' or 't', then the matrix-vector product is computed as C := alpha*A^T*B + beta*C

If transa = 'C' or 'c', then the matrix-vector product is computed as C := alpha*A^H*B + beta*C,

m

INTEGER. Number of block rows of the matrix A.

n

INTEGER. Number of columns of the matrix C.

k

INTEGER. Number of block columns of the matrix A.

lb

INTEGER. Size of the block in the matrix A.

alpha

REAL for mkl_sbsrmm.

DOUBLE PRECISION for mkl_dbsrmm.

COMPLEX for mkl_cbsrmm.

DOUBLE COMPLEX for mkl_zbsrmm.

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

DOUBLE PRECISION for mkl_dbsrmm.

COMPLEX for mkl_cbsrmm.

DOUBLE COMPLEX for mkl_zbsrmm.

Array containing elements of non-zero blocks of the matrix A. Its length is equal to the number of non-zero blocks in the matrix A multiplied by lb*lb. Refer to the values array description in BSR Format for more details.

indx

INTEGER. Array containing the column indices for each non-zero block in the matrix A.

Its length is equal to the number of non-zero blocks in the matrix A. Refer to the columns array description in BSR Format for more details.

pntrb

INTEGER. Array of length m.

For one-based indexing: this array contains row indices, such that pntrb(I) - pntrb(1) + 1 is the first index of block row I in the array indx.

For zero-based indexing: this array contains row indices, such that pntrb(I) - pntrb(0) is the first index of block row I in the array indx.

Refer to pointerB array description in BSR Format for more details.

pntre

INTEGER. Array of length m.

For one-based indexing this array contains row indices, such that pntre(I) - pntrb(1) is the last index of block row I in the array indx.

For zero-based indexing this array contains row indices, such that pntre(I) - pntrb(0) - 1 is the last index of block row I in the array indx.

Refer to pointerE array description in BSR Format for more details.

b

REAL for mkl_sbsrmm.

DOUBLE PRECISION for mkl_dbsrmm.

COMPLEX for mkl_cbsrmm.

DOUBLE COMPLEX for mkl_zbsrmm.

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 n-by-k block part of the array b must contain the matrix B, otherwise the leading m-by-n block part of the array b must contain the matrix B.

ldb

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

beta

REAL for mkl_sbsrmm.

DOUBLE PRECISION for mkl_dbsrmm.

COMPLEX for mkl_cbsrmm.

DOUBLE COMPLEX for mkl_zbsrmm.

Specifies the scalar beta.

c

REAL for mkl_sbsrmm.

DOUBLE PRECISION for mkl_dbsrmm.

COMPLEX for mkl_cbsrmm.

DOUBLE COMPLEX for mkl_zbsrmm.

Array, size (ldc, n) for one-based indexing, size (k, ldc) for zero-based indexing.

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

ldc

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

Output Parameters

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

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sbsrmm(transa, m, n, k, lb, alpha, matdescra, val,

 indx, pntrb, pntre, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ld, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  REAL          alpha, beta

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

SUBROUTINE mkl_dbsrmm(transa, m, n, k, lb, alpha, matdescra, val,

 indx, pntrb, pntre, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ld, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  DOUBLE PRECISION        alpha, beta

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

SUBROUTINE mkl_cbsrmm(transa, m, n, k, lb, alpha, matdescra, val,

 indx, pntrb, pntre, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ld, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

  COMPLEX        alpha, beta

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

SUBROUTINE mkl_zbsrmm(transa, m, n, k, lb, alpha, matdescra, val,

 indx, pntrb, pntre, b, ldb, beta, c, ldc)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, n, k, ld, ldb, ldc

  INTEGER       indx(*), pntrb(m), pntre(m)

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

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: