mkl_?bsrmv

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

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-6EB940C2-04B7-409A-8709-AE34E53BE18C

View Details

mkl_?bsrmv

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

Syntax

call mkl_sbsrmv(transa, m, k, lb, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_dbsrmv(transa, m, k, lb, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_cbsrmv(transa, m, k, lb, alpha, matdescra, val, indx, pntrb, pntre, x, beta, y)

call mkl_zbsrmv(transa, m, k, lb, alpha, matdescra, val, indx, pntrb, pntre, x, beta, 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_?bsrmv routine performs a matrix-vector operation defined as

y := alpha*A*x + beta*y

y := alpha*A^T*x + beta*y,

where:

alpha and beta are scalars,

x and y are vectors,

A is an m-by-k block sparse matrix in the BSR format, 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

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 := alpha*A*x + beta*y

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

m

INTEGER. Number of block rows of the matrix A.

k

INTEGER. Number of block columns of the matrix A.

lb

INTEGER. Size of the block in the matrix A.

alpha

REAL for mkl_sbsrmv.

DOUBLE PRECISION for mkl_dbsrmv.

COMPLEX for mkl_cbsrmv.

DOUBLE COMPLEX for mkl_zbsrmv.

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

DOUBLE PRECISION for mkl_dbsrmv.

COMPLEX for mkl_cbsrmv.

DOUBLE COMPLEX for mkl_zbsrmv.

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.

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

x

REAL for mkl_sbsrmv.

DOUBLE PRECISION for mkl_dbsrmv.

COMPLEX for mkl_cbsrmv.

DOUBLE COMPLEX for mkl_zbsrmv.

Array, size at least (k*lb) if transa = 'N' or 'n', and at least (m*lb) otherwise. On entry, the array x must contain the vector x.

beta

REAL for mkl_sbsrmv.

DOUBLE PRECISION for mkl_dbsrmv.

COMPLEX for mkl_cbsrmv.

DOUBLE COMPLEX for mkl_zbsrmv.

Specifies the scalar beta.

y

REAL for mkl_sbsrmv.

DOUBLE PRECISION for mkl_dbsrmv.

COMPLEX for mkl_cbsrmv.

DOUBLE COMPLEX for mkl_zbsrmv.

Array, size at least (m*lb) if transa = 'N' or 'n', and at least (k*lb) otherwise. On entry, the array y must contain the vector y.

Output Parameters

y: Overwritten by the updated vector y.

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sbsrmv(transa, m, k, lb, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lb

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

  REAL          alpha, beta

  REAL          val(*), x(*), y(*)

SUBROUTINE mkl_dbsrmv(transa, m, k, lb, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lb

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

  DOUBLE PRECISION        alpha, beta

  DOUBLE PRECISION        val(*), x(*), y(*)

SUBROUTINE mkl_cbsrmv(transa, m, k, lb, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lb

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

  COMPLEX        alpha, beta

  COMPLEX        val(*), x(*), y(*)

SUBROUTINE mkl_zbsrmv(transa, m, k, lb, alpha, matdescra, val, indx,

 pntrb, pntre, x, beta, y)

  CHARACTER*1   transa

  CHARACTER     matdescra(*)

  INTEGER       m, k, lb

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

  DOUBLE COMPLEX        alpha, beta

  DOUBLE COMPLEX        val(*), x(*), y(*)

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

Syntax

Include Files

Description

Input Parameters

Output Parameters

Interfaces

FORTRAN 77: