File: exceptions.rst

package info (click to toggle)
cvc5 1.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 87,260 kB
  • sloc: cpp: 383,850; java: 12,207; python: 12,090; sh: 5,679; ansic: 4,729; lisp: 763; perl: 208; makefile: 38
file content (36 lines) | stat: -rw-r--r-- 1,226 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
Exceptions
==========

The cvc5 API communicates certain errors using exceptions. We broadly
distinguish two types of exceptions: :cpp:class:`CVC5ApiException
<cvc5::CVC5ApiException>` and :cpp:class:`CVC5ApiRecoverableException
<cvc5::CVC5ApiRecoverableException>` (which is derived from
:cpp:class:`CVC5ApiException <cvc5::CVC5ApiException>`).

If any method fails with a :cpp:class:`CVC5ApiRecoverableException
<cvc5::CVC5ApiRecoverableException>`, the solver behaves as if the failing
method was not called. The solver can still be used safely.

If, however, a method fails with a :cpp:class:`CVC5ApiException
<cvc5::CVC5ApiException>`, the associated object may be in an unsafe state
and it should no longer be used.

If the :cpp:class:`cvc5::parser::InputParser` encounters an error, it will
throw a :cpp:class:`cvc5::parser::ParserException
<cvc5::parser::ParserException>`.
If thrown, API objects can still be used

.. doxygenclass:: cvc5::CVC5ApiException
    :project: cvc5
    :members:
    :undoc-members:

.. doxygenclass:: cvc5::CVC5ApiRecoverableException
    :project: cvc5
    :members:
    :undoc-members:

.. doxygenclass:: cvc5::parser::ParserException
    :project: cvc5
    :members:
    :undoc-members: