File: helpers.rst

package info (click to toggle)
rocsolver 6.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 17,876 kB
  • sloc: cpp: 151,850; python: 2,275; sh: 875; objc: 642; ansic: 402; makefile: 71; xml: 26
file content (94 lines) | stat: -rw-r--r-- 2,387 bytes parent folder | download
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
.. meta::
  :description: rocSOLVER documentation and API reference library
  :keywords: rocSOLVER, ROCm, API, documentation

.. _helpers:

*****************************************************
rocSOLVER library and logging functions
*****************************************************

These are helper functions that retrieve information and control some functions of the library.
The helper functions are divided into the following categories:

* :ref:`lib_info`. These functions return information about the library version.
* :ref:`algo_select`. Functions to select different algorithm modes of certain APIs.
* :ref:`api_logging`. These functions control the :ref:`logging-label` capabilities.



.. _lib_info:

Library information
===============================

.. contents:: List of library information functions
   :local:
   :backlinks: top

rocsolver_get_version_string()
------------------------------------
.. doxygenfunction:: rocsolver_get_version_string

rocsolver_get_version_string_size()
------------------------------------
.. doxygenfunction:: rocsolver_get_version_string_size



.. _algo_select:

Algorithm selection
===============================

.. contents:: List of algorithm selection functions
   :local:
   :backlinks: top

rocsolver_set_alg_mode()
------------------------------------
.. doxygenfunction:: rocsolver_set_alg_mode

rocsolver_get_alg_mode()
------------------------------------
.. doxygenfunction:: rocsolver_get_alg_mode



.. _api_logging:

Logging functions
===============================

.. contents:: List of logging functions
   :local:
   :backlinks: top

rocsolver_log_begin()
---------------------------------
.. doxygenfunction:: rocsolver_log_begin

rocsolver_log_end()
---------------------------------
.. doxygenfunction:: rocsolver_log_end

rocsolver_log_set_layer_mode()
---------------------------------
.. doxygenfunction:: rocsolver_log_set_layer_mode

rocsolver_log_set_max_levels()
---------------------------------
.. doxygenfunction:: rocsolver_log_set_max_levels

rocsolver_log_restore_defaults()
---------------------------------
.. doxygenfunction:: rocsolver_log_restore_defaults

rocsolver_log_write_profile()
---------------------------------
.. doxygenfunction:: rocsolver_log_write_profile

rocsolver_log_flush_profile()
---------------------------------
.. doxygenfunction:: rocsolver_log_flush_profile