Developer Reference

Intel® oneAPI Math Kernel Library LAPACK Examples

Download PDF
ID 766877
Date 12/20/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel® oneAPI Math Kernel Library LAPACK Examples
Intel® oneAPI Math Kernel Library LAPACK Examples x
Legal Information Intel® oneAPI Math Kernel Library LAPACK Examples LAPACK Examples LAPACK Routines: Linear Equations Least Squares and Eigenvalue Problems
Intel® oneAPI Math Kernel Library LAPACK Examples x
What's New Notational Conventions C Interface Conventions Function Types Mapping FORTRAN Data Types against C Data Types C Types Complex Types Matrix Layout Matrix Ordering Error Codes Function Prototypes Compiling and Running Examples Compiling and Building Fortran Examples Compiling and Building C Examples Getting Help and Support
LAPACK Routines: Linear Equations x
?gesv function ?posv function ?sysv function ?hesv function
?gesv function x
CGESV Example DGESV Example SGESV Example ZGESV Example
CGESV Example x
CGESV Example Program in Fortran CGESV Example Program in C LAPACKE_cgesv Example Program in C for Row Major Data Layout LAPACKE_cgesv Example Program in C for Column Major Data Layout
DGESV Example x
DGESV Example Program in Fortran DGESV Example Program in C LAPACK_dgesv Example Program in C for Row Major Data Layout LAPACKE_dgesv Example Program in C for Column Major Data Layout
SGESV Example x
SGESV Example Program in Fortran SGESV Example Program in C LAPACK_sgesv Example Program in C for Row Major Data Layout LAPACK_sgesv Example Program in C for Column Major Data Layout
ZGESV Example x
ZGESV Example Program in Fortran ZGESV Example Program in C LAPACKE_zgesv Example Program in C for Row Major Data Layout LAPACKE_zgesv Example Program in C for Column Major Data Layout
?posv function x
CPOSV Example DPOSV Example SPOSV Example ZPOSV Example
CPOSV Example x
CPOSV Example Program in Fortran CPOSV Example Program in C LAPACKE_cposv Example Program in C for Row Major Data Layout LAPACK_cposv Example Program in C for Column Major Data Layout
DPOSV Example x
DPOSV Example Program in Fortran DPOSV Example Program in C LAPACKE_dposv Example Program in C for Row Major Data Layout LAPACK_dposv Example Program in C for Column Major Data Layout
SPOSV Example x
SPOSV Example Program in Fortran SPOSV Example Program in C LAPACK_sposv Example Program in C for Row Major Data Layout LAPACKE_sposv Example Program in C for Column Major Data Layout
ZPOSV Example x
ZPOSV Example Program in Fortran ZPOSV Example Program in C LAPACKE_zposv Example Program in C for Row Major Data Layout LAPACK_zposv Example Program in C for Column Major Data Layout
?sysv function x
CSYSV Example DSYSV Example SSYSV Example ZSYSV Example
CSYSV Example x
CSYSV Example Program in Fortran CSYSV Example Program in C LAPACKE_csysv Example Program in C for Row Major Data Layout LAPACKE_csysv Example Program in C for Column Major Data Layout
DSYSV Example x
DSYSV Example Program in Fortran DSYSV Example Program in C LAPACKE_dsysv Example Program in C for Row Major Data Layout LAPACKE_dsysv Example Program in C for Column Major Data Layout
SSYSV Example x
SSYSV Example Program in Fortran SYSV Example Program in C LAPACKE_ssysv Example Program in C for Row Major Data Layout LAPACKE_ssysv Example Program in C for Column Major Data Layout
ZSYSV Example x
ZSYSV Example Program in Fortran ZSYSV Example Program in C LAPACKE_zsysv Example Program in C for Row Major Data Layout LAPACKE_zsysv Example Program in C for Column Major Data Layout
?hesv function x
CHESV Example ZHESV Example
CHESV Example x
CHESV Example Program in Fortran CHESV Example Program in C LAPACKE_chesv Example Program in C for Row Major Data Layout LAPACKE_chesv Example Program in C for Column Major Data Layout
ZHESV Example x
ZHESV Example Program in Fortran ZHESV Example Program in C LAPACKE_zhesv Example Program in C for Row Major Data Layout LAPACKE_zhesv Example Program in C for Column Major Data Layout
Least Squares and Eigenvalue Problems x
Linear Least Squares (LLS) Problems Symmetric Eigenproblems Nonsymmetric Eigenproblems Singular Value Decomposition
Linear Least Squares (LLS) Problems x
?gels function ?gelsd function
?gels function x
CGELS Example DGELS Example SGELS Example ZGELS Example
CGELS Example x
CGELS Example Program in Fortran CGELS Example Program in C LAPACKE_cgels Example Program in C for Row Major Data Layout LAPACKE_cgels Example Program in C for Column Major Data Layout
DGELS Example x
DGELS Example Program in Fortran DGELS Example Program in C LAPACKE_dgels Example Program in C for Row Major Data Layout LAPACKE_dgels Example Program in C for Column Major Data Layout
SGELS Example x
SGELS Example Program in Fortran SGELS Example Program in C LAPACKE_sgels Example Program in C for Row Major Data Layout LAPACKE_sgels Example Program in C for Column Major Data Layout
ZGELS Example x
ZGELS Example Program in Fortran ZGELS Example Program in C LAPACKE_zgels Example Program in C for Row Major Data Layout LAPACKE_zgels Example Program in C for Column Major Data Layout
?gelsd function x
CGELSD Example DGELSD Example SGELSD Example ZGELSD Example
CGELSD Example x
CGELSD Example Program in Fortran CGELSD Example Program in C LAPACKE_cgelsd Example Program in C for Row Major Data Layout LAPACKE_cgelsd Example Program in C for Column Major Data Layout
DGELSD Example x
DGELSD Example Program in Fortran DGELSD Example Program in C LAPACKE_dgelsd Example Program in C for Row Major Data Layout LAPACKE_dgelsd Example Program in C for Column Major Data Layout
SGELSD Example x
SGELSD Example Program in Fortran SGELSD Example Program in C LAPACKE_sgelsd Example Program in C for Row Major Data Layout LAPACKE_sgelsd Example Program in C for Column Major Data Layout
ZGELSD Example x
ZGELSD Example Program in Fortran ZGELSD Example Program in C LAPACKE_zgelsd Example Program in C for Row Major Data Layout LAPACKE_zgelsd Example Program in C for Column Major Data Layout
Symmetric Eigenproblems x
?syev function ?heev function ?syevd function ?heevd function ?syevx function ?heevx function ?syevr function ?heevr function
?syev function x
DSYEV Example SSYEV Example
DSYEV Example x
DSYEV Example Program in Fortran DSYEV Example Program in C LAPACKE_dsyev Example Program in C for Row Major Data Layout LAPACKE_dsyev Example Program in C for Column Major Data Layout
SSYEV Example x
SSYEV Example Program in Fortran SSYEV Example Program in C LAPACKE_ssyev Example Program in C for Row Major Data Layout LAPACKE_ssyev Example Program in C for Column Major Data Layout
?heev function x
CHEEV Example ZHEEV Example
CHEEV Example x
CHEEV Example Program in Fortran CHEEV Example Program in C LAPACKE_cheev Example Program in C for Row Major Data Layout LAPACKE_cheev Example Program in C for Column Major Data Layout
ZHEEV Example x
ZHEEV Example Program in Fortran ZHEEV Example Program in C LAPACKE_zheev Example Program in C for Row Major Data Layout LAPACKE_zheev Example Program in C for Column Major Data Layout
?syevd function x
DSYEVD Example SSYEVD Example
DSYEVD Example x
DSYEVD Example Program in Fortran DSYEVD Example Program in C LAPACKE_dsyevd Example Program in C for Row Major Data Layout LAPACKE_dsyevd Example Program in C for Column Major Data Layout
SSYEVD Example x
SSYEVD Example Program in Fortran SSYEVD Example Program in C LAPACKE_ssyevd Example Program in C for Row Major Data Layout LAPACKE_ssyevd Example Program in C for Column Major Data Layout
?heevd function x
CHEEVD Example ZHEEVD Example
CHEEVD Example x
CHEEVD Example Program in Fortran CHEEVD Example Program in C LAPACKE_cheevd Example Program in C for Row Major Data Layout LAPACKE_cheevd Example Program in C for Column Major Data Layout
ZHEEVD Example x
ZHEEVD Example Program in Fortran ZHEEVD Example Program in C LAPACKE_zheevd Example Program in C for Row Major Data Layout LAPACKE_zheevd Example Program in C for Column Major Data Layout
?syevx function x
DSYEVX Example SSYEVX Example
DSYEVX Example x
DSYEVX Example Program in Fortran DSYEVX Example Program in C LAPACKE_dsyevx Example Program in C for Row Major Data Layout LAPACKE_dsyevx Example Program in C for Column Major Data Layout
SSYEVX Example x
SSYEVX Example Program in Fortran SSYEVX Example Program in C LAPACKE_ssyevx Example Program in C for Row Major Data Layout LAPACKE_ssyevx Example Program in C for Column Major Data Layout
?heevx function x
CHEEVX Example ZHEEVX Example
CHEEVX Example x
CHEEVX Example Program in Fortran CHEEVX Example Program in C LAPACKE_cheevx Example Program in C for Row Major Data Layout LAPACKE_cheevx Example Program in C for Column Major Data Layout
ZHEEVX Example x
ZHEEVX Example Program in Fortran ZHEEVX Example Program in C LAPACKE_zheevx Example Program in C for Row Major Data Layout LAPACKE_zheevx Example Program in C for Column Major Data Layout
?syevr function x
DSYEVR Example SSYEVR Example
DSYEVR Example x
DSYEVR Example Program in Fortran DSYEVR Example Program in C LAPACKE_dsyevr Example Program in C for Row Major Data Layout LAPACKE_dsyevr Example Program in C for Column Major Data Layout
SSYEVR Example x
SSYEVR Example Program in Fortran SSYEVR Example Program in C LAPACKE_ssyevr Example Program in C for Row Major Data Layout LAPACKE_ssyevr Example Program in C for Column Major Data Layout
?heevr function x
CHEEVR Example ZHEEVR Example
CHEEVR Example x
CHEEVR Example Program in Fortran CHEEVR Example Program in C LAPACKE_cheevr Example Program in C for Row Major Data Layout LAPACKE_cheevr Example Program in C for Column Major Data Layout
ZHEEVR Example x
ZHEEVR Example Program in Fortran ZHEEVR Example Program in C LAPACKE_zheevr Example Program in C for Row Major Data Layout LAPACKE_zheevr Example Program in C for Column Major Data Layout
Nonsymmetric Eigenproblems x
?geev function
?geev function x
CGEEV Example DGEEV Example SGEEV Example ZGEEV Example
CGEEV Example x
CGEEV Example Program in Fortran CGEEV Example Program in C LAPACKE_cgeev Example Program in C for Row Major Data Layout LAPACKE_cgeev Example Program in C for Column Major Data Layout
DGEEV Example x
DGEEV Example Program in Fortran DGEEV Example Program in C LAPACKE_dgeev Example Program in C for Row Major Data Layout LAPACKE_dgeev Example Program in C for Column Major Data Layout
SGEEV Example x
SGEEV Example Program in Fortran SGEEV Example Program in C LAPACKE_sgeev Example Program in C for Row Major Data Layout LAPACKE_sgeev Example Program in C for Column Major Data Layout
ZGEEV Example x
ZGEEV Example Program in Fortran ZGEEV Example Program in C LAPACKE_zgeev Example Program in C for Row Major Data Layout LAPACKE_zgeev Example Program in C for Column Major Data Layout
Singular Value Decomposition x
?gesvd function ?gesdd function
?gesvd function x
CGESVD Example DGESVD Example SGESVD Example ZGESVD Example
CGESVD Example x
CGESVD Example Program in Fortran CGESVD Example Program in C LAPACKE_cgesvd Example Program in C for Row Major Data Layout LAPACKE_cgesvd Example Program in C for Column Major Data Layout
DGESVD Example x
DGESVD Example Program in Fortran DGESVD Example Program in C LAPACKE_dgesvd Example Program in C for Row Major Data Layout LAPACKE_dgesvd Example Program in C for Column Major Data Layout
SGESVD Example x
SGESVD Example Program in Fortran SGESVD Example Program in C LAPACKE_sgesvd Example Program in C for Row Major Data Layout LAPACKE_sgesvd Example Program in C for Column Major Data Layout
ZGESVD Example x
ZGESVD Example Program in Fortran ZGESVD Example Program in C LAPACKE_zgesvd Example Program in C for Row Major Data Layout LAPACKE_zgesvd Example Program in C for Column Major Data Layout
?gesdd function x
CGESDD Example DGESDD Example SGESDD Example ZGESDD Example
CGESDD Example x
CGESDD Example Program in Fortran CGESDD Example Program in C LAPACKE_cgesdd Example Program in C for Row Major Data Layout LAPACKE_cgesdd Example Program in C for Column Major Data Layout
DGESDD Example x
DGESDD Example Program in Fortran DGESDD Example Program in C LAPACKE_dgesdd Example Program in C for Row Major Data Layout LAPACKE_dgesdd Example Program in C for Column Major Data Layout
SGESDD Example x
SGESDD Example Program in Fortran SGESDD Example Program in C LAPACKE_sgesdd Example Program in C for Row Major Data Layout LAPACKE_sgesdd Example Program in C for Column Major Data Layout
ZGESDD Example x
ZGESDD Example Program in Fortran ZGESDD Example Program in C LAPACKE_zgesdd Example Program in C for Row Major Data Layout LAPACKE_zgesdd Example Program in C for Column Major Data Layout
Intel® oneAPI Math Kernel Library LAPACK Examples

