hipSOLVER Compatibility API

Currently, this API document only provides the method signatures for the wrapper functions that are currently implemented in hipSOLVER. For a complete description of the functions’ behavior and arguments, see the corresponding backends’ documentation at cuSOLVER API and/or rocSOLVER API.

For ease of porting from existing cuSOLVER applications to hipSOLVER, functions in hipSOLVER’s compatibility API are designed to have method signatures that are consistent with the cusolverDn interface. However, performance issues may arise when using the rocSOLVER backend due to differing workspace requirements. Therefore, users interested in achieving the best performance with the rocSOLVER backend should consult the regular API documentation, and transition from the compatibility API to the regular API at the earliest convenience. Please refer to the user guide for additional considerations regarding the use of the regular API.

• Types
  • hipSOLVER compatibility API types
    • hipsolverDnHandle_t
      • hipsolverDnHandle_t
    • hipsolverGesvdjInfo_t
      • hipsolverGesvdjInfo_t
    • hipsolverSyevjInfo_t
    • hipsolverStatus_t
    • hipsolverOperation_t
    • hipsolverFillMode_t
    • hipsolverSideMode_t
    • hipsolverEigMode_t
    • hipsolverEigType_t
    • hipsolverEigRange_t
      • hipsolverEigRange_t
        • hipsolverEigRange_t::HIPSOLVER_EIG_RANGE_ALL
        • hipsolverEigRange_t::HIPSOLVER_EIG_RANGE_V
        • hipsolverEigRange_t::HIPSOLVER_EIG_RANGE_I
• Helper Functions
  • Handle set-up and tear-down
    • hipsolverDnCreate()
      • hipsolverDnCreate()
    • hipsolverDnDestroy()
      • hipsolverDnDestroy()
  • Stream manipulation
    • hipsolverDnSetStream()
      • hipsolverDnSetStream()
    • hipsolverDnGetStream()
      • hipsolverDnGetStream()
  • Gesvdj parameter manipulation
    • hipsolverDnCreateGesvdjInfo()
      • hipsolverDnCreateGesvdjInfo()
    • hipsolverDnDestroyGesvdjInfo()
      • hipsolverDnDestroyGesvdjInfo()
    • hipsolverDnXgesvdjSetMaxSweeps()
      • hipsolverDnXgesvdjSetMaxSweeps()
    • hipsolverDnXgesvdjSetSortEig()
      • hipsolverDnXgesvdjSetSortEig()
    • hipsolverDnXgesvdjSetTolerance()
      • hipsolverDnXgesvdjSetTolerance()
    • hipsolverDnXgesvdjGetResidual()
      • hipsolverDnXgesvdjGetResidual()
    • hipsolverDnXgesvdjGetSweeps()
      • hipsolverDnXgesvdjGetSweeps()
  • Syevj parameter manipulation
    • hipsolverDnCreateSyevjInfo()
      • hipsolverDnCreateSyevjInfo()
    • hipsolverDnDestroySyevjInfo()
      • hipsolverDnDestroySyevjInfo()
    • hipsolverDnXsyevjSetMaxSweeps()
      • hipsolverDnXsyevjSetMaxSweeps()
    • hipsolverDnXsyevjSetSortEig()
      • hipsolverDnXsyevjSetSortEig()
    • hipsolverDnXsyevjSetTolerance()
      • hipsolverDnXsyevjSetTolerance()
    • hipsolverDnXsyevjGetResidual()
      • hipsolverDnXsyevjGetResidual()
    • hipsolverDnXsyevjGetSweeps()
      • hipsolverDnXsyevjGetSweeps()
