2.2. Helper Functions¶
These are helper functions that control aspects of the hipSOLVER library. These are divided into two categories:
Handle set-up and tear-down functions. Used to initialize and cleanup the library handle.
Stream manipulation functions. Provide functionality to manipulate streams.
Syevj parameter manipulation functions. Provide functionality to manipulate syevj parameters.
2.2.1. Handle set-up and tear-down¶
List of handle initialization functions
hipsolverCreate()¶
-
hipsolverStatus_t
hipsolverCreate
(hipsolverHandle_t *handle)¶
hipsolverDestroy()¶
-
hipsolverStatus_t
hipsolverDestroy
(hipsolverHandle_t handle)¶
2.2.2. Stream manipulation¶
List of stream manipulation functions
hipsolverSetStream()¶
-
hipsolverStatus_t
hipsolverSetStream
(hipsolverHandle_t handle, hipStream_t streamId)¶
hipsolverGetStream()¶
-
hipsolverStatus_t
hipsolverGetStream
(hipsolverHandle_t handle, hipStream_t *streamId)¶
2.2.3. Syevj parameter manipulation¶
List of syevj parameter functions
hipsolverCreateSyevjInfo()¶
-
hipsolverStatus_t
hipsolverCreateSyevjInfo
(hipsolverSyevjInfo_t *info)¶
hipsolverDestroySyevjInfo()¶
-
hipsolverStatus_t
hipsolverDestroySyevjInfo
(hipsolverSyevjInfo_t info)¶
hipsolverXsyevjSetMaxSweeps()¶
-
hipsolverStatus_t
hipsolverXsyevjSetMaxSweeps
(hipsolverSyevjInfo_t info, int max_sweeps)¶
hipsolverXsyevjSetSortEig()¶
-
hipsolverStatus_t
hipsolverXsyevjSetSortEig
(hipsolverSyevjInfo_t info, int sort_eig)¶
hipsolverXsyevjSetTolerance()¶
-
hipsolverStatus_t
hipsolverXsyevjSetTolerance
(hipsolverSyevjInfo_t info, double tolerance)¶
hipsolverXsyevjGetResidual()¶
-
hipsolverStatus_t
hipsolverXsyevjGetResidual
(hipsolverHandle_t handle, hipsolverSyevjInfo_t info, double *residual)¶
hipsolverXsyevjGetSweeps()¶
-
hipsolverStatus_t
hipsolverXsyevjGetSweeps
(hipsolverHandle_t handle, hipsolverSyevjInfo_t info, int *executed_sweeps)¶