summaryrefslogtreecommitdiff
path: root/docs/cpp/kind.rst
blob: 579407c8542f44e5bd793ff4108b9020ace4f97e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Kind
====

Every :cpp:class:`Term <cvc5::api::Term>` has a kind which represents its type,
for example whether it is an equality (:cpp:enumerator:`EQUAL
<cvc5::api::Kind::EQUAL>`), a conjunction (:cpp:enumerator:`AND
<cvc5::api::Kind::AND>`), or a bitvector addition
(:cpp:enumerator:`BITVECTOR_PLUS <cvc5::api::Kind::BITVECTOR_PLUS>`).
#ifndef DOXYGEN_SKIP
Note that the API type :cpp:enum:`cvc5::api::Kind` roughly corresponds to
:cpp:enum:`cvc5::Kind`, but is a different type. It hides internal kinds that
should not be exported to the API, and maps all kinds that we want to export
to its corresponding internal kinds.
#endif

.. doxygenenum:: cvc5::api::Kind
    :project: cvc5

.. doxygenstruct:: std::hash< cvc5::api::Kind >
    :project: std
    :members:
    :undoc-members:
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback