mkl_?bsrmm

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

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

View Details

mkl_?bsrmm

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

Syntax

void mkl_sbsrmm (const char *transa , const MKL_INT *m , const MKL_INT *n , const MKL_INT *k , const MKL_INT *lb , const float *alpha , const char *matdescra , const float *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const float *b , const MKL_INT *ldb , const float *beta , float *c , const MKL_INT *ldc );

void mkl_dbsrmm (const char *transa , const MKL_INT *m , const MKL_INT *n , const MKL_INT *k , const MKL_INT *lb , const double *alpha , const char *matdescra , const double *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const double *b , const MKL_INT *ldb , const double *beta , double *c , const MKL_INT *ldc );

void mkl_cbsrmm (const char *transa , const MKL_INT *m , const MKL_INT *n , const MKL_INT *k , const MKL_INT *lb , const MKL_Complex8 *alpha , const char *matdescra , const MKL_Complex8 *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const MKL_Complex8 *b , const MKL_INT *ldb , const MKL_Complex8 *beta , MKL_Complex8 *c , const MKL_INT *ldc );

void mkl_zbsrmm (const char *transa , const MKL_INT *m , const MKL_INT *n , const MKL_INT *k , const MKL_INT *lb , const MKL_Complex16 *alpha , const char *matdescra , const MKL_Complex16 *val , const MKL_INT *indx , const MKL_INT *pntrb , const MKL_INT *pntre , const MKL_Complex16 *b , const MKL_INT *ldb , const MKL_Complex16 *beta , MKL_Complex16 *c , const MKL_INT *ldc );

Include Files

mkl.h

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

transa

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

Number of block rows of the matrix A.

n

Number of columns of the matrix C.

k

Number of block columns of the matrix A.

lb

Size of the block in the matrix A.

alpha

Specifies the scalar alpha.

matdescra

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

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

For one-based indexing, array containing the column indices plus one for each non-zero block in the matrix A.

For zero-based indexing, 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

Array of length m.

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

Array of length m.

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

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

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

beta

Specifies the scalar beta.

c

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

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

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 C

mkl_?bsrmm

Syntax

Include Files

Description

Input Parameters

Output Parameters