• LAPACK Auxiliary Functions
  • Orthonormal matrices
    • hipsolverDn<type>orgbr_bufferSize()
      • hipsolverDnDorgbr_bufferSize()
      • hipsolverDnSorgbr_bufferSize()
    • hipsolverDn<type>orgbr()
      • hipsolverDnDorgbr()
      • hipsolverDnSorgbr()
    • hipsolverDn<type>orgqr_bufferSize()
      • hipsolverDnDorgqr_bufferSize()
      • hipsolverDnSorgqr_bufferSize()
    • hipsolverDn<type>orgqr()
      • hipsolverDnDorgqr()
      • hipsolverDnSorgqr()
    • hipsolverDn<type>orgtr_bufferSize()
      • hipsolverDnDorgtr_bufferSize()
      • hipsolverDnSorgtr_bufferSize()
    • hipsolverDn<type>orgtr()
      • hipsolverDnDorgtr()
      • hipsolverDnSorgtr()
    • hipsolverDn<type>ormqr_bufferSize()
      • hipsolverDnDormqr_bufferSize()
      • hipsolverDnSormqr_bufferSize()
    • hipsolverDn<type>ormqr()
      • hipsolverDnDormqr()
      • hipsolverDnSormqr()
    • hipsolverDn<type>ormtr_bufferSize()
      • hipsolverDnDormtr_bufferSize()
      • hipsolverDnSormtr_bufferSize()
    • hipsolverDn<type>ormtr()
      • hipsolverDnDormtr()
      • hipsolverDnSormtr()
  • Unitary matrices
    • hipsolverDn<type>ungbr_bufferSize()
      • hipsolverDnZungbr_bufferSize()
      • hipsolverDnCungbr_bufferSize()
    • hipsolverDn<type>ungbr()
      • hipsolverDnZungbr()
      • hipsolverDnCungbr()
    • hipsolverDn<type>ungqr_bufferSize()
      • hipsolverDnZungqr_bufferSize()
      • hipsolverDnCungqr_bufferSize()
    • hipsolverDn<type>ungqr()
      • hipsolverDnZungqr()
      • hipsolverDnCungqr()
    • hipsolverDn<type>ungtr_bufferSize()
      • hipsolverDnZungtr_bufferSize()
      • hipsolverDnCungtr_bufferSize()
    • hipsolverDn<type>ungtr()
      • hipsolverDnZungtr()
      • hipsolverDnCungtr()
    • hipsolverDn<type>unmqr_bufferSize()
      • hipsolverDnZunmqr_bufferSize()
      • hipsolverDnCunmqr_bufferSize()
    • hipsolverDn<type>unmqr()
      • hipsolverDnZunmqr()
      • hipsolverDnCunmqr()
    • hipsolverDn<type>unmtr_bufferSize()
      • hipsolverDnZunmtr_bufferSize()
      • hipsolverDnCunmtr_bufferSize()
    • hipsolverDn<type>unmtr()
      • hipsolverDnZunmtr()
      • hipsolverDnCunmtr()
