File: options.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 (42 lines) | stat: -rw-r--r-- 1,258 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
30
31
32
33
34
35
36
37
38
39
40
41
42
Options
--------

A :cpp:class:`bitwuzla::Bitwuzla` instance is created from a configuration
options :cpp:class:`bitwuzla::Options` instance.

.. note::

   This options instance must be configured before creating the Bitwuzla
   instance. **After** the Bitwuzla instance is created, configuration options
   are fixed and **cannot** be changed.

Every option can be configured via
:cpp:func:`void bitwuzla::Options::set(const std::string &lng, const std::string &value)`.
Additionally, Boolean and numeric options are configured via
:cpp:func:`void bitwuzla::Options::set(Option option, uint64_t value)`, and
options with modes are configured via
:cpp:func:`void bitwuzla::Options::set(Option option, const std::string& value)`.
The option kind is defined via :cpp:enum:`bitwuzla::Option`.
A **comprehensive list** of all configurable options is available
:doc:`here <cpp/enums/option>`.

More information on and an example for how to configure and query configuration
options is :doc:`here </cpp/options>`.

.. note::

  Some options are labeled as "expert" options. Use with caution.

----

- class :cpp:class:`bitwuzla::Options`

----

:code:`namespace bitwuzla {`

.. doxygenclass:: bitwuzla::Options
    :project: Bitwuzla_cpp
    :members:

:code:`}`