Files
TheRock/rocm-libraries/projects/hipsolver/docs/reference/dense-api/helpers.rst
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

198 lines
4.6 KiB
ReStructuredText

.. meta::
:description: hipSOLVER dense matrix helper functions API documentation
:keywords: hipSOLVER, rocSOLVER, ROCm, API, documentation, dense matrix
.. _dense_helpers:
*****************************************
Dense matrix helper functions
*****************************************
These are helper functions that control aspects of the hipSOLVER library. They are divided
into the following categories:
* :ref:`dense_initialize`: Functions to initialize and clean up the library handle.
* :ref:`dense_stream`: Functions to manipulate streams.
* :ref:`dense_determinism`: Functions to manipulate function determinism.
* :ref:`dense_gesvdj_info`: Functions to manipulate gesvdj parameters.
* :ref:`dense_syevj_info`: Functions to manipulate syevj parameters.
* :ref:`dense_params`: Functions to manipulate other parameters.
.. _dense_initialize:
Handle setup and teardown
===============================
.. contents:: List of handle initialization functions
:local:
:backlinks: top
hipsolverDnCreate()
---------------------------------
.. doxygenfunction:: hipsolverDnCreate
hipsolverDnDestroy()
---------------------------------
.. doxygenfunction:: hipsolverDnDestroy
.. _dense_stream:
Stream manipulation
==============================
.. contents:: List of stream manipulation functions
:local:
:backlinks: top
hipsolverDnSetStream()
---------------------------------
.. doxygenfunction:: hipsolverDnSetStream
hipsolverDnGetStream()
---------------------------------
.. doxygenfunction:: hipsolverDnGetStream
.. _dense_determinism:
Determinism manipulation
==============================
.. contents:: List of deterministic mode manipulation functions
:local:
:backlinks: top
hipsolverDnSetDeterministicMode()
----------------------------------
.. doxygenfunction:: hipsolverDnSetDeterministicMode
hipsolverDnGetDeterministicMode()
----------------------------------
.. doxygenfunction:: hipsolverDnGetDeterministicMode
.. _dense_gesvdj_info:
Gesvdj parameter manipulation
===============================
.. contents:: List of gesvdj parameter functions
:local:
:backlinks: top
hipsolverDnCreateGesvdjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDnCreateGesvdjInfo
hipsolverDnDestroyGesvdjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDnDestroyGesvdjInfo
.. _dense_gesvdj_set_max_sweeps:
hipsolverDnXgesvdjSetMaxSweeps()
---------------------------------
.. doxygenfunction:: hipsolverDnXgesvdjSetMaxSweeps
.. _dense_gesvdj_set_sort_eig:
hipsolverDnXgesvdjSetSortEig()
---------------------------------
.. doxygenfunction:: hipsolverDnXgesvdjSetSortEig
.. _dense_gesvdj_set_tolerance:
hipsolverDnXgesvdjSetTolerance()
---------------------------------
.. doxygenfunction:: hipsolverDnXgesvdjSetTolerance
.. _dense_gesvdj_get_residual:
hipsolverDnXgesvdjGetResidual()
---------------------------------
.. doxygenfunction:: hipsolverDnXgesvdjGetResidual
.. _dense_gesvdj_get_sweeps:
hipsolverDnXgesvdjGetSweeps()
---------------------------------
.. doxygenfunction:: hipsolverDnXgesvdjGetSweeps
.. _dense_syevj_info:
Syevj parameter manipulation
===============================
.. contents:: List of syevj parameter functions
:local:
:backlinks: top
hipsolverDnCreateSyevjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDnCreateSyevjInfo
hipsolverDnDestroySyevjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDnDestroySyevjInfo
.. _dense_syevj_set_max_sweeps:
hipsolverDnXsyevjSetMaxSweeps()
---------------------------------
.. doxygenfunction:: hipsolverDnXsyevjSetMaxSweeps
.. _dense_syevj_set_sort_eig:
hipsolverDnXsyevjSetSortEig()
---------------------------------
.. doxygenfunction:: hipsolverDnXsyevjSetSortEig
.. _dense_syevj_set_tolerance:
hipsolverDnXsyevjSetTolerance()
---------------------------------
.. doxygenfunction:: hipsolverDnXsyevjSetTolerance
.. _dense_syevj_get_residual:
hipsolverDnXsyevjGetResidual()
---------------------------------
.. doxygenfunction:: hipsolverDnXsyevjGetResidual
.. _dense_syevj_get_sweeps:
hipsolverDnXsyevjGetSweeps()
---------------------------------
.. doxygenfunction:: hipsolverDnXsyevjGetSweeps
.. _dense_params:
Other parameter manipulation
===============================
.. contents:: List of other parameter functions
:local:
:backlinks: top
hipsolverDnCreateParams()
---------------------------------
.. doxygenfunction:: hipsolverDnCreateParams
hipsolverDnDestroyParams()
---------------------------------
.. doxygenfunction:: hipsolverDnDestroyParams
hipsolverDnSetAdvOptions()
---------------------------------
.. doxygenfunction:: hipsolverDnSetAdvOptions