Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

mkl_?bsrgemv

Computes matrix - vector product of a sparse general matrix stored in the BSR format (3-array variation) with one-based indexing (deprecated).

Syntax

call mkl_sbsrgemv(transa, m, lb, a, ia, ja, x, y)

call mkl_dbsrgemv(transa, m, lb, a, ia, ja, x, y)

call mkl_cbsrgemv(transa, m, lb, a, ia, ja, x, y)

call mkl_zbsrgemv(transa, m, lb, a, ia, ja, x, y)

Include Files

  • mkl.fi

Description

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

The mkl_?bsrgemv routine performs a matrix-vector operation defined as

y := A*x

or

y := AT*x,

where:

x and y are vectors,

A is an m-by-m block sparse square matrix in the BSR format (3-array variation), AT is the transpose of A.

NOTE:

This routine supports only one-based indexing of the input arrays.

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-vector product is computed as y := A*x

If transa = 'T' or 't' or 'C' or 'c', then the matrix-vector product is computed as y := AT*x,

m

INTEGER. Number of block rows of the matrix A.

lb

INTEGER. Size of the block in the matrix A.

a

REAL for mkl_sbsrgemv.

DOUBLE PRECISION for mkl_dbsrgemv.

COMPLEX for mkl_cbsrgemv.

DOUBLE COMPLEX for mkl_zbsrgemv.

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 values array description in BSR Format for more details.

ia

INTEGER. Array of length (m + 1), containing indices of block in the array a, such that ia(i) is the index in the array a of the first non-zero element from the row i. The value of the last element ia(m + 1) is equal to the number of non-zero blocks plus one. Refer to rowIndex array description in BSR Format for more details.

ja

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 of the matrix A. Refer to columns array description in BSR Format for more details.

x

REAL for mkl_sbsrgemv.

DOUBLE PRECISION for mkl_dbsrgemv.

COMPLEX for mkl_cbsrgemv.

DOUBLE COMPLEX for mkl_zbsrgemv.

Array, size (m*lb).

On entry, the array x must contain the vector x.

Output Parameters

y

REAL for mkl_sbsrgemv.

DOUBLE PRECISION for mkl_dbsrgemv.

COMPLEX for mkl_cbsrgemv.

DOUBLE COMPLEX for mkl_zbsrgemv.

Array, size at least (m*lb).

On exit, the array y must contain the vector y.

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sbsrgemv(transa, m, lb, a, ia, ja, x, y)
   CHARACTER*1  transa
   INTEGER      m, lb
   INTEGER      ia(*), ja(*)
   REAL          a(*), x(*), y(*)

SUBROUTINE mkl_dbsrgemv(transa, m, lb, a, ia, ja, x, y)
   CHARACTER*1  transa
   INTEGER      m, lb
   INTEGER      ia(*), ja(*)
   DOUBLE PRECISION     a(*), x(*), y(*)

SUBROUTINE mkl_cbsrgemv(transa, m, lb, a, ia, ja, x, y)
   CHARACTER*1  transa
   INTEGER      m, lb
   INTEGER      ia(*), ja(*)
   COMPLEX       a(*), x(*), y(*)

SUBROUTINE mkl_zbsrgemv(transa, m, lb, a, ia, ja, x, y)
   CHARACTER*1  transa
   INTEGER      m, lb
   INTEGER      ia(*), ja(*)
   DOUBLE COMPLEX       a(*), x(*), y(*)