Introduction to hipSOLVER API#

Note

The hipSOLVER library remains in active development. New features are being continuously added, with new functionality documented at each release of the ROCm platform.

The following tables summarize the wrapper functions that are implemented in the regular API for the different supported precisions in latest hipSOLVER release. Most of these functions have a corresponding version in the compatibility APIs, where applicable.

LAPACK auxiliary functions#

Table 1 Orthonormal matrices#

Function

single

double

single complex

double complex

hipsolverXorgbr_bufferSize

x

x

hipsolverXorgbr

x

x

hipsolverXorgqr_bufferSize

x

x

hipsolverXorgqr

x

x

hipsolverXorgtr_bufferSize

x

x

hipsolverXorgtr

x

x

hipsolverXormqr_bufferSize

x

x

hipsolverXormqr

x

x

hipsolverXormtr_bufferSize

x

x

hipsolverXormtr

x

x

Table 2 Unitary matrices#

Function

single

double

single complex

double complex

hipsolverXungbr_bufferSize

x

x

hipsolverXungbr

x

x

hipsolverXungqr_bufferSize

x

x

hipsolverXungqr

x

x

hipsolverXungtr_bufferSize

x

x

hipsolverXungtr

x

x

hipsolverXunmqr_bufferSize

x

x

hipsolverXunmqr

x

x

hipsolverXunmtr_bufferSize

x

x

hipsolverXunmtr

x

x

LAPACK main functions#

Table 3 Triangular factorizations#

Function

single

double

single complex

double complex

hipsolverXpotrf_bufferSize

x

x

x

x

hipsolverXpotrf

x

x

x

x

hipsolverXpotrfBatched_bufferSize

x

x

x

x

hipsolverXpotrfBatched

x

x

x

x

hipsolverXgetrf_bufferSize

x

x

x

x

hipsolverXgetrf

x

x

x

x

hipsolverXsytrf_bufferSize

x

x

x

x

hipsolverXsytrf

x

x

x

x

Table 4 Orthogonal factorizations#

Function

single

double

single complex

double complex

hipsolverXgeqrf_bufferSize

x

x

x

x

hipsolverXgeqrf

x

x

x

x

Table 5 Problem and matrix reductions#

Function

single

double

single complex

double complex

hipsolverXsytrd_bufferSize

x

x

hipsolverXsytrd

x

x

hipsolverXhetrd_bufferSize

x

x

hipsolverXhetrd

x

x

hipsolverXgebrd_bufferSize

x

x

x

x

hipsolverXgebrd

x

x

x

x

Table 6 Linear-systems solvers#

Function

single

double

single complex

double complex

hipsolverXpotri_bufferSize

x

x

x

x

hipsolverXpotri

x

x

x

x

hipsolverXpotrs_bufferSize

x

x

x

x

hipsolverXpotrs

x

x

x

x

hipsolverXpotrsBatched_bufferSize

x

x

x

x

hipsolverXpotrsBatched

x

x

x

x

hipsolverXgetrs_bufferSize

x

x

x

x

hipsolverXgetrs

x

x

x

x

hipsolverXXgesv_bufferSize

x

x

x

x

hipsolverXXgesv

x

x

x

x

Table 7 Least-square solvers#

Function

single

double

single complex

double complex

hipsolverXXgels_bufferSize

x

x

x

x

hipsolverXXgels

x

x

x

x

Table 8 Symmetric eigensolvers#

Function

single

double

single complex

double complex

hipsolverXsyevd_bufferSize

x

x

hipsolverXsyevd

x

x

hipsolverXsygvd_bufferSize

x

x

hipsolverXsygvd

x

x

hipsolverXheevd_bufferSize

x

x

hipsolverXheevd

x

x

hipsolverXhegvd_bufferSize

x

x

hipsolverXhegvd

x

x

Table 9 Singular value decomposition#

Function

single

double

single complex

double complex

hipsolverXgesvd_bufferSize

x

x

x

x

hipsolverXgesvd

x

x

x

x

LAPACK-like functions#

Table 10 Symmetric eigensolvers#

Function

single

double

single complex

double complex

hipsolverXsyevdx_bufferSize

x

x

hipsolverXsyevdx

x

x

hipsolverXsyevj_bufferSize

x

x

hipsolverXsyevj

x

x

hipsolverXsyevjBatched_bufferSize

x

x

hipsolverXsyevjBatched

x

x

hipsolverXsygvdx_bufferSize

x

x

hipsolverXsygvdx

x

x

hipsolverXsygvj_bufferSize

x

x

hipsolverXsygvj

x

x

hipsolverXheevdx_bufferSize

x

x

hipsolverXheevdx

x

x

hipsolverXheevj_bufferSize

x

x

hipsolverXheevj

x

x

hipsolverXheevjBatched_bufferSize

x

x

hipsolverXheevjBatched

x

x

hipsolverXhegvdx_bufferSize

x

x

hipsolverXhegvdx

x

x

hipsolverXhegvj_bufferSize

x

x

hipsolverXhegvj

x

x

Table 11 Singular value decomposition#

Function

single

double

single complex

double complex

hipsolverDnXgesvdj_bufferSize

x

x

x

x

hipsolverDnXgesvdj

x

x

x

x

hipsolverDnXgesvdjBatched_bufferSize

x

x

x

x

hipsolverDnXgesvdjBatched

x

x

x

x

Compatibility-only functions#

The following tables summarize the wrapper functions that are provided only in the compatibility APIs. These wrappers are supported in rocSOLVER but either by equivalent functions that use different algorithmic approaches, or by functionality that is not fully exposed in the public API. For these reasons, at present, the corresponding wrappers are not provided in the regular hipSOLVER API.

Partial SVD functions#

Partial SVD has been implemented in rocSOLVER, but at present it does not use an approximate algorithm, nor does it compute the residual norm.

Table 12 Singular value decomposition#

Function

single

double

single complex

double complex

hipsolverDnXgesvdaStridedBatched_bufferSize

x

x

x

x

hipsolverDnXgesvdaStridedBatched

x

x

x

x

Sparse matrix routines#

Sparse matrix routines and direct solvers for sparse matrices are in the very earliest stages of development. Due to unsupported backend functionality, there are a number of intricacies and possible performance implications that users will want to be aware of when using these routines. Refer to the hipsolverSp compatibility API for more details and a full listing of supported functions.

Table 13 Combined factorization and linear-system solvers#

Function

single

double

single complex

double complex

hipsolverSpXcsrlsvcholHost

x

x

hipsolverSpXcsrlsvchol

x

x

Refactorization routines#

Refactorization routines and direct solvers for sparse matrices are in the very earliest stages of development. Due to unsupported backend functionality, there are a number of intricacies and possible performance implications that users will want to be aware of when using these routines. Refer to the hipsolverRf compatibility API for more details and a full listing of supported functions.

Table 14 Triangular factorizations#

Function

single

double

single complex

double complex

hipsolverRfRefactor

x

x

hipsolverRfBatchRefactor

x

x

Table 15 linear-system solvers#

Function

single

double

single complex

double complex

hipsolverRfSolve

x

x

hipsolverRfBatchSolve

x

x