Files
cvc5/docs/api/python/pythonic/array.rst
Gereon Kremer ea5e75d04a Integrate pythonic api (#8131)
We decided we want to ship the pythonic API together with our base python API.
This PR adds a new target cvc5_python_api that first builds the base python API and then copies the pythonic API over. Furthermore we now use the cvc5.pythonic module to generate the corresponding documentation.
2022-03-03 02:16:09 +00:00

46 lines
1.0 KiB
ReStructuredText

Arrays
============
Basic Array Term Builders
-------------------------
.. autofunction:: cvc5.pythonic.Array
.. autofunction:: cvc5.pythonic.ConstArray
.. autofunction:: cvc5.pythonic.K
.. autofunction:: cvc5.pythonic.ArraySort
Array Operators
-------------------
.. autofunction:: cvc5.pythonic.Select
.. autofunction:: cvc5.pythonic.Store
.. autofunction:: cvc5.pythonic.Update
See the following operator overloads for building other kinds of array
terms:
* ``select``: :py:meth:`cvc5.pythonic.ArrayRef.__getitem__`
Testers
-------------------
.. autofunction:: cvc5.pythonic.is_array_sort
.. autofunction:: cvc5.pythonic.is_array
.. autofunction:: cvc5.pythonic.is_const_array
.. autofunction:: cvc5.pythonic.is_K
.. autofunction:: cvc5.pythonic.is_select
.. autofunction:: cvc5.pythonic.is_store
.. autofunction:: cvc5.pythonic.is_update
Classes (with overloads)
------------------------
.. autoclass:: cvc5.pythonic.ArraySortRef
:members:
:special-members:
.. autoclass:: cvc5.pythonic.ArrayRef
:members:
:special-members: