mkl_?gemm_compact

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 11/07/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-ECB906DD-9C94-4375-AA6A-BBEC987AE724

View Details

mkl_?gemm_compact

Computes a matrix-matrix product of a set of compact format general matrices.

Syntax

void mkl_sgemm_compact (MKL_LAYOUT layout, MKL_TRANSPOSE transa, MKL_TRANSPOSE transb, MKL_INT m, MKL_INT n, MKL_INT k, float alpha, const float *ap, MKL_INT ldap, const float *bp, MKL_INT ldbp, float beta, float *cp, MKL_INT ldcp, MKL_COMPACT_PACK format, MKL_INT nm);

void mkl_dgemm_compact (MKL_LAYOUT layout, MKL_TRANSPOSE transa, MKL_TRANSPOSE transb, MKL_INT m, MKL_INT n, MKL_INT k, double alpha, const double *ap, MKL_INT ldap, const double *bp, MKL_INT ldbp, double beta, double *cp, MKL_INT ldcp, MKL_COMPACT_PACK format, MKL_INT nm);

void mkl_cgemm_compact (MKL_LAYOUT layout, MKL_TRANSPOSE transa, MKL_TRANSPOSE transb, MKL_INT m, MKL_INT n, MKL_INT k, mkl_compact_complex_float *alpha, const float *ap, MKL_INT ldap, const float *bp, MKL_INT ldbp, mkl_compact_complex_float *beta, float *cp, MKL_INT ldcp, MKL_COMPACT_PACK format, MKL_INT nm);

void mkl_zgemm_compact (MKL_LAYOUT layout, MKL_TRANSPOSE transa, MKL_TRANSPOSE transb, MKL_INT m, MKL_INT n, MKL_INT k, mkl_compact_complex_double *alpha, const double *ap, MKL_INT ldap, const double *bp, MKL_INT ldbp, mkl_compact_complex_double *beta, double *cp, MKL_INT ldcp, MKL_COMPACT_PACK format, MKL_INT nm);

Description

The mkl_?gemm_compact routine computes a scalar-matrix-matrix product and adds the result to a scalar-matrix product for a group of nm general matrices A_c that have been stored in compact format. The operation is defined for each matrix as:

C_c := alpha*op(A_c)*op(B_c) + beta*C_c

Where

op(X_c) is one of op(X_c) = X_c, or op(X_c) = X_c^T, or op(X_c) = X_c^H,
alpha and beta are scalars,
A_c, B_c, and C_c are matrices that have been stored in compact format,
op(A_c) is an m-by-k matrix for each matrix in the group,
op(B_c) is a k-by-n matrix for each matrix in the group,
and C_c is an m-by-n matrix.

Input Parameters

layout

Specifies whether two-dimensional array storage is row-major (MKL_ROW_MAJOR) or column-major (MKL_COL_MAJOR).

transa

Specifies the operation:

If transa=MKL_NOTRANS, then op(A_c):=A_c.

If transa=MKL_TRANS, then op(A_c):=A_c^T.

If transa=MKL_CONJTRANS, then op(A_c):=A_c^H.

transb

Specifies the operation:

If transb=MKL_NOTRANS, then op(B_c):=B_c.

If transb=MKL_TRANS, then op(B_c):=B_c^T.

If transb=MKL_CONJTRANS, then op(B_c):=B_c^H.

m

The number of rows of the matrices op(A_c), m >= 0.

n

The number of columns of matrices op(B_c) and C_c. n≥0.

k

The number of columns of matrices op(A_c) and the number of rows of matrices op(B_c). k≥0.

alpha

Specifies the scalar alpha.

ap

Points to the beginning of the array that stores the nmA_c matrices. See Compact Format for more details.

	transa=MKL_NOTRANS	transa=MKL_TRANS or transa=MKL_CONJTRANS
layout = MKL_COL_MAJOR	ap has size ldapknm.	ap has size ldapmnm.
layout = MKL_ROW_MAJOR	ap has size ldapmnm.	ap has size ldapknm.

ldap

Specifies the leading dimension of A_c.

bp

Points to the beginning of the array that stores the nmB_c matrices. See Compact Format for more details.

	transb=MKL_NOTRANS	transb=MKL_TRANS or transb=MKL_CONJTRANS
layout = MKL_COL_MAJOR	bp has size ldbpnnm.	bp has size ldbpknm.
layout = MKL_ROW_MAJOR	bp has size ldbpknm.	bp has size ldbpnnm.

ldbp

Specifies the leading dimension of B_c.

beta

Specifies the scalar beta.

cp

Before entry, cp points to the beginning of the array that stores the nmC_c matrices, except when beta is equal to zero, in which case cp need not be set on entry.

layout = MKL_COL_MAJOR	cp has size ldapnnm.
layout = MKL_ROW_MAJOR	cp has size ldapmnm.

ldcp

Specifies the leading dimension of C_c.

layout = MKL_COL_MAJOR	ldcp must be at least max (1,m).
layout = MKL_ROW_MAJOR	ldcp must be at least max (1,n).

format

Specifies the format of the compact matrices. See Compact Format or mkl_get_format_compact for details.

nm

Total number of matrices stored in compact format in the group of matrices.

NOTE:

The values of ldap, ldbp, and ldcp used in mkl_?gemm_compact must be consistent with the values used in mkl_?get_size_compact, mkl_?gepack_compact, and mkl_?geunpack_compact.

Output Parameters

cp: Each matrix C_c is overwritten by the m-by-n matrix (alpha*op(A_c)*op(B_c) + beta*C_c).

Parent topic: Compact BLAS and LAPACK Functions

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

Syntax

Description

Input Parameters

Output Parameters