• LAPACK Functions
  • Triangular factorizations
    • hipsolverDn<type>potrf_bufferSize()
      • hipsolverDnZpotrf_bufferSize()
      • hipsolverDnCpotrf_bufferSize()
      • hipsolverDnDpotrf_bufferSize()
      • hipsolverDnSpotrf_bufferSize()
    • hipsolverDn<type>potrf()
      • hipsolverDnZpotrf()
      • hipsolverDnCpotrf()
      • hipsolverDnDpotrf()
      • hipsolverDnSpotrf()
    • hipsolverDn<type>potrfBatched()
      • hipsolverDnZpotrfBatched()
      • hipsolverDnCpotrfBatched()
      • hipsolverDnDpotrfBatched()
      • hipsolverDnSpotrfBatched()
    • hipsolverDn<type>getrf_bufferSize()
      • hipsolverDnZgetrf_bufferSize()
      • hipsolverDnCgetrf_bufferSize()
      • hipsolverDnDgetrf_bufferSize()
      • hipsolverDnSgetrf_bufferSize()
    • hipsolverDn<type>getrf()
      • hipsolverDnZgetrf()
      • hipsolverDnCgetrf()
      • hipsolverDnDgetrf()
      • hipsolverDnSgetrf()
    • hipsolverDn<type>sytrf_bufferSize()
      • hipsolverDnZsytrf_bufferSize()
      • hipsolverDnCsytrf_bufferSize()
      • hipsolverDnDsytrf_bufferSize()
      • hipsolverDnSsytrf_bufferSize()
    • hipsolverDn<type>sytrf()
      • hipsolverDnZsytrf()
      • hipsolverDnCsytrf()
      • hipsolverDnDsytrf()
      • hipsolverDnSsytrf()
  • Orthogonal factorizations
    • hipsolverDn<type>geqrf_bufferSize()
      • hipsolverDnZgeqrf_bufferSize()
      • hipsolverDnCgeqrf_bufferSize()
      • hipsolverDnDgeqrf_bufferSize()
      • hipsolverDnSgeqrf_bufferSize()
    • hipsolverDn<type>geqrf()
      • hipsolverDnZgeqrf()
      • hipsolverDnCgeqrf()
      • hipsolverDnDgeqrf()
      • hipsolverDnSgeqrf()
  • Problem and matrix reductions
    • hipsolverDn<type>gebrd_bufferSize()
      • hipsolverDnZgebrd_bufferSize()
      • hipsolverDnCgebrd_bufferSize()
      • hipsolverDnDgebrd_bufferSize()
      • hipsolverDnSgebrd_bufferSize()
    • hipsolverDn<type>gebrd()
      • hipsolverDnZgebrd()
      • hipsolverDnCgebrd()
      • hipsolverDnDgebrd()
      • hipsolverDnSgebrd()
    • hipsolverDn<type>sytrd_bufferSize()
      • hipsolverDnDsytrd_bufferSize()
      • hipsolverDnSsytrd_bufferSize()
    • hipsolverDn<type>hetrd_bufferSize()
      • hipsolverDnZhetrd_bufferSize()
      • hipsolverDnChetrd_bufferSize()
    • hipsolverDn<type>sytrd()
      • hipsolverDnDsytrd()
      • hipsolverDnSsytrd()
    • hipsolverDn<type>hetrd()
      • hipsolverDnZhetrd()
      • hipsolverDnChetrd()
  • Linear-systems solvers
    • hipsolverDn<type>potri_bufferSize()
      • hipsolverDnZpotri_bufferSize()
      • hipsolverDnCpotri_bufferSize()
      • hipsolverDnDpotri_bufferSize()
      • hipsolverDnSpotri_bufferSize()
    • hipsolverDn<type>potri()
      • hipsolverDnZpotri()
      • hipsolverDnCpotri()
      • hipsolverDnDpotri()
      • hipsolverDnSpotri()
    • hipsolverDn<type>potrs()
      • hipsolverDnZpotrs()
      • hipsolverDnCpotrs()
      • hipsolverDnDpotrs()
      • hipsolverDnSpotrs()
    • hipsolverDn<type>potrsBatched()
      • hipsolverDnZpotrsBatched()
      • hipsolverDnCpotrsBatched()
      • hipsolverDnDpotrsBatched()
      • hipsolverDnSpotrsBatched()
    • hipsolverDn<type>getrs()
      • hipsolverDnZgetrs()
      • hipsolverDnCgetrs()
      • hipsolverDnDgetrs()
      • hipsolverDnSgetrs()
    • hipsolverDn<type><type>gesv_bufferSize()
      • hipsolverDnZZgesv_bufferSize()
      • hipsolverDnCCgesv_bufferSize()
      • hipsolverDnDDgesv_bufferSize()
      • hipsolverDnSSgesv_bufferSize()
    • hipsolverDn<type><type>gesv()
      • hipsolverDnZZgesv()
      • hipsolverDnCCgesv()
      • hipsolverDnDDgesv()
      • hipsolverDnSSgesv()
  • Least-squares solvers
    • hipsolverDn<type><type>gels_bufferSize()
      • hipsolverDnZZgels_bufferSize()
      • hipsolverDnCCgels_bufferSize()
      • hipsolverDnDDgels_bufferSize()
      • hipsolverDnSSgels_bufferSize()
    • hipsolverDn<type><type>gels()
      • hipsolverDnZZgels()
      • hipsolverDnCCgels()
      • hipsolverDnDDgels()
      • hipsolverDnSSgels()
  • Symmetric eigensolvers
    • hipsolverDn<type>syevd_bufferSize()
      • hipsolverDnDsyevd_bufferSize()
      • hipsolverDnSsyevd_bufferSize()
    • hipsolverDn<type>heevd_bufferSize()
      • hipsolverDnZheevd_bufferSize()
      • hipsolverDnCheevd_bufferSize()
    • hipsolverDn<type>syevd()
      • hipsolverDnDsyevd()
      • hipsolverDnSsyevd()
    • hipsolverDn<type>heevd()
      • hipsolverDnZheevd()
      • hipsolverDnCheevd()
    • hipsolverDn<type>syevdx_bufferSize()
      • hipsolverDnDsyevdx_bufferSize()
      • hipsolverDnSsyevdx_bufferSize()
    • hipsolverDn<type>heevdx_bufferSize()
      • hipsolverDnZheevdx_bufferSize()
      • hipsolverDnCheevdx_bufferSize()
    • hipsolverDn<type>syevdx()
      • hipsolverDnDsyevdx()
      • hipsolverDnSsyevdx()
    • hipsolverDn<type>heevdx()
      • hipsolverDnZheevdx()
      • hipsolverDnCheevdx()
    • hipsolverDn<type>syevj_bufferSize()
      • hipsolverDnDsyevj_bufferSize()
      • hipsolverDnSsyevj_bufferSize()
    • hipsolverDn<type>heevj_bufferSize()
      • hipsolverDnZheevj_bufferSize()
      • hipsolverDnCheevj_bufferSize()
    • hipsolverDn<type>syevjBatched_bufferSize()
      • hipsolverDnDsyevjBatched_bufferSize()
      • hipsolverDnSsyevjBatched_bufferSize()
    • hipsolverDn<type>heevjBatched_bufferSize()
      • hipsolverDnZheevjBatched_bufferSize()
      • hipsolverDnCheevjBatched_bufferSize()
    • hipsolverDn<type>syevj()
      • hipsolverDnDsyevj()
      • hipsolverDnSsyevj()
    • hipsolverDn<type>heevj()
      • hipsolverDnZheevj()
      • hipsolverDnCheevj()
    • hipsolverDn<type>syevjBatched()
      • hipsolverDnDsyevjBatched()
      • hipsolverDnSsyevjBatched()
    • hipsolverDn<type>heevjBatched()
      • hipsolverDnZheevjBatched()
      • hipsolverDnCheevjBatched()
    • hipsolverDn<type>sygvd_bufferSize()
      • hipsolverDnDsygvd_bufferSize()
      • hipsolverDnSsygvd_bufferSize()
    • hipsolverDn<type>hegvd_bufferSize()
      • hipsolverDnZhegvd_bufferSize()
      • hipsolverDnChegvd_bufferSize()
    • hipsolverDn<type>sygvd()
      • hipsolverDnDsygvd()
      • hipsolverDnSsygvd()
    • hipsolverDn<type>hegvd()
      • hipsolverDnZhegvd()
      • hipsolverDnChegvd()
    • hipsolverDn<type>sygvdx_bufferSize()
      • hipsolverDnDsygvdx_bufferSize()
      • hipsolverDnSsygvdx_bufferSize()
    • hipsolverDn<type>hegvdx_bufferSize()
      • hipsolverDnZhegvdx_bufferSize()
      • hipsolverDnChegvdx_bufferSize()
    • hipsolverDn<type>sygvdx()
      • hipsolverDnDsygvdx()
      • hipsolverDnSsygvdx()
    • hipsolverDn<type>hegvdx()
      • hipsolverDnZhegvdx()
      • hipsolverDnChegvdx()
    • hipsolverDn<type>sygvj_bufferSize()
      • hipsolverDnDsygvj_bufferSize()
      • hipsolverDnSsygvj_bufferSize()
    • hipsolverDn<type>hegvj_bufferSize()
      • hipsolverDnZhegvj_bufferSize()
      • hipsolverDnChegvj_bufferSize()
    • hipsolverDn<type>sygvj()
      • hipsolverDnDsygvj()
      • hipsolverDnSsygvj()
    • hipsolverDn<type>hegvj()
      • hipsolverDnZhegvj()
      • hipsolverDnChegvj()
  • Singular value decomposition
    • hipsolverDn<type>gesvd_bufferSize()
      • hipsolverDnZgesvd_bufferSize()
      • hipsolverDnCgesvd_bufferSize()
      • hipsolverDnDgesvd_bufferSize()
      • hipsolverDnSgesvd_bufferSize()
    • hipsolverDn<type>gesvd()
      • hipsolverDnZgesvd()
      • hipsolverDnCgesvd()
      • hipsolverDnDgesvd()
      • hipsolverDnSgesvd()
    • hipsolverDn<type>gesvdj_bufferSize()
      • hipsolverDnZgesvdj_bufferSize()
      • hipsolverDnCgesvdj_bufferSize()
      • hipsolverDnDgesvdj_bufferSize()
      • hipsolverDnSgesvdj_bufferSize()
    • hipsolverDn<type>gesvdjBatched_bufferSize()
      • hipsolverDnZgesvdjBatched_bufferSize()
      • hipsolverDnCgesvdjBatched_bufferSize()
      • hipsolverDnDgesvdjBatched_bufferSize()
      • hipsolverDnSgesvdjBatched_bufferSize()
    • hipsolverDn<type>gesvdj()
      • hipsolverDnZgesvdj()
      • hipsolverDnCgesvdj()
      • hipsolverDnDgesvdj()
      • hipsolverDnSgesvdj()
    • hipsolverDn<type>gesvdjBatched()
      • hipsolverDnZgesvdjBatched()
      • hipsolverDnCgesvdjBatched()
      • hipsolverDnDgesvdjBatched()
      • hipsolverDnSgesvdjBatched()
