Naming Conventions in Sparse BLAS Level 2 and Level 3

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-68706DC5-8ED9-46F3-9E74-BFBC3E7A06A6

Each Sparse BLAS Level 2 and Level 3 routine has a six- or eight-character base name preceded by the prefix mkl_ or mkl_cspblas_ .

The routines with typical (conventional) interface have six-character base names in accordance with the template:

mkl_<character > <data> <operation>( )

The routines with simplified interfaces have eight-character base names in accordance with the templates:

mkl_<character > <data> <mtype> <operation>( )

for routines with one-based indexing; and

mkl_cspblas_<character> <data>  <mtype> <operation>( )

for routines with zero-based indexing.

The <character> field indicates the data type:

The <data> field indicates the sparse matrix storage format (see section Sparse Matrix Storage Formats):

The <operation> field indicates the type of operation:

The field <mtype> indicates the matrix type:

ge: sparse representation of a general matrix
sy: sparse representation of the upper or lower triangle of a symmetric matrix
tr: sparse representation of a triangular matrix

Parent topic: Sparse BLAS Level 2 and Level 3 Routines