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

The hipSOLVER API is designed to be similar to the cusolverDn and rocSOLVER interfaces, but it requires some minor adjustments to ensure the best performance out of both backends. Generally, this involves the addition of workspace parameters and some additional API methods. Please refer to the user guide for a complete listing of API differences.

Users interested in using hipSOLVER without these adjustments, so that the interface matches cuSOLVER, should instead consult the Compatibility API documentation. See also the porting section for more details.

• Types
  • hipSOLVER regular API types
    • hipsolverHandle_t
      • hipsolverHandle_t
    • hipsolverSyevjInfo_t
      • hipsolverSyevjInfo_t
    • hipsolverStatus_t
      • hipsolverStatus_t
        • hipsolverStatus_t::HIPSOLVER_STATUS_SUCCESS
        • hipsolverStatus_t::HIPSOLVER_STATUS_NOT_INITIALIZED
        • hipsolverStatus_t::HIPSOLVER_STATUS_ALLOC_FAILED
        • hipsolverStatus_t::HIPSOLVER_STATUS_INVALID_VALUE
        • hipsolverStatus_t::HIPSOLVER_STATUS_MAPPING_ERROR
        • hipsolverStatus_t::HIPSOLVER_STATUS_EXECUTION_FAILED
        • hipsolverStatus_t::HIPSOLVER_STATUS_INTERNAL_ERROR
        • hipsolverStatus_t::HIPSOLVER_STATUS_NOT_SUPPORTED
        • hipsolverStatus_t::HIPSOLVER_STATUS_ARCH_MISMATCH
        • hipsolverStatus_t::HIPSOLVER_STATUS_HANDLE_IS_NULLPTR
        • hipsolverStatus_t::HIPSOLVER_STATUS_INVALID_ENUM
        • hipsolverStatus_t::HIPSOLVER_STATUS_UNKNOWN
    • hipsolverOperation_t
      • hipsolverOperation_t
        • hipsolverOperation_t::HIPSOLVER_OP_N
        • hipsolverOperation_t::HIPSOLVER_OP_T
        • hipsolverOperation_t::HIPSOLVER_OP_C
    • hipsolverFillMode_t
      • hipsolverFillMode_t
        • hipsolverFillMode_t::HIPSOLVER_FILL_MODE_UPPER
        • hipsolverFillMode_t::HIPSOLVER_FILL_MODE_LOWER
    • hipsolverSideMode_t
      • hipsolverSideMode_t
        • hipsolverSideMode_t::HIPSOLVER_SIDE_LEFT
        • hipsolverSideMode_t::HIPSOLVER_SIDE_RIGHT
    • hipsolverEigMode_t
      • hipsolverEigMode_t
        • hipsolverEigMode_t::HIPSOLVER_EIG_MODE_NOVECTOR
        • hipsolverEigMode_t::HIPSOLVER_EIG_MODE_VECTOR
    • hipsolverEigType_t
      • hipsolverEigType_t
        • hipsolverEigType_t::HIPSOLVER_EIG_TYPE_1
        • hipsolverEigType_t::HIPSOLVER_EIG_TYPE_2
        • hipsolverEigType_t::HIPSOLVER_EIG_TYPE_3
• Helper Functions
  • Handle set-up and tear-down
    • hipsolverCreate()
      • hipsolverCreate()
    • hipsolverDestroy()
      • hipsolverDestroy()
  • Stream manipulation
    • hipsolverSetStream()
      • hipsolverSetStream()
    • hipsolverGetStream()
      • hipsolverGetStream()
  • Syevj parameter manipulation
    • hipsolverCreateSyevjInfo()
      • hipsolverCreateSyevjInfo()
    • hipsolverDestroySyevjInfo()
      • hipsolverDestroySyevjInfo()
    • hipsolverXsyevjSetMaxSweeps()
      • hipsolverXsyevjSetMaxSweeps()
    • hipsolverXsyevjSetSortEig()
      • hipsolverXsyevjSetSortEig()
    • hipsolverXsyevjSetTolerance()
      • hipsolverXsyevjSetTolerance()
    • hipsolverXsyevjGetResidual()
      • hipsolverXsyevjGetResidual()
    • hipsolverXsyevjGetSweeps()
      • hipsolverXsyevjGetSweeps()
