mirror of
https://github.com/AdaCore/cvc5.git
synced 2026-02-12 12:32:16 -08:00
ea5e75d04a
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.
123 lines
3.3 KiB
ReStructuredText
123 lines
3.3 KiB
ReStructuredText
Arithmetic
|
|
============
|
|
|
|
|
|
Basic Arithmetic Term Builders
|
|
-------------------------------
|
|
.. autofunction:: cvc5.pythonic.Int
|
|
.. autofunction:: cvc5.pythonic.Real
|
|
.. autofunction:: cvc5.pythonic.IntVal
|
|
.. autofunction:: cvc5.pythonic.RealVal
|
|
.. autofunction:: cvc5.pythonic.RatVal
|
|
.. autofunction:: cvc5.pythonic.Q
|
|
.. autofunction:: cvc5.pythonic.IntSort
|
|
.. autofunction:: cvc5.pythonic.RealSort
|
|
.. autofunction:: cvc5.pythonic.FreshInt
|
|
.. autofunction:: cvc5.pythonic.Ints
|
|
.. autofunction:: cvc5.pythonic.IntVector
|
|
.. autofunction:: cvc5.pythonic.FreshReal
|
|
.. autofunction:: cvc5.pythonic.Reals
|
|
.. autofunction:: cvc5.pythonic.RealVector
|
|
|
|
|
|
Arithmetic Overloads
|
|
--------------------
|
|
|
|
See the following operator overloads for building arithmetic terms. These terms
|
|
can also be built with builder functions listed below.
|
|
|
|
addition (``+``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__add__`
|
|
|
|
subtraction (``-``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__sub__`
|
|
|
|
multiplication (``*``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__mul__`
|
|
|
|
division (``/``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__div__`
|
|
|
|
power (``**``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__pow__`
|
|
|
|
negation (``-``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__neg__`
|
|
|
|
greater than (``>``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__gt__`
|
|
|
|
less than (``<``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__lt__`
|
|
|
|
greater than or equal to (``>=``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__ge__`
|
|
|
|
less than or equal to (``<=``)
|
|
:py:meth:`cvc5.pythonic.ArithRef.__le__`
|
|
|
|
equal (``==``)
|
|
:py:meth:`cvc5.pythonic.ExprRef.__eq__`
|
|
|
|
not equal (``!=``)
|
|
:py:meth:`cvc5.pythonic.ExprRef.__ne__`
|
|
|
|
.. autofunction:: cvc5.pythonic.Add
|
|
.. autofunction:: cvc5.pythonic.Mult
|
|
.. autofunction:: cvc5.pythonic.Sub
|
|
.. autofunction:: cvc5.pythonic.UMinus
|
|
.. autofunction:: cvc5.pythonic.Div
|
|
.. autofunction:: cvc5.pythonic.Pow
|
|
.. autofunction:: cvc5.pythonic.IntsModulus
|
|
.. autofunction:: cvc5.pythonic.Leq
|
|
.. autofunction:: cvc5.pythonic.Geq
|
|
.. autofunction:: cvc5.pythonic.Lt
|
|
.. autofunction:: cvc5.pythonic.Gt
|
|
|
|
Other Arithmetic Operators
|
|
--------------------------
|
|
|
|
.. autofunction:: cvc5.pythonic.ToReal
|
|
.. autofunction:: cvc5.pythonic.ToInt
|
|
.. autofunction:: cvc5.pythonic.IsInt
|
|
.. autofunction:: cvc5.pythonic.Sqrt
|
|
.. autofunction:: cvc5.pythonic.Cbrt
|
|
|
|
Testers
|
|
-------------------
|
|
.. autofunction:: cvc5.pythonic.is_arith
|
|
.. autofunction:: cvc5.pythonic.is_int
|
|
.. autofunction:: cvc5.pythonic.is_real
|
|
.. autofunction:: cvc5.pythonic.is_int_value
|
|
.. autofunction:: cvc5.pythonic.is_rational_value
|
|
.. autofunction:: cvc5.pythonic.is_arith_sort
|
|
.. autofunction:: cvc5.pythonic.is_add
|
|
.. autofunction:: cvc5.pythonic.is_mul
|
|
.. autofunction:: cvc5.pythonic.is_sub
|
|
.. autofunction:: cvc5.pythonic.is_div
|
|
.. autofunction:: cvc5.pythonic.is_idiv
|
|
.. autofunction:: cvc5.pythonic.is_mod
|
|
.. autofunction:: cvc5.pythonic.is_le
|
|
.. autofunction:: cvc5.pythonic.is_lt
|
|
.. autofunction:: cvc5.pythonic.is_ge
|
|
.. autofunction:: cvc5.pythonic.is_gt
|
|
.. autofunction:: cvc5.pythonic.is_is_int
|
|
.. autofunction:: cvc5.pythonic.is_to_real
|
|
.. autofunction:: cvc5.pythonic.is_to_int
|
|
|
|
Classes (with overloads)
|
|
-------------------------
|
|
|
|
.. autoclass:: cvc5.pythonic.ArithSortRef
|
|
:members:
|
|
:special-members:
|
|
.. autoclass:: cvc5.pythonic.ArithRef
|
|
:members:
|
|
:special-members:
|
|
.. autoclass:: cvc5.pythonic.IntNumRef
|
|
:members:
|
|
:special-members:
|
|
.. autoclass:: cvc5.pythonic.RatNumRef
|
|
:members:
|
|
:special-members:
|