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_cspblas_?bsrsymv

Computes matrix-vector product of a sparse symmetrical matrix stored in the BSR format (3-arrays variation) with zero-based indexing (deprecated).

Syntax

call mkl_cspblas_sbsrsymv(uplo, m, lb, a, ia, ja, x, y)

call mkl_cspblas_dbsrsymv(uplo, m, lb, a, ia, ja, x, y)

call mkl_cspblas_cbsrsymv(uplo, m, lb, a, ia, ja, x, y)

call mkl_cspblas_zbsrsymv(uplo, 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_cspblas_?bsrsymv routine performs a matrix-vector operation defined as

y := A*x

where:

x and y are vectors,

A is an upper or lower triangle of the symmetrical sparse matrix in the BSR format (3-array variation) with zero-based indexing.

NOTE:

This routine supports only zero-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.

 

uplo

CHARACTER*1. Specifies whether the upper or low triangle of the matrix A is used.

If uplo = 'U' or 'u', then the upper triangle of the matrix A is used.

If uplo = 'L' or 'l', then the low triangle of the matrix A is used.

m

INTEGER. Number of block rows of the matrix A.

lb

INTEGER. Size of the block in the matrix A.

a

REAL for mkl_cspblas_sbsrsymv.

DOUBLE PRECISION for mkl_cspblas_dbsrsymv.

COMPLEX for mkl_cspblas_cbsrsymv.

DOUBLE COMPLEX for mkl_cspblas_zbsrsymv.

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

DOUBLE PRECISION for mkl_cspblas_dbsrsymv.

COMPLEX for mkl_cspblas_cbsrsymv.

DOUBLE COMPLEX for mkl_cspblas_zbsrsymv.

Array, size (m*lb).

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

Output Parameters

y

REAL for mkl_cspblas_sbsrsymv.

DOUBLE PRECISION for mkl_cspblas_dbsrsymv.

COMPLEX for mkl_cspblas_cbsrsymv.

DOUBLE COMPLEX for mkl_cspblas_zbsrsymv.

Array, size at least (m*lb).

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

Interfaces

FORTRAN 77:

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

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

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

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