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

Triangular solvers with simplified interface for a sparse matrix in the diagonal format with one-based indexing (deprecated).

Syntax

call mkl_sdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)

call mkl_ddiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)

call mkl_cdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)

call mkl_zdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)

Include Files

  • mkl.fi

Description

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

The mkl_?diatrsv routine solves a system of linear equations with matrix-vector operations for a sparse matrix stored in the diagonal format:

A*y = x

or

AT*y = x,

where:

x and y are vectors,

A is a sparse upper or lower triangular matrix with unit or non-unit main diagonal, 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.

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.

transa

CHARACTER*1. Specifies the system of linear equations.

If transa = 'N' or 'n', then A*y = x

If transa = 'T' or 't' or 'C' or 'c', then AT*y = x,

diag

CHARACTER*1. Specifies whether A is unit triangular.

If diag = 'U' or 'u', then A is unit triangular.

If diag = 'N' or 'n', then A is not unit triangular.

m

INTEGER. Number of rows of the matrix A.

val

REAL for mkl_sdiatrsv.

DOUBLE PRECISION for mkl_ddiatrsv.

COMPLEX for mkl_cdiatrsv.

DOUBLE COMPLEX for mkl_zdiatrsv.

Two-dimensional array of size lval by ndiag, contains non-zero diagonals of the matrix A. Refer to values array description in Diagonal Storage Scheme for more details.

lval

INTEGER. Leading dimension of val, lvalm. Refer to lval description in Diagonal Storage Scheme for more details.

idiag

INTEGER. Array of length ndiag, contains the distances between main diagonal and each non-zero diagonals in the matrix A.

NOTE:

All elements of this array must be sorted in increasing order.

Refer to distance array description in Diagonal Storage Scheme for more details.

ndiag

INTEGER. Specifies the number of non-zero diagonals of the matrix A.

x

REAL for mkl_sdiatrsv.

DOUBLE PRECISION for mkl_ddiatrsv.

COMPLEX for mkl_cdiatrsv.

DOUBLE COMPLEX for mkl_zdiatrsv.

Array, size is m.

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

Output Parameters

y

REAL for mkl_sdiatrsv.

DOUBLE PRECISION for mkl_ddiatrsv.

COMPLEX for mkl_cdiatrsv.

DOUBLE COMPLEX for mkl_zdiatrsv.

Array, size at least m.

Contains the vector y.

Interfaces

FORTRAN 77:

SUBROUTINE mkl_sdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)
  CHARACTER*1   uplo, transa, diag
  INTEGER       m, lval, ndiag
  INTEGER       indiag(*)
  REAL            val(lval,*), x(*), y(*)

SUBROUTINE mkl_ddiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)
  CHARACTER*1   uplo, transa, diag
  INTEGER       m, lval, ndiag
  INTEGER       indiag(*)
  DOUBLE PRECISION       val(lval,*), x(*), y(*)

SUBROUTINE mkl_cdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)
  CHARACTER*1   uplo, transa, diag
  INTEGER       m, lval, ndiag
  INTEGER       indiag(*)
  COMPLEX     val(lval,*), x(*), y(*)

SUBROUTINE mkl_zdiatrsv(uplo, transa, diag, m, val, lval, idiag, ndiag, x, y)
  CHARACTER*1   uplo, transa, diag
  INTEGER       m, lval, ndiag
  INTEGER       indiag(*)
  DOUBLE COMPLEX        val(lval,*), x(*), y(*)