3.2. Helper Functions

These are helper functions that control aspects of the hipSOLVER library. These are divided into two categories:

3.2.1. Handle set-up and tear-down

hipsolverDnCreate()

hipsolverStatus_t hipsolverDnCreate(hipsolverHandle_t *handle)

An alias for hipsolverCreate.

hipsolverDnDestroy()

hipsolverStatus_t hipsolverDnDestroy(hipsolverHandle_t handle)

An alias for hipsolverDestroy.

3.2.2. Stream manipulation

hipsolverDnSetStream()

hipsolverStatus_t hipsolverDnSetStream(hipsolverHandle_t handle, hipStream_t streamId)

An alias for hipsolverSetStream.

hipsolverDnGetStream()

hipsolverStatus_t hipsolverDnGetStream(hipsolverHandle_t handle, hipStream_t *streamId)

An alias for hipsolverGetStream.

3.2.3. Gesvdj parameter manipulation

hipsolverDnCreateGesvdjInfo()

hipsolverStatus_t hipsolverDnCreateGesvdjInfo(hipsolverGesvdjInfo_t *info)

hipsolverDnDestroyGesvdjInfo()

hipsolverStatus_t hipsolverDnDestroyGesvdjInfo(hipsolverGesvdjInfo_t info)

hipsolverDnXgesvdjSetMaxSweeps()

hipsolverStatus_t hipsolverDnXgesvdjSetMaxSweeps(hipsolverGesvdjInfo_t info, int max_sweeps)

hipsolverDnXgesvdjSetSortEig()

hipsolverStatus_t hipsolverDnXgesvdjSetSortEig(hipsolverGesvdjInfo_t info, int sort_eig)

hipsolverDnXgesvdjSetTolerance()

hipsolverStatus_t hipsolverDnXgesvdjSetTolerance(hipsolverGesvdjInfo_t info, double tolerance)

hipsolverDnXgesvdjGetResidual()

hipsolverStatus_t hipsolverDnXgesvdjGetResidual(hipsolverDnHandle_t handle, hipsolverGesvdjInfo_t info, double *residual)

hipsolverDnXgesvdjGetSweeps()

hipsolverStatus_t hipsolverDnXgesvdjGetSweeps(hipsolverDnHandle_t handle, hipsolverGesvdjInfo_t info, int *executed_sweeps)

3.2.4. Syevj parameter manipulation

hipsolverDnCreateSyevjInfo()

hipsolverStatus_t hipsolverDnCreateSyevjInfo(hipsolverSyevjInfo_t *info)

hipsolverDnDestroySyevjInfo()

hipsolverStatus_t hipsolverDnDestroySyevjInfo(hipsolverSyevjInfo_t info)

hipsolverDnXsyevjSetMaxSweeps()

hipsolverStatus_t hipsolverDnXsyevjSetMaxSweeps(hipsolverSyevjInfo_t info, int max_sweeps)

hipsolverDnXsyevjSetSortEig()

hipsolverStatus_t hipsolverDnXsyevjSetSortEig(hipsolverSyevjInfo_t info, int sort_eig)

hipsolverDnXsyevjSetTolerance()

hipsolverStatus_t hipsolverDnXsyevjSetTolerance(hipsolverSyevjInfo_t info, double tolerance)

hipsolverDnXsyevjGetResidual()

hipsolverStatus_t hipsolverDnXsyevjGetResidual(hipsolverDnHandle_t handle, hipsolverSyevjInfo_t info, double *residual)

hipsolverDnXsyevjGetSweeps()

hipsolverStatus_t hipsolverDnXsyevjGetSweeps(hipsolverDnHandle_t handle, hipsolverSyevjInfo_t info, int *executed_sweeps)