C Interface Conventions

The C interfaces are implemented for most of the oneMKL LAPACK driver and computational routines.

The arguments of the C interfaces for the oneMKL LAPACK functions comply with the following rules:

  • Scalar input arguments are passed by value.

  • Array arguments are passed by reference.

  • Array input arguments are declared with the const modifier.

  • Function arguments are passed by pointer.

  • An integer return value replaces the info output parameter. The return value equal to 0 means the function operation is completed successfully. See the section Error Codes below.

  • Most of the LAPACK C interfaces have an additional parameter matrix_layout of the int type as their first argument. This parameter specifies whether the two-dimensional arrays are row-major (LAPACK_ROW_MAJOR) or column-major (LAPACK_COL_MAJOR).

The LAPACK C interface omits workspace parameters because workspace is allocated at run time and released upon completion of the function operation.

For the ?gesvd function, work arrays contain valuable information on exit. The interface contains an additional argument superb.

Function Types

The function types are used in non-symmetric eigenproblem functions only. 

typedef lapack_logical (*LAPACK_S_SELECT2) (const float*, const float*);
typedef lapack_logical (*LAPACK_S_SELECT3) (const float*, const float*, const float*);
typedef lapack_logical (*LAPACK_D_SELECT2) (const double*, const double*);
typedef lapack_logical (*LAPACK_D_SELECT3) (const double*, const double*, const double*);
typedef lapack_logical (*LAPACK_C_SELECT1) (const lapack_complex_float*);
typedef lapack_logical (*LAPACK_C_SELECT2) (const lapack_complex_float*, const lapack_complex_float*);
typedef lapack_logical (*LAPACK_Z_SELECT1) (const lapack_complex_double*);
typedef lapack_logical (*LAPACK_Z_SELECT2) (const lapack_complex_double*, const lapack_complex_double*);