• LAPACK-like Functions
  • Symmetric eigensolvers
    • hipsolverDn<type>syevdx_bufferSize()
      • hipsolverDnDsyevdx_bufferSize()
      • hipsolverDnSsyevdx_bufferSize()
    • hipsolverDn<type>heevdx_bufferSize()
      • hipsolverDnZheevdx_bufferSize()
      • hipsolverDnCheevdx_bufferSize()
    • hipsolverDn<type>syevdx()
      • hipsolverDnDsyevdx()
      • hipsolverDnSsyevdx()
    • hipsolverDn<type>heevdx()
      • hipsolverDnZheevdx()
      • hipsolverDnCheevdx()
    • hipsolverDn<type>syevj_bufferSize()
      • hipsolverDnDsyevj_bufferSize()
      • hipsolverDnSsyevj_bufferSize()
    • hipsolverDn<type>heevj_bufferSize()
      • hipsolverDnZheevj_bufferSize()
      • hipsolverDnCheevj_bufferSize()
    • hipsolverDn<type>syevjBatched_bufferSize()
      • hipsolverDnDsyevjBatched_bufferSize()
      • hipsolverDnSsyevjBatched_bufferSize()
    • hipsolverDn<type>heevjBatched_bufferSize()
      • hipsolverDnZheevjBatched_bufferSize()
      • hipsolverDnCheevjBatched_bufferSize()
    • hipsolverDn<type>syevj()
      • hipsolverDnDsyevj()
      • hipsolverDnSsyevj()
    • hipsolverDn<type>heevj()
      • hipsolverDnZheevj()
      • hipsolverDnCheevj()
    • hipsolverDn<type>syevjBatched()
      • hipsolverDnDsyevjBatched()
      • hipsolverDnSsyevjBatched()
    • hipsolverDn<type>heevjBatched()
      • hipsolverDnZheevjBatched()
      • hipsolverDnCheevjBatched()
    • hipsolverDn<type>sygvdx_bufferSize()
      • hipsolverDnDsygvdx_bufferSize()
      • hipsolverDnSsygvdx_bufferSize()
    • hipsolverDn<type>hegvdx_bufferSize()
      • hipsolverDnZhegvdx_bufferSize()
      • hipsolverDnChegvdx_bufferSize()
    • hipsolverDn<type>sygvdx()
      • hipsolverDnDsygvdx()
      • hipsolverDnSsygvdx()
    • hipsolverDn<type>hegvdx()
      • hipsolverDnZhegvdx()
      • hipsolverDnChegvdx()
    • hipsolverDn<type>sygvj_bufferSize()
      • hipsolverDnDsygvj_bufferSize()
      • hipsolverDnSsygvj_bufferSize()
    • hipsolverDn<type>hegvj_bufferSize()
      • hipsolverDnZhegvj_bufferSize()
      • hipsolverDnChegvj_bufferSize()
    • hipsolverDn<type>sygvj()
      • hipsolverDnDsygvj()
      • hipsolverDnSsygvj()
    • hipsolverDn<type>hegvj()
      • hipsolverDnZhegvj()
      • hipsolverDnChegvj()
  • Singular value decomposition
    • hipsolverDn<type>gesvdj_bufferSize()
      • hipsolverDnZgesvdj_bufferSize()
      • hipsolverDnCgesvdj_bufferSize()
      • hipsolverDnDgesvdj_bufferSize()
      • hipsolverDnSgesvdj_bufferSize()
    • hipsolverDn<type>gesvdjBatched_bufferSize()
      • hipsolverDnZgesvdjBatched_bufferSize()
      • hipsolverDnCgesvdjBatched_bufferSize()
      • hipsolverDnDgesvdjBatched_bufferSize()
      • hipsolverDnSgesvdjBatched_bufferSize()
    • hipsolverDn<type>gesvdj()
      • hipsolverDnZgesvdj()
      • hipsolverDnCgesvdj()
      • hipsolverDnDgesvdj()
      • hipsolverDnSgesvdj()
    • hipsolverDn<type>gesvdjBatched()
      • hipsolverDnZgesvdjBatched()
      • hipsolverDnCgesvdjBatched()
      • hipsolverDnDgesvdjBatched()
      • hipsolverDnSgesvdjBatched()
    • hipsolverDn<type>gesvdaStridedBatched_bufferSize()
    • hipsolverDn<type>gesvdaStridedBatched()