mkl_?bsrsm

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-DBC7A86E-0730-4CB4-BE40-DAEF0DDBD4D2

View Details

mkl_?bsrsm

Solves a system of linear matrix equations for a sparse matrix in the BSR format (deprecated).

Syntax

void mkl_sbsrsm (const char *transa , const MKL_INT *m , const MKL_INT *n , 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 , float *c , const MKL_INT *ldc );

void mkl_dbsrsm (const char *transa , const MKL_INT *m , const MKL_INT *n , 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 , double *c , const MKL_INT *ldc );

void mkl_cbsrsm (const char *transa , const MKL_INT *m , const MKL_INT *n , 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 , MKL_Complex8 *c , const MKL_INT *ldc );

void mkl_zbsrsm (const char *transa , const MKL_INT *m , const MKL_INT *n , 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 , MKL_Complex16 *c , const MKL_INT *ldc );

Include Files

mkl.h

Description

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

The mkl_?bsrsm routine solves a system of linear equations with matrix-matrix operations for a sparse matrix in the BSR format:

C := alpha*inv(A)*B

C := alpha*inv(A^T)*B,

where:

alpha is scalar, B and C are dense matrices, A is a sparse upper or lower triangular matrix with unit or non-unit main diagonal, A^T is the 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*inv(A)*B.

If transa = 'T' or 't' or 'C' or 'c', then the matrix-vector product is computed as C := alpha*inv(A^T)*B.

m

Number of block columns of the matrix A.

n

Number of columns of the matrix C.

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.

NOTE:

The non-zero elements of the given row of the matrix must be stored in the same order as they appear in the row (from left to right).

No diagonal element can be omitted from a sparse storage if the solver is called with the non-unit indicator.

indx

For one-based indexing, array containing the column indices plus one for each non-zero element of the matrix A. For zero-based indexing, array containing the column indices for each non-zero element of 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 arrays val and indx.

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

b

Array, size ldb* n for one-based indexing, size m* ldb for zero-based indexing.

On entry the leading m-by-n 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.

ldc

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

Output Parameters

c

Array, size ldc* n for one-based indexing, size m* ldc for zero-based indexing.

The leading m-by-n part of the array c contains the output matrix 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_?bsrsm

Syntax

Include Files

Description

Input Parameters

Output Parameters