Mapping FORTRAN Data Types against C Data Types

FORTRAN Data Types C Data Types
INTEGER lapack_int
LOGICAL lapack_logical
REAL float
DOUBLE PRECISION double
COMPLEX lapack_complex_float
COMPLEX*16 lapack_complex_double
CHARACTER char

C Types

#ifndef lapack_int
#define lapack_int MKL_INT
#endif
#ifndef lapack_logical
#define lapack_logical lapack_int
#endif

Complex Types

For single precision: 

#ifndef lapack_complex_float
#define lapack_complex_float   MKL_Complex8
#endif

For double precision: 

#ifndef lapack_complex_double
#define lapack_complex_double   MKL_Complex16
#endif

Matrix Layout

Most of the LAPACK C interfaces have an additional parameter matrix_layout of type int as their first argument. This parameter specifies whether the two-dimensional arrays are row-major LAPACK_ROW_MAJOR or column-major LAPACK_COL_MAJOR.

In general the leading dimension lda is equal to the number of elements in the major dimension. It is also equal to the distance in elements between two neighboring elements in a line in the minor dimension. If there are no extra elements in a matrix with m rows and n columns, then

  • For row-major ordering: the number of elements in a row is n, and row i is stored in memory right after row i-1. Therefore lda is n.
  • For column-major ordering: the number of elements in a column is m, and column i is stored in memory right after column i-1. Therefore lda is m.

To refer to a submatrix with dimensions k by l, use the number of elements in the major dimension of the whole matrix (as above) as the leading dimension and k and l in the subroutine's input parameters to describe the size of the submatrix.


submatrix example

Matrix Ordering

#define LAPACK_ROW_MAJOR  101
#define LAPACK_COL_MAJOR  102

Error Codes

#define LAPACK_WORK_MEMORY_ERROR       -1010  /* Failed to allocate memory
                                            for a working array */
#define LAPACK_TRANSPOSE_MEMORY_ERROR  -1011  /* Failed to allocate memory
                                            for transposed matrix */

If the return value is -i, the -i-th parameter has an invalid value.

Function Prototypes

Some oneMKL functions differ in data types they support and vary in the parameters they take.

Each function type has a unique prototype defined. Use this prototype when you call the function from your application program. In most cases, oneMKL supports four distinct floating-point precisions. Each corresponding prototype looks similar, usually differing only in the data type. To avoid listing all the prototypes in every supported precision, a generic prototype template is provided. For example, 

lapack_int LAPACKE_
Parent topic: Intel® oneAPI Math Kernel Library LAPACK Examples
Level Two Title