Skip to main content
`Ctrl`+`K`

# Dense matrix 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 clean up 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.

- Other parameter manipulation: Functions to manipulate other parameters.

## Handle setup and teardown

### hipsolverDnCreate()

hipsolverStatus_t hipsolverDnCreate(hipsolverHandle_t *handle)

  An alias for hipsolverCreate.

### hipsolverDnDestroy()

hipsolverStatus_t hipsolverDnDestroy(hipsolverHandle_t handle)

  An alias for hipsolverDestroy.

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

## Determinism manipulation

### hipsolverDnSetDeterministicMode()

hipsolverStatus_t hipsolverDnSetDeterministicMode(hipsolverHandle_t handle, hipsolverDeterministicMode_t mode)

  An alias for hipsolverSetDeterministicMode.

### hipsolverDnGetDeterministicMode()

hipsolverStatus_t hipsolverDnGetDeterministicMode(hipsolverHandle_t handle, hipsolverDeterministicMode_t *mode)

  An alias for hipsolverGetDeterministicMode.

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

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

## Other parameter manipulation

### hipsolverDnCreateParams()

hipsolverStatus_t hipsolverDnCreateParams(hipsolverDnParams_t *params)

### hipsolverDnDestroyParams()

hipsolverStatus_t hipsolverDnDestroyParams(hipsolverDnParams_t params)

### hipsolverDnSetAdvOptions()

hipsolverStatus_t hipsolverDnSetAdvOptions(hipsolverDnParams_t params, hipsolverDnFunction_t func, hipsolverAlgMode_t alg)