• LAPACK Auxiliary Functions
  • Orthonormal matrices
    • hipsolver<type>orgbr_bufferSize()
      • hipsolverDorgbr_bufferSize()
      • hipsolverSorgbr_bufferSize()
    • hipsolver<type>orgbr()
      • hipsolverDorgbr()
      • hipsolverSorgbr()
    • hipsolver<type>orgqr_bufferSize()
      • hipsolverDorgqr_bufferSize()
      • hipsolverSorgqr_bufferSize()
    • hipsolver<type>orgqr()
      • hipsolverDorgqr()
      • hipsolverSorgqr()
    • hipsolver<type>orgtr_bufferSize()
      • hipsolverDorgtr_bufferSize()
      • hipsolverSorgtr_bufferSize()
    • hipsolver<type>orgtr()
      • hipsolverDorgtr()
      • hipsolverSorgtr()
    • hipsolver<type>ormqr_bufferSize()
      • hipsolverDormqr_bufferSize()
      • hipsolverSormqr_bufferSize()
    • hipsolver<type>ormqr()
      • hipsolverDormqr()
      • hipsolverSormqr()
    • hipsolver<type>ormtr_bufferSize()
      • hipsolverDormtr_bufferSize()
      • hipsolverSormtr_bufferSize()
    • hipsolver<type>ormtr()
      • hipsolverDormtr()
      • hipsolverSormtr()
  • Unitary matrices
    • hipsolver<type>ungbr_bufferSize()
      • hipsolverZungbr_bufferSize()
      • hipsolverCungbr_bufferSize()
    • hipsolver<type>ungbr()
      • hipsolverZungbr()
      • hipsolverCungbr()
    • hipsolver<type>ungqr_bufferSize()
      • hipsolverZungqr_bufferSize()
      • hipsolverCungqr_bufferSize()
    • hipsolver<type>ungqr()
      • hipsolverZungqr()
      • hipsolverCungqr()
    • hipsolver<type>ungtr_bufferSize()
      • hipsolverZungtr_bufferSize()
      • hipsolverCungtr_bufferSize()
    • hipsolver<type>ungtr()
      • hipsolverZungtr()
      • hipsolverCungtr()
    • hipsolver<type>unmqr_bufferSize()
      • hipsolverZunmqr_bufferSize()
      • hipsolverCunmqr_bufferSize()
    • hipsolver<type>unmqr()
      • hipsolverZunmqr()
      • hipsolverCunmqr()
    • hipsolver<type>unmtr_bufferSize()
      • hipsolverZunmtr_bufferSize()
      • hipsolverCunmtr_bufferSize()
    • hipsolver<type>unmtr()
      • hipsolverZunmtr()
      • hipsolverCunmtr()
