Skip to main content
`Ctrl`+`K`

# hipSOLVER helper functions

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

- Handle setup and teardown: Functions to initialize and cleanup the library handle.

- Stream manipulation: Functions to manipulate streams.

- Determinism manipulation: Functions to manipulate function determinism.

- Gesvdj parameter manipulation: Functions to manipulate gesvdj parameters.

- Syevj parameter manipulation: Functions to manipulate syevj parameters.

## Handle setup and teardown

### hipsolverCreate()

hipsolverStatus_t hipsolverCreate(hipsolverHandle_t *handle)

### hipsolverDestroy()

hipsolverStatus_t hipsolverDestroy(hipsolverHandle_t handle)

## Stream manipulation

### hipsolverSetStream()

hipsolverStatus_t hipsolverSetStream(hipsolverHandle_t handle, hipStream_t streamId)

### hipsolverGetStream()

hipsolverStatus_t hipsolverGetStream(hipsolverHandle_t handle, hipStream_t *streamId)

## Determinism manipulation

### hipsolverSetDeterministicMode()

hipsolverStatus_t hipsolverSetDeterministicMode(hipsolverHandle_t handle, hipsolverDeterministicMode_t mode)

### hipsolverGetDeterministicMode()

hipsolverStatus_t hipsolverGetDeterministicMode(hipsolverHandle_t handle, hipsolverDeterministicMode_t *mode)

## Gesvdj parameter manipulation

### hipsolverCreateGesvdjInfo()

hipsolverStatus_t hipsolverCreateGesvdjInfo(hipsolverGesvdjInfo_t *info)

### hipsolverDestroyGesvdjInfo()

hipsolverStatus_t hipsolverDestroyGesvdjInfo(hipsolverGesvdjInfo_t info)

### hipsolverXgesvdjSetMaxSweeps()

hipsolverStatus_t hipsolverXgesvdjSetMaxSweeps(hipsolverGesvdjInfo_t info, int max_sweeps)

### hipsolverXgesvdjSetSortEig()

hipsolverStatus_t hipsolverXgesvdjSetSortEig(hipsolverGesvdjInfo_t info, int sort_eig)

### hipsolverXgesvdjSetTolerance()

hipsolverStatus_t hipsolverXgesvdjSetTolerance(hipsolverGesvdjInfo_t info, double tolerance)

### hipsolverXgesvdjGetResidual()

hipsolverStatus_t hipsolverXgesvdjGetResidual(hipsolverHandle_t handle, hipsolverGesvdjInfo_t info, double *residual)

### hipsolverXgesvdjGetSweeps()

hipsolverStatus_t hipsolverXgesvdjGetSweeps(hipsolverHandle_t handle, hipsolverGesvdjInfo_t info, int *executed_sweeps)

## Syevj parameter manipulation

### 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)