1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
.. _api_helpers:
****************
Helper Functions
****************
These are helper functions that control aspects of the hipSOLVER library. These are divided
into two categories:
* :ref:`initialize` functions. Used to initialize and cleanup the library handle.
* :ref:`stream` functions. Provide functionality to manipulate streams.
* :ref:`gesvdj_info` functions. Provide functionality to manipulate gesvdj parameters.
* :ref:`syevj_info` functions. Provide functionality to manipulate syevj parameters.
.. _initialize:
Handle set-up and tear-down
===============================
.. contents:: List of handle initialization functions
:local:
:backlinks: top
hipsolverCreate()
---------------------------------
.. doxygenfunction:: hipsolverCreate
hipsolverDestroy()
---------------------------------
.. doxygenfunction:: hipsolverDestroy
.. _stream:
Stream manipulation
==============================
.. contents:: List of stream manipulation functions
:local:
:backlinks: top
hipsolverSetStream()
---------------------------------
.. doxygenfunction:: hipsolverSetStream
hipsolverGetStream()
---------------------------------
.. doxygenfunction:: hipsolverGetStream
.. _gesvdj_info:
Gesvdj parameter manipulation
===============================
.. contents:: List of gesvdj parameter functions
:local:
:backlinks: top
hipsolverCreateGesvdjInfo()
---------------------------------
.. doxygenfunction:: hipsolverCreateGesvdjInfo
hipsolverDestroyGesvdjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDestroyGesvdjInfo
.. _gesvdj_set_max_sweeps:
hipsolverXgesvdjSetMaxSweeps()
---------------------------------
.. doxygenfunction:: hipsolverXgesvdjSetMaxSweeps
.. _gesvdj_set_sort_eig:
hipsolverXgesvdjSetSortEig()
---------------------------------
.. doxygenfunction:: hipsolverXgesvdjSetSortEig
.. _gesvdj_set_tolerance:
hipsolverXgesvdjSetTolerance()
---------------------------------
.. doxygenfunction:: hipsolverXgesvdjSetTolerance
.. _gesvdj_get_residual:
hipsolverXgesvdjGetResidual()
---------------------------------
.. doxygenfunction:: hipsolverXgesvdjGetResidual
.. _gesvdj_get_sweeps:
hipsolverXgesvdjGetSweeps()
---------------------------------
.. doxygenfunction:: hipsolverXgesvdjGetSweeps
.. _syevj_info:
Syevj parameter manipulation
===============================
.. contents:: List of syevj parameter functions
:local:
:backlinks: top
hipsolverCreateSyevjInfo()
---------------------------------
.. doxygenfunction:: hipsolverCreateSyevjInfo
hipsolverDestroySyevjInfo()
---------------------------------
.. doxygenfunction:: hipsolverDestroySyevjInfo
.. _syevj_set_max_sweeps:
hipsolverXsyevjSetMaxSweeps()
---------------------------------
.. doxygenfunction:: hipsolverXsyevjSetMaxSweeps
.. _syevj_set_sort_eig:
hipsolverXsyevjSetSortEig()
---------------------------------
.. doxygenfunction:: hipsolverXsyevjSetSortEig
.. _syevj_set_tolerance:
hipsolverXsyevjSetTolerance()
---------------------------------
.. doxygenfunction:: hipsolverXsyevjSetTolerance
.. _syevj_get_residual:
hipsolverXsyevjGetResidual()
---------------------------------
.. doxygenfunction:: hipsolverXsyevjGetResidual
.. _syevj_get_sweeps:
hipsolverXsyevjGetSweeps()
---------------------------------
.. doxygenfunction:: hipsolverXsyevjGetSweeps
|