• LAPACK Functions
  • Triangular factorizations
    • hipsolver<type>potrf_bufferSize()
      • hipsolverZpotrf_bufferSize()
      • hipsolverCpotrf_bufferSize()
      • hipsolverDpotrf_bufferSize()
      • hipsolverSpotrf_bufferSize()
    • hipsolver<type>potrfBatched_bufferSize()
      • hipsolverZpotrfBatched_bufferSize()
      • hipsolverCpotrfBatched_bufferSize()
      • hipsolverDpotrfBatched_bufferSize()
      • hipsolverSpotrfBatched_bufferSize()
    • hipsolver<type>potrf()
      • hipsolverZpotrf()
      • hipsolverCpotrf()
      • hipsolverDpotrf()
      • hipsolverSpotrf()
    • hipsolver<type>potrfBatched()
      • hipsolverZpotrfBatched()
      • hipsolverCpotrfBatched()
      • hipsolverDpotrfBatched()
      • hipsolverSpotrfBatched()
    • hipsolver<type>getrf_bufferSize()
      • hipsolverZgetrf_bufferSize()
      • hipsolverCgetrf_bufferSize()
      • hipsolverDgetrf_bufferSize()
      • hipsolverSgetrf_bufferSize()
    • hipsolver<type>getrf()
      • hipsolverZgetrf()
      • hipsolverCgetrf()
      • hipsolverDgetrf()
      • hipsolverSgetrf()
    • hipsolver<type>sytrf_bufferSize()
      • hipsolverZsytrf_bufferSize()
      • hipsolverCsytrf_bufferSize()
      • hipsolverDsytrf_bufferSize()
      • hipsolverSsytrf_bufferSize()
    • hipsolver<type>sytrf()
      • hipsolverZsytrf()
      • hipsolverCsytrf()
      • hipsolverDsytrf()
      • hipsolverSsytrf()
  • Orthogonal factorizations
    • hipsolver<type>geqrf_bufferSize()
      • hipsolverZgeqrf_bufferSize()
      • hipsolverCgeqrf_bufferSize()
      • hipsolverDgeqrf_bufferSize()
      • hipsolverSgeqrf_bufferSize()
    • hipsolver<type>geqrf()
      • hipsolverZgeqrf()
      • hipsolverCgeqrf()
      • hipsolverDgeqrf()
      • hipsolverSgeqrf()
  • Problem and matrix reductions
    • hipsolver<type>gebrd_bufferSize()
      • hipsolverZgebrd_bufferSize()
      • hipsolverCgebrd_bufferSize()
      • hipsolverDgebrd_bufferSize()
      • hipsolverSgebrd_bufferSize()
    • hipsolver<type>gebrd()
      • hipsolverZgebrd()
      • hipsolverCgebrd()
      • hipsolverDgebrd()
      • hipsolverSgebrd()
    • hipsolver<type>sytrd_bufferSize()
      • hipsolverDsytrd_bufferSize()
      • hipsolverSsytrd_bufferSize()
    • hipsolver<type>hetrd_bufferSize()
      • hipsolverZhetrd_bufferSize()
      • hipsolverChetrd_bufferSize()
    • hipsolver<type>sytrd()
      • hipsolverDsytrd()
      • hipsolverSsytrd()
    • hipsolver<type>hetrd()
      • hipsolverZhetrd()
      • hipsolverChetrd()
  • Linear-systems solvers
    • hipsolver<type>potri_bufferSize()
      • hipsolverZpotri_bufferSize()
      • hipsolverCpotri_bufferSize()
      • hipsolverDpotri_bufferSize()
      • hipsolverSpotri_bufferSize()
    • hipsolver<type>potri()
      • hipsolverZpotri()
      • hipsolverCpotri()
      • hipsolverDpotri()
      • hipsolverSpotri()
    • hipsolver<type>potrs_bufferSize()
      • hipsolverZpotrs_bufferSize()
      • hipsolverCpotrs_bufferSize()
      • hipsolverDpotrs_bufferSize()
      • hipsolverSpotrs_bufferSize()
    • hipsolver<type>potrsBatched_bufferSize()
      • hipsolverZpotrsBatched_bufferSize()
      • hipsolverCpotrsBatched_bufferSize()
      • hipsolverDpotrsBatched_bufferSize()
      • hipsolverSpotrsBatched_bufferSize()
    • hipsolver<type>potrs()
      • hipsolverZpotrs()
      • hipsolverCpotrs()
      • hipsolverDpotrs()
      • hipsolverSpotrs()
    • hipsolver<type>potrsBatched()
      • hipsolverZpotrsBatched()
      • hipsolverCpotrsBatched()
      • hipsolverDpotrsBatched()
      • hipsolverSpotrsBatched()
    • hipsolver<type>getrs_bufferSize()
      • hipsolverZgetrs_bufferSize()
      • hipsolverCgetrs_bufferSize()
      • hipsolverDgetrs_bufferSize()
      • hipsolverSgetrs_bufferSize()
    • hipsolver<type>getrs()
      • hipsolverZgetrs()
      • hipsolverCgetrs()
      • hipsolverDgetrs()
      • hipsolverSgetrs()
    • hipsolver<type><type>gesv_bufferSize()
      • hipsolverZZgesv_bufferSize()
      • hipsolverCCgesv_bufferSize()
      • hipsolverDDgesv_bufferSize()
      • hipsolverSSgesv_bufferSize()
    • hipsolver<type><type>gesv()
      • hipsolverZZgesv()
      • hipsolverCCgesv()
      • hipsolverDDgesv()
      • hipsolverSSgesv()
  • Least-squares solvers
    • hipsolver<type><type>gels_bufferSize()
      • hipsolverZZgels_bufferSize()
      • hipsolverCCgels_bufferSize()
      • hipsolverDDgels_bufferSize()
      • hipsolverSSgels_bufferSize()
    • hipsolver<type><type>gels()
      • hipsolverZZgels()
      • hipsolverCCgels()
      • hipsolverDDgels()
      • hipsolverSSgels()
  • Symmetric eigensolvers
    • hipsolver<type>syevd_bufferSize()
      • hipsolverDsyevd_bufferSize()
      • hipsolverSsyevd_bufferSize()
    • hipsolver<type>heevd_bufferSize()
      • hipsolverZheevd_bufferSize()
      • hipsolverCheevd_bufferSize()
    • hipsolver<type>syevd()
      • hipsolverDsyevd()
      • hipsolverSsyevd()
    • hipsolver<type>heevd()
      • hipsolverZheevd()
      • hipsolverCheevd()
    • hipsolver<type>syevj_bufferSize()
      • hipsolverDsyevj_bufferSize()
      • hipsolverSsyevj_bufferSize()
    • hipsolver<type>heevj_bufferSize()
      • hipsolverZheevj_bufferSize()
      • hipsolverCheevj_bufferSize()
    • hipsolver<type>syevjBatched_bufferSize()
      • hipsolverDsyevjBatched_bufferSize()
      • hipsolverSsyevjBatched_bufferSize()
    • hipsolver<type>heevjBatched_bufferSize()
      • hipsolverZheevjBatched_bufferSize()
      • hipsolverCheevjBatched_bufferSize()
    • hipsolver<type>syevj()
      • hipsolverDsyevj()
      • hipsolverSsyevj()
    • hipsolver<type>heevj()
      • hipsolverZheevj()
      • hipsolverCheevj()
    • hipsolver<type>syevjBatched()
      • hipsolverDsyevjBatched()
      • hipsolverSsyevjBatched()
    • hipsolver<type>heevjBatched()
      • hipsolverZheevjBatched()
      • hipsolverCheevjBatched()
    • hipsolver<type>sygvd_bufferSize()
      • hipsolverDsygvd_bufferSize()
      • hipsolverSsygvd_bufferSize()
    • hipsolver<type>hegvd_bufferSize()
      • hipsolverZhegvd_bufferSize()
      • hipsolverChegvd_bufferSize()
    • hipsolver<type>sygvd()
      • hipsolverDsygvd()
      • hipsolverSsygvd()
    • hipsolver<type>hegvd()
      • hipsolverZhegvd()
      • hipsolverChegvd()
    • hipsolver<type>sygvj_bufferSize()
      • hipsolverDsygvj_bufferSize()
      • hipsolverSsygvj_bufferSize()
    • hipsolver<type>hegvj_bufferSize()
      • hipsolverZhegvj_bufferSize()
      • hipsolverChegvj_bufferSize()
    • hipsolver<type>sygvj()
      • hipsolverDsygvj()
      • hipsolverSsygvj()
    • hipsolver<type>hegvj()
      • hipsolverZhegvj()
      • hipsolverChegvj()
  • Singular value decomposition
    • hipsolver<type>gesvd_bufferSize()
      • hipsolverZgesvd_bufferSize()
      • hipsolverCgesvd_bufferSize()
      • hipsolverDgesvd_bufferSize()
      • hipsolverSgesvd_bufferSize()
    • hipsolver<type>gesvd()
      • hipsolverZgesvd()
      • hipsolverCgesvd()
      • hipsolverDgesvd()
      • hipsolverSgesvd()
