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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
.. meta::
:description: hipSOLVER documentation and API reference library
:keywords: hipSOLVER, rocSOLVER, ROCm, API, documentation
.. _refactor_helpers:
**********************************
Refactorization helper functions
**********************************
These are helper functions that control aspects of the hipSOLVER library. They are divided
into the following categories:
* :ref:`refactor_initialize` functions. Used to initialize and cleanup the library handle.
* :ref:`refactor_input` functions. Provide functionality to manipulate function input.
* :ref:`refactor_output` functions. Provide functionality to access function output.
* :ref:`refactor_parameters` functions. Provide functionality to manipulate parameters.
.. _refactor_initialize:
Handle set-up and tear-down
===============================
.. contents:: List of handle initialization functions
:local:
:backlinks: top
hipsolverRfCreate()
-----------------------------------------
.. doxygenfunction:: hipsolverRfCreate
hipsolverRfDestroy()
-----------------------------------------
.. doxygenfunction:: hipsolverRfDestroy
.. _refactor_input:
Input manipulation
===============================
.. contents:: List of input functions
:local:
:backlinks: top
hipsolverRfSetupDevice()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetupDevice
hipsolverRfSetupHost()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetupHost
.. _refactor_batch_setup_host:
hipsolverRfBatchSetupHost()
-----------------------------------------
.. doxygenfunction:: hipsolverRfBatchSetupHost
hipsolverRfAnalyze()
-----------------------------------------
.. doxygenfunction:: hipsolverRfAnalyze
.. _refactor_batch_analyze:
hipsolverRfBatchAnalyze()
-----------------------------------------
.. doxygenfunction:: hipsolverRfBatchAnalyze
hipsolverRfResetValues()
-----------------------------------------
.. doxygenfunction:: hipsolverRfResetValues
.. _refactor_batch_reset_values:
hipsolverRfBatchResetValues()
-----------------------------------------
.. doxygenfunction:: hipsolverRfBatchResetValues
.. _refactor_output:
Output manipulation
===============================
.. contents:: List of output functions
:local:
:backlinks: top
hipsolverRfAccessBundledFactorsDevice()
-----------------------------------------
.. doxygenfunction:: hipsolverRfAccessBundledFactorsDevice
hipsolverRfExtractBundledFactorsHost()
-----------------------------------------
.. doxygenfunction:: hipsolverRfExtractBundledFactorsHost
hipsolverRfExtractSplitFactorsHost()
-----------------------------------------
.. doxygenfunction:: hipsolverRfExtractSplitFactorsHost
.. _refactor_batch_zero_pivot:
hipsolverRfBatchZeroPivot()
-----------------------------------------
.. doxygenfunction:: hipsolverRfBatchZeroPivot
.. _refactor_parameters:
Parameter manipulation
===============================
.. contents:: List of parameter functions
:local:
:backlinks: top
hipsolverRfGet_Algs()
-----------------------------------------
.. doxygenfunction:: hipsolverRfGet_Algs
hipsolverRfGetMatrixFormat()
-----------------------------------------
.. doxygenfunction:: hipsolverRfGetMatrixFormat
hipsolverRfGetNumericBoostReport()
-----------------------------------------
.. doxygenfunction:: hipsolverRfGetNumericBoostReport
hipsolverRfGetNumericProperties()
-----------------------------------------
.. doxygenfunction:: hipsolverRfGetNumericProperties
hipsolverRfGetResetValuesFastMode()
-----------------------------------------
.. doxygenfunction:: hipsolverRfGetResetValuesFastMode
.. _refactor_set_algs:
hipsolverRfSetAlgs()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetAlgs
.. _refactor_set_matrix_format:
hipsolverRfSetMatrixFormat()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetMatrixFormat
.. _refactor_set_numeric_properties:
hipsolverRfSetNumericProperties()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetNumericProperties
.. _refactor_set_reset_values_fast_mode:
hipsolverRfSetResetValuesFastMode()
-----------------------------------------
.. doxygenfunction:: hipsolverRfSetResetValuesFastMode
|