File: optioninfo.rst

package info (click to toggle)
bitwuzla 0.8.2-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 43,292 kB
  • sloc: cpp: 94,870; python: 3,254; ansic: 1,613; sh: 50; makefile: 10
file content (29 lines) | stat: -rw-r--r-- 679 bytes parent folder | download | duplicates (2)
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
OptionInfo
-----------

The configuration data of an option.

Bitwuzla offers a compact way to retrieve all information about a configuration
option :cpp:enum:`bitwuzla::Option` as a :cpp:struct:`bitwuzla::OptionInfo`
object via :cpp:func:`bitwuzla::OptionInfo::OptionInfo()`.
This object is created per option and can be queried for

- long and short names
- option description
- default value
- minimum/maximum/default values (for numeric options)
- available option modes (for options with modes).

----

- class :cpp:class:`bitwuzla::OptionInfo`

----

:code:`namespace bitwuzla {`

.. doxygenstruct:: bitwuzla::OptionInfo
    :project: Bitwuzla_cpp
    :members:

:code:`}`