• LAPACK-like Functions
  • Symmetric eigensolvers
    • hipsolver<type>syevj_bufferSize()
      • hipsolverDsyevj_bufferSize()
      • hipsolverSsyevj_bufferSize()
    • hipsolver<type>heevj_bufferSize()
      • hipsolverZheevj_bufferSize()
      • hipsolverCheevj_bufferSize()
    • hipsolver<type>syevjBatched_bufferSize()
      • hipsolverDsyevjBatched_bufferSize()
      • hipsolverSsyevjBatched_bufferSize()
    • hipsolver<type>heevjBatched_bufferSize()
      • hipsolverZheevjBatched_bufferSize()
      • hipsolverCheevjBatched_bufferSize()
    • hipsolver<type>syevj()
      • hipsolverDsyevj()
      • hipsolverSsyevj()
    • hipsolver<type>heevj()
      • hipsolverZheevj()
      • hipsolverCheevj()
    • hipsolver<type>syevjBatched()
      • hipsolverDsyevjBatched()
      • hipsolverSsyevjBatched()
    • hipsolver<type>heevjBatched()
      • hipsolverZheevjBatched()
      • hipsolverCheevjBatched()
    • hipsolver<type>sygvj_bufferSize()
      • hipsolverDsygvj_bufferSize()
      • hipsolverSsygvj_bufferSize()
    • hipsolver<type>hegvj_bufferSize()
      • hipsolverZhegvj_bufferSize()
      • hipsolverChegvj_bufferSize()
    • hipsolver<type>sygvj()
      • hipsolverDsygvj()
      • hipsolverSsygvj()
    • hipsolver<type>hegvj()
      • hipsolverZhegvj()
      • hipsolverChegvj()
  • Singular value decomposition
    • hipsolver<type>gesvdj_bufferSize()
    • hipsolver<type>gesvdjBatched_bufferSize()
    • hipsolver<type>gesvdj()
    • hipsolver<type>gesvdjBatched()