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

Solves a system of linear matrix equations for a sparse matrix in the coordinate format (deprecated).

Syntax

call mkl_scoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)

call mkl_dcoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)

call mkl_ccoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)

call mkl_zcoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)

Include Files

  • mkl.fi

Description

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

The mkl_?coosm routine solves a system of linear equations with matrix-matrix operations for a sparse matrix in the coordinate format:

C := alpha*inv(A)*B

or

C := alpha*inv(AT)*B,

where:

alpha is scalar, B and C are dense matrices, 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 a coordinate 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 system of linear equations.

If transa = 'N' or 'n', then the matrix-matrix product is computed as C := alpha*inv(A)*B

If transa = 'T' or 't' or 'C' or 'c', then the matrix-vector product is computed as C := alpha*inv(AT)*B,

m

INTEGER. Number of rows of the matrix A.

n

INTEGER. Number of columns of the matrix C.

alpha

REAL for mkl_scoosm.

DOUBLE PRECISION for mkl_dcoosm.

COMPLEX for mkl_ccoosm.

DOUBLE COMPLEX for mkl_zcoosm.

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

DOUBLE PRECISION for mkl_dcoosm.

COMPLEX for mkl_ccoosm.

DOUBLE COMPLEX for mkl_zcoosm.

Array of length nnz, contains non-zero elements of the matrix A in the arbitrary order.

Refer to values array description in Coordinate Format for more details.

rowind

INTEGER. Array of length nnz, contains the row indices for each non-zero element of the matrix A.

Refer to rows array description in Coordinate Format for more details.

colind

INTEGER. Array of length nnz, contains the column indices for each non-zero element of the matrix A.

Refer to columns array description in Coordinate Format for more details.

nnz

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

Refer to nnz description in Coordinate Format for more details.

b

REAL for mkl_scoosm.

DOUBLE PRECISION for mkl_dcoosm.

COMPLEX for mkl_ccoosm.

DOUBLE COMPLEX for mkl_zcoosm.

Array, size ldb by n for one-based indexing, and (m, ldb) for zero-based indexing.

Before entry the leading m-by-n part of the array b must contain the matrix B.

ldb

INTEGER. Specifies the leading dimension of b for one-based indexing, and the second dimension of b for zero-based indexing, as declared in the calling (sub)program.

ldc

INTEGER. Specifies the leading dimension of c for one-based indexing, and the second dimension of c for zero-based indexing, as declared in the calling (sub)program.

Output Parameters

c

REAL for mkl_scoosm.

DOUBLE PRECISION for mkl_dcoosm.

COMPLEX for mkl_ccoosm.

DOUBLE COMPLEX for mkl_zcoosm.

Array, size ldc by n for one-based indexing, and (m, ldc) for zero-based indexing.

The leading m-by-n part of the array c contains the output matrix C.

Interfaces

FORTRAN 77:

SUBROUTINE mkl_scoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, ldb, ldc, nnz
  INTEGER       rowind(*), colind(*)
  REAL         alpha
  REAL          val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_dcoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, ldb, ldc, nnz
  INTEGER       rowind(*), colind(*)
  DOUBLE PRECISION        alpha
  DOUBLE PRECISION        val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_ccoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, ldb, ldc, nnz
  INTEGER       rowind(*), colind(*)
  COMPLEX        alpha
  COMPLEX       val(*), b(ldb,*), c(ldc,*)

SUBROUTINE mkl_zcoosm(transa, m, n, alpha, matdescra, val, rowind, colind, nnz, b, ldb, c, ldc)
  CHARACTER*1   transa
  CHARACTER     matdescra(*)
  INTEGER       m, n, ldb, ldc, nnz
  INTEGER       rowind(*), colind(*)
  DOUBLE COMPLEX        alpha
  DOUBLE COMPLEX        val(*), b(ldb,*), c(ldc,*)