-from collections import defaultdict, Set
+from collections import defaultdict
from fractions import Fraction
+from functools import wraps
import sys
+from cython.operator cimport dereference, preincrement
+
from libc.stdint cimport int32_t, int64_t, uint32_t, uint64_t
from libc.stddef cimport wchar_t
+from libcpp cimport bool as c_bool
from libcpp.pair cimport pair
from libcpp.set cimport set as c_set
from libcpp.string cimport string
from cvc5 cimport DatatypeDecl as c_DatatypeDecl
from cvc5 cimport DatatypeSelector as c_DatatypeSelector
from cvc5 cimport Result as c_Result
-from cvc5 cimport RoundingMode as c_RoundingMode
+from cvc5 cimport SynthResult as c_SynthResult
from cvc5 cimport Op as c_Op
+from cvc5 cimport OptionInfo as c_OptionInfo
+from cvc5 cimport holds as c_holds
+from cvc5 cimport getVariant as c_getVariant
from cvc5 cimport Solver as c_Solver
+from cvc5 cimport Statistics as c_Statistics
+from cvc5 cimport Stat as c_Stat
from cvc5 cimport Grammar as c_Grammar
from cvc5 cimport Sort as c_Sort
-from cvc5 cimport ROUND_NEAREST_TIES_TO_EVEN, ROUND_TOWARD_POSITIVE
-from cvc5 cimport ROUND_TOWARD_NEGATIVE, ROUND_TOWARD_ZERO
-from cvc5 cimport ROUND_NEAREST_TIES_TO_AWAY
from cvc5 cimport Term as c_Term
from cvc5 cimport hash as c_hash
from cvc5 cimport wstring as c_wstring
from cvc5 cimport tuple as c_tuple
from cvc5 cimport get0, get1, get2
from cvc5kinds cimport Kind as c_Kind
+from cvc5types cimport BlockModelsMode as c_BlockModelsMode
+from cvc5types cimport RoundingMode as c_RoundingMode
+from cvc5types cimport UnknownExplanation as c_UnknownExplanation
cdef extern from "Python.h":
wchar_t* PyUnicode_AsWideCharString(object, Py_ssize_t *)
object PyUnicode_FromWideChar(const wchar_t*, Py_ssize_t)
void PyMem_Free(void*)
-################################## DECORATORS #################################
-def expand_list_arg(num_req_args=0):
- '''
- Creates a decorator that looks at index num_req_args of the args,
- if it's a list, it expands it before calling the function.
- '''
- def decorator(func):
- def wrapper(owner, *args):
- if len(args) == num_req_args + 1 and \
- isinstance(args[num_req_args], list):
- args = list(args[:num_req_args]) + args[num_req_args]
- return func(owner, *args)
- return wrapper
- return decorator
-###############################################################################
-
# Style Guidelines
### Using PEP-8 spacing recommendations
### Limit linewidth to 79 characters
cdef class Datatype:
- """Wrapper class for :cpp:class:`cvc5::api::Datatype`."""
+ """
+ A cvc5 datatype.
+
+ Wrapper class for the C++ class :cpp:class:`cvc5::Datatype`.
+ """
cdef c_Datatype cd
cdef Solver solver
def __cinit__(self, Solver solver):
self.solver = solver
def __getitem__(self, index):
- """Return a constructor by index or by name."""
+ """
+ Get the datatype constructor with the given index, where index can
+ be either a numeric id starting with zero, or the name of the
+ constructor. In the latter case, this is a linear search through the
+ constructors, so in case of multiple, similarly-named constructors,
+ the first is returned.
+
+ :param index: The id or name of the datatype constructor.
+ :return: The matching datatype constructor.
+ """
cdef DatatypeConstructor dc = DatatypeConstructor(self.solver)
if isinstance(index, int) and index >= 0:
dc.cdc = self.cd[(<int?> index)]
return dc
def getConstructor(self, str name):
- """Return a constructor by name."""
+ """
+ :param name: The name of the constructor.
+ :return: A constructor by name.
+ """
cdef DatatypeConstructor dc = DatatypeConstructor(self.solver)
dc.cdc = self.cd.getConstructor(name.encode())
return dc
- def getConstructorTerm(self, str name):
- """:return: the term representing the datatype constructor with the given name (see :cpp:func:`Datatype::getConstructorTerm() <cvc5::api::Datatype::getConstructorTerm>`)."""
- cdef Term term = Term(self.solver)
- term.cterm = self.cd.getConstructorTerm(name.encode())
- return term
-
def getSelector(self, str name):
- """Return a selector by name."""
+ """
+ :param name: The name of the selector..
+ :return: A selector by name.
+ """
cdef DatatypeSelector ds = DatatypeSelector(self.solver)
ds.cds = self.cd.getSelector(name.encode())
return ds
def getName(self):
+ """
+ :return: The name of the datatype.
+ """
return self.cd.getName().decode()
def getNumConstructors(self):
- """:return: number of constructors."""
+ """
+ :return: The number of constructors in this datatype.
+ """
return self.cd.getNumConstructors()
+ def getParameters(self):
+ """
+ :return: The parameters of this datatype, if it is parametric. An
+ exception is thrown if this datatype is not parametric.
+ """
+ param_sorts = []
+ for s in self.cd.getParameters():
+ sort = Sort(self.solver)
+ sort.csort = s
+ param_sorts.append(sort)
+ return param_sorts
+
def isParametric(self):
- """:return: whether this datatype is parametric."""
+ """
+ .. warning:: This method is experimental and may change in future
+ versions.
+ :return: True if this datatype is parametric.
+ """
return self.cd.isParametric()
def isCodatatype(self):
- """:return: whether this datatype corresponds to a co-datatype."""
+ """
+ :return: True if this datatype corresponds to a co-datatype.
+ """
return self.cd.isCodatatype()
def isTuple(self):
- """:return: whether this datatype corresponds to a tuple."""
+ """
+ :return: True if this datatype corresponds to a tuple.
+ """
return self.cd.isTuple()
def isRecord(self):
- """:return: whether this datatype corresponds to a record."""
+ """
+ .. warning:: This method is experimental and may change in future
+ versions.
+ :return: True if this datatype corresponds to a record.
+ """
return self.cd.isRecord()
def isFinite(self):
- """:return: whether this datatype is finite."""
+ """
+ :return: True if this datatype is finite.
+ """
return self.cd.isFinite()
def isWellFounded(self):
- """:return: whether this datatype is well-founded (see :cpp:func:`Datatype::isWellFounded() <cvc5::api::Datatype::isWellFounded>`)."""
+ """
+ Is this datatype well-founded?
+
+ If this datatype is not a codatatype, this returns false if there
+ are no values of this datatype that are of finite size.
+
+ :return: True if this datatype is well-founded
+ """
return self.cd.isWellFounded()
- def hasNestedRecursion(self):
- """:return: whether this datatype has nested recursion (see :cpp:func:`Datatype::hasNestedRecursion() <cvc5::api::Datatype::hasNestedRecursion>`)."""
- return self.cd.hasNestedRecursion()
+ def isNull(self):
+ """
+ :return: True if this Datatype is a null object.
+ """
+ return self.cd.isNull()
def __str__(self):
return self.cd.toString().decode()
return self.cd.toString().decode()
def __iter__(self):
+ """Iterate over all constructors."""
for ci in self.cd:
dc = DatatypeConstructor(self.solver)
dc.cdc = ci
cdef class DatatypeConstructor:
+ """
+ A cvc5 datatype constructor.
+
+ Wrapper class for :cpp:class:`cvc5::DatatypeConstructor`.
+ """
cdef c_DatatypeConstructor cdc
cdef Solver solver
def __cinit__(self, Solver solver):
self.solver = solver
def __getitem__(self, index):
+ """
+ Get the datatype selector with the given index, where index can be
+ either a numeric id starting with zero, or the name of the selector.
+ In the latter case, this is a linear search through the selectors,
+ so in case of multiple, similarly-named selectors, the first is
+ returned.
+
+ :param index: The id or name of the datatype selector.
+ :return: The matching datatype selector.
+ """
cdef DatatypeSelector ds = DatatypeSelector(self.solver)
if isinstance(index, int) and index >= 0:
ds.cds = self.cdc[(<int?> index)]
return ds
def getName(self):
+ """
+ :return: The name of the constructor.
+ """
return self.cdc.getName().decode()
- def getConstructorTerm(self):
+ def getTerm(self):
+ """
+ :return: The constructor operator as a term.
+ """
cdef Term term = Term(self.solver)
- term.cterm = self.cdc.getConstructorTerm()
+ term.cterm = self.cdc.getTerm()
return term
- def getSpecializedConstructorTerm(self, Sort retSort):
+ def getInstantiatedConstructorTerm(self, Sort retSort):
+ """
+ Get the constructor operator of this datatype constructor whose
+ return type is retSort. This method is intended to be used on
+ constructors of parametric datatypes and can be seen as returning
+ the constructor term that has been explicitly cast to the given
+ sort.
+
+ This method is required for constructors of parametric datatypes
+ whose return type cannot be determined by type inference. For
+ example, given:
+
+ .. code:: smtlib
+
+ (declare-datatype List
+ (par (T) ((nil) (cons (head T) (tail (List T))))))
+
+ The type of nil terms must be provided by the user. In SMT version
+ 2.6, this is done via the syntax for qualified identifiers:
+
+ .. code:: smtlib
+
+ (as nil (List Int))
+
+ This method is equivalent of applying the above, where this
+ DatatypeConstructor is the one corresponding to nil, and retSort is
+ ``(List Int)``.
+
+ .. note::
+
+ The returned constructor term ``t`` is an operator, while
+ ``Solver.mkTerm(APPLY_CONSTRUCTOR, [t])`` is used to construct
+ the above (nullary) application of nil.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param retSort: The desired return sort of the constructor.
+ :return: The constructor operator as a term.
+ """
cdef Term term = Term(self.solver)
- term.cterm = self.cdc.getSpecializedConstructorTerm(retSort.csort)
+ term.cterm = self.cdc.getInstantiatedConstructorTerm(retSort.csort)
return term
def getTesterTerm(self):
+ """
+ :return: The tester operator that is related to this constructor,
+ as a term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cdc.getTesterTerm()
return term
def getNumSelectors(self):
+ """
+ :return: The number of selecters (so far) of this Datatype
+ constructor.
+ """
return self.cdc.getNumSelectors()
def getSelector(self, str name):
+ """
+ :param name: The name of the datatype selector.
+ :return: The first datatype selector with the given name.
+ """
cdef DatatypeSelector ds = DatatypeSelector(self.solver)
ds.cds = self.cdc.getSelector(name.encode())
return ds
- def getSelectorTerm(self, str name):
- cdef Term term = Term(self.solver)
- term.cterm = self.cdc.getSelectorTerm(name.encode())
- return term
+ def isNull(self):
+ """
+ :return: True if this DatatypeConstructor is a null object.
+ """
+ return self.cdc.isNull()
def __str__(self):
return self.cdc.toString().decode()
return self.cdc.toString().decode()
def __iter__(self):
+ """Iterate over all datatype selectors."""
for ci in self.cdc:
ds = DatatypeSelector(self.solver)
ds.cds = ci
cdef class DatatypeConstructorDecl:
+ """
+ A cvc5 datatype constructor declaration. A datatype constructor
+ declaration is a specification used for creating a datatype constructor.
+
+ Wrapper class for :cpp:class:`cvc5::DatatypeConstructorDecl`.
+ """
cdef c_DatatypeConstructorDecl cddc
cdef Solver solver
self.solver = solver
def addSelector(self, str name, Sort sort):
+ """
+ Add datatype selector declaration.
+
+ :param name: The name of the datatype selector declaration to add.
+ :param sort: The codomain sort of the datatype selector declaration
+ to add.
+ """
self.cddc.addSelector(name.encode(), sort.csort)
def addSelectorSelf(self, str name):
+ """
+ Add datatype selector declaration whose codomain sort is the
+ datatype itself.
+
+ :param name: The name of the datatype selector declaration to add.
+ """
self.cddc.addSelectorSelf(name.encode())
+ def addSelectorUnresolved(self, str name, str unresDatatypeName):
+ """
+ Add datatype selector declaration whose codomain sort is an
+ unresolved datatype with the given name.
+
+ :param name: The name of the datatype selector declaration to add.
+ :param unresDataypeName: The name of the unresolved datatype. The
+ codomain of the selector will be the
+ resolved datatype with the given name.
+ """
+ self.cddc.addSelectorUnresolved(name.encode(), unresDatatypeName.encode())
+
+ def isNull(self):
+ """
+ :return: True if this DatatypeConstructorDecl is a null object.
+ """
+ return self.cddc.isNull()
+
def __str__(self):
return self.cddc.toString().decode()
cdef class DatatypeDecl:
+ """
+ A cvc5 datatype declaration. A datatype declaration is not itself a
+ datatype (see :py:class:`cvc5.Datatype`), but a specification for creating a datatype
+ sort.
+
+ The interface for a datatype declaration coincides with the syntax for
+ the SMT-LIB 2.6 command `declare-datatype`, or a single datatype within
+ the `declare-datatypes` command.
+
+ Datatype sorts can be constructed from :py:class:`DatatypeDecl` using
+ the methods:
+
+ - :py:meth:`Solver.mkDatatypeSort()`
+ - :py:meth:`Solver.mkDatatypeSorts()`
+
+ Wrapper class for :cpp:class:`cvc5::DatatypeDecl`.
+ """
cdef c_DatatypeDecl cdd
cdef Solver solver
def __cinit__(self, Solver solver):
self.solver = solver
def addConstructor(self, DatatypeConstructorDecl ctor):
+ """
+ Add a datatype constructor declaration.
+
+ :param ctor: The datatype constructor declaration to add.
+ """
self.cdd.addConstructor(ctor.cddc)
def getNumConstructors(self):
+ """
+ :return: The number of constructors (so far) for this datatype
+ declaration.
+ """
return self.cdd.getNumConstructors()
def isParametric(self):
+ """
+ :return: True if this datatype declaration is parametric.
+ """
return self.cdd.isParametric()
def getName(self):
+ """
+ :return: The name of this datatype declaration.
+ """
return self.cdd.getName().decode()
+ def isNull(self):
+ """
+ :return: True if this DatatypeDecl is a null object.
+ """
+ return self.cdd.isNull()
+
def __str__(self):
return self.cdd.toString().decode()
cdef class DatatypeSelector:
+ """
+ A cvc5 datatype selector.
+
+ Wrapper class for :cpp:class:`cvc5::DatatypeSelector`.
+ """
cdef c_DatatypeSelector cds
cdef Solver solver
def __cinit__(self, Solver solver):
self.solver = solver
def getName(self):
+ """
+ :return: The name of this datatype selector.
+ """
return self.cds.getName().decode()
- def getSelectorTerm(self):
+ def getTerm(self):
+ """
+ :return: The selector opeartor of this datatype selector as a term.
+ """
cdef Term term = Term(self.solver)
- term.cterm = self.cds.getSelectorTerm()
+ term.cterm = self.cds.getTerm()
return term
def getUpdaterTerm(self):
+ """
+ :return: The updater opeartor of this datatype selector as a term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cds.getUpdaterTerm()
return term
- def getRangeSort(self):
+ def getCodomainSort(self):
+ """
+ :return: The codomain sort of this selector.
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.cds.getRangeSort()
+ sort.csort = self.cds.getCodomainSort()
return sort
+ def isNull(self):
+ """
+ :return: True if this DatatypeSelector is a null object.
+ """
+ return self.cds.isNull()
+
def __str__(self):
return self.cds.toString().decode()
cdef class Op:
+ """
+ A cvc5 operator.
+
+ An operator is a term that represents certain operators,
+ instantiated with its required parameters, e.g.,
+ a term of kind :py:obj:`BVExtract <cvc5.Kind.BVExtract>`.
+
+ Wrapper class for :cpp:class:`cvc5::Op`.
+ """
cdef c_Op cop
cdef Solver solver
def __cinit__(self, Solver solver):
return cophash(self.cop)
def getKind(self):
- return kind(<int> self.cop.getKind())
-
+ """
+ :return: The kind of this operator.
+ """
+ return Kind(<int> self.cop.getKind())
+
def isIndexed(self):
+ """
+ :return: True iff this operator is indexed.
+ """
return self.cop.isIndexed()
def isNull(self):
+ """
+ :return: True iff this operator is a null term.
+ """
return self.cop.isNull()
- def getIndices(self):
- indices = None
- try:
- indices = self.cop.getIndices[string]()
- except:
- pass
+ def getNumIndices(self):
+ """
+ :return: The number of indices of this op.
+ """
+ return self.cop.getNumIndices()
- try:
- indices = self.cop.getIndices[uint32_t]()
- except:
- pass
+ def __getitem__(self, int i):
+ """
+ Get the index at position ``i``.
- try:
- indices = self.cop.getIndices[pair[uint32_t, uint32_t]]()
- except:
- pass
-
- if indices is None:
- raise RuntimeError("Unable to retrieve indices from {}".format(self))
+ :param i: The position of the index to return.
+ :return: The index at position ``i``.
+ """
+ cdef Term term = Term(self.solver)
+ term.cterm = self.cop[i]
+ return term
- return indices
cdef class Grammar:
+ """
+ A Sygus Grammar. This class can be used to define a context-free grammar
+ of terms. Its interface coincides with the definition of grammars
+ (``GrammarDef``) in the SyGuS IF 2.1 standard.
+
+ Wrapper class for :cpp:class:`cvc5::Grammar`.
+ """
cdef c_Grammar cgrammar
cdef Solver solver
def __cinit__(self, Solver solver):
self.cgrammar = c_Grammar()
def addRule(self, Term ntSymbol, Term rule):
+ """
+ Add ``rule`` to the set of rules corresponding to ``ntSymbol``.
+
+ :param ntSymbol: The non-terminal to which the rule is added.
+ :param rule: The rule to add.
+ """
self.cgrammar.addRule(ntSymbol.cterm, rule.cterm)
def addAnyConstant(self, Term ntSymbol):
+ """
+ Allow ``ntSymbol`` to be an arbitrary constant.
+
+ :param ntSymbol: The non-terminal allowed to be constant.
+ """
self.cgrammar.addAnyConstant(ntSymbol.cterm)
def addAnyVariable(self, Term ntSymbol):
+ """
+ Allow ``ntSymbol`` to be any input variable to corresponding
+ synth-fun/synth-inv with the same sort as ``ntSymbol``.
+
+ :param ntSymbol: The non-terminal allowed to be any input variable.
+ """
self.cgrammar.addAnyVariable(ntSymbol.cterm)
def addRules(self, Term ntSymbol, rules):
+ """
+ Add ``ntSymbol`` to the set of rules corresponding to ``ntSymbol``.
+
+ :param ntSymbol: The non-terminal to which the rules are added.
+ :param rules: The rules to add.
+ """
cdef vector[c_Term] crules
for r in rules:
crules.push_back((<Term?> r).cterm)
self.cgrammar.addRules(ntSymbol.cterm, crules)
cdef class Result:
+ """
+ Encapsulation of a three-valued solver result, with explanations.
+
+ Wrapper class for :cpp:class:`cvc5::Result`.
+ """
cdef c_Result cr
def __cinit__(self):
# gets populated by solver
self.cr = c_Result()
def isNull(self):
+ """
+ :return: True if Result is empty, i.e., a nullary Result, and not
+ an actual result returned from a
+ :py:meth:`Solver.checkSat()` (and friends) query.
+ """
return self.cr.isNull()
def isSat(self):
+ """
+ :return: True if query was a satisfiable
+ :py:meth:`Solver.checkSat()` or
+ :py:meth:`Solver.checkSatAssuming()` query.
+ """
return self.cr.isSat()
def isUnsat(self):
+ """
+ :return: True if query was an usatisfiable
+ :py:meth:`Solver.checkSat()` or
+ :py:meth:`Solver.checkSatAssuming()` query.
+ """
return self.cr.isUnsat()
- def isSatUnknown(self):
- return self.cr.isSatUnknown()
-
- def isEntailed(self):
- return self.cr.isEntailed()
+ def isUnknown(self):
+ """
+ :return: True if query was a :py:meth:`Solver.checkSat()` or
+ :py:meth:`Solver.checkSatAssuming()` query and cvc5 was
+ not able to determine (un)satisfiability.
+ """
+ return self.cr.isUnknown()
- def isNotEntailed(self):
- return self.cr.isNotEntailed()
-
- def isEntailmentUnknown(self):
- return self.cr.isEntailmentUnknown()
+ def getUnknownExplanation(self):
+ """
+ :return: An explanation for an unknown query result.
+ """
+ return UnknownExplanation(<int> self.cr.getUnknownExplanation())
def __eq__(self, Result other):
return self.cr == other.cr
def __ne__(self, Result other):
return self.cr != other.cr
- def getUnknownExplanation(self):
- return self.cr.getUnknownExplanation().decode()
-
def __str__(self):
return self.cr.toString().decode()
def __repr__(self):
return self.cr.toString().decode()
+cdef class SynthResult:
+ """
+ Encapsulation of a solver synth result.
-cdef class RoundingMode:
- cdef c_RoundingMode crm
- cdef str name
- def __cinit__(self, int rm):
- # crm always assigned externally
- self.crm = <c_RoundingMode> rm
- self.name = __rounding_modes[rm]
+ This is the return value of the API methods:
- def __eq__(self, RoundingMode other):
- return (<int> self.crm) == (<int> other.crm)
+ - :py:meth:`Solver.checkSynth()`
+ - :py:meth:`Solver.checkSynthNext()`
- def __ne__(self, RoundingMode other):
- return not self.__eq__(other)
+ which we call synthesis queries. This class indicates whether the
+ synthesis query has a solution, has no solution, or is unknown.
+ """
+ cdef c_SynthResult cr
+ def __cinit__(self):
+ # gets populated by solver
+ self.cr = c_SynthResult()
- def __hash__(self):
- return hash((<int> self.crm, self.name))
+ def isNull(self):
+ """
+ :return: True if SynthResult is null, i.e., not a SynthResult
+ returned from a synthesis query.
+ """
+ return self.cr.isNull()
+
+ def hasSolution(self):
+ """
+ :return: True if the synthesis query has a solution.
+ """
+ return self.cr.hasSolution()
+
+ def hasNoSolution(self):
+ """
+ :return: True if the synthesis query has no solution.
+ In this case, it was determined that there was no solution.
+ """
+ return self.cr.hasNoSolution()
+
+ def isUnknown(self):
+ """
+ :return: True if the result of the synthesis query could not be
+ determined.
+ """
+ return self.cr.isUnknown()
def __str__(self):
- return self.name
+ return self.cr.toString().decode()
def __repr__(self):
- return self.name
+ return self.cr.toString().decode()
cdef class Solver:
+ """
+ A cvc5 solver.
+
+ Wrapper class for :cpp:class:`cvc5::Solver`.
+ """
cdef c_Solver* csolver
def __cinit__(self):
- self.csolver = new c_Solver(NULL)
+ self.csolver = new c_Solver()
def __dealloc__(self):
del self.csolver
def getBooleanSort(self):
+ """
+ :return: Sort Boolean.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getBooleanSort()
return sort
def getIntegerSort(self):
+ """
+ :return: Sort Integer.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getIntegerSort()
return sort
+ def getNullSort(self):
+ """
+ :return: A null sort object.
+ """
+ cdef Sort sort = Sort(self)
+ sort.csort = self.csolver.getNullSort()
+ return sort
+
def getRealSort(self):
+ """
+ :return: Sort Real.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getRealSort()
return sort
def getRegExpSort(self):
+ """:return: The sort of regular expressions.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getRegExpSort()
return sort
def getRoundingModeSort(self):
+ """:return: Sort RoundingMode.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getRoundingModeSort()
return sort
def getStringSort(self):
+ """:return: Sort String.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.getStringSort()
return sort
def mkArraySort(self, Sort indexSort, Sort elemSort):
+ """
+ Create an array sort.
+
+ :param indexSort: The array index sort.
+ :param elemSort: The array element sort.
+ :return: The array sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkArraySort(indexSort.csort, elemSort.csort)
return sort
def mkBitVectorSort(self, uint32_t size):
+ """
+ Create a bit-vector sort.
+
+ :param size: The bit-width of the bit-vector sort
+ :return: The bit-vector sort
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkBitVectorSort(size)
return sort
def mkFloatingPointSort(self, uint32_t exp, uint32_t sig):
+ """
+ Create a floating-point sort.
+
+ :param exp: The bit-width of the exponent of the floating-point
+ sort.
+ :param sig: The bit-width of the significand of the floating-point
+ sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkFloatingPointSort(exp, sig)
return sort
def mkDatatypeSort(self, DatatypeDecl dtypedecl):
+ """
+ Create a datatype sort.
+
+ :param dtypedecl: The datatype declaration from which the sort is
+ created.
+ :return: The datatype sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkDatatypeSort(dtypedecl.cdd)
return sort
- def mkDatatypeSorts(self, list dtypedecls, unresolvedSorts = None):
- """:return: A list of datatype sorts that correspond to dtypedecls and unresolvedSorts"""
- if unresolvedSorts == None:
- unresolvedSorts = set([])
- else:
- assert isinstance(unresolvedSorts, Set)
+ def mkDatatypeSorts(self, list dtypedecls):
+ """
+ Create a vector of datatype sorts using unresolved sorts. The names
+ of the datatype declarations in dtypedecls must be distinct.
+ When constructing datatypes, unresolved sorts are replaced by the
+ datatype sort constructed for the datatype declaration it is
+ associated with.
+
+ :param dtypedecls: The datatype declarations from which the sort is
+ created.
+ :return: The datatype sorts.
+ """
sorts = []
cdef vector[c_DatatypeDecl] decls
for decl in dtypedecls:
decls.push_back((<DatatypeDecl?> decl).cdd)
- cdef c_set[c_Sort] usorts
- for usort in unresolvedSorts:
- usorts.insert((<Sort?> usort).csort)
-
csorts = self.csolver.mkDatatypeSorts(
- <const vector[c_DatatypeDecl]&> decls, <const c_set[c_Sort]&> usorts)
+ <const vector[c_DatatypeDecl]&> decls)
for csort in csorts:
sort = Sort(self)
sort.csort = csort
return sorts
def mkFunctionSort(self, sorts, Sort codomain):
+ """
+ Create function sort.
+
+ :param sorts: The sort of the function arguments.
+ :param codomain: The sort of the function return value.
+ :return: The function sort.
+ """
cdef Sort sort = Sort(self)
# populate a vector with dereferenced c_Sorts
cdef vector[c_Sort] v
-
if isinstance(sorts, Sort):
- sort.csort = self.csolver.mkFunctionSort((<Sort?> sorts).csort,
- codomain.csort)
- elif isinstance(sorts, list):
+ v.push_back((<Sort?>sorts).csort)
+ else:
for s in sorts:
v.push_back((<Sort?>s).csort)
- sort.csort = self.csolver.mkFunctionSort(<const vector[c_Sort]&> v,
- codomain.csort)
+ sort.csort = self.csolver.mkFunctionSort(<const vector[c_Sort]&> v,
+ codomain.csort)
return sort
- def mkParamSort(self, symbolname):
+ def mkParamSort(self, str symbolname = None):
+ """
+ Create a sort parameter.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param symbol: The name of the sort.
+ :return: The sort parameter.
+ """
cdef Sort sort = Sort(self)
- sort.csort = self.csolver.mkParamSort(symbolname.encode())
+ if symbolname is None:
+ sort.csort = self.csolver.mkParamSort()
+ else:
+ sort.csort = self.csolver.mkParamSort(symbolname.encode())
return sort
- @expand_list_arg(num_req_args=0)
def mkPredicateSort(self, *sorts):
- '''
- Supports the following arguments:
- Sort mkPredicateSort(List[Sort] sorts)
+ """
+ Create a predicate sort.
- where sorts can also be comma-separated arguments of
- type Sort
- '''
+ :param sorts: The list of sorts of the predicate.
+ :return: The predicate sort.
+ """
cdef Sort sort = Sort(self)
cdef vector[c_Sort] v
for s in sorts:
sort.csort = self.csolver.mkPredicateSort(<const vector[c_Sort]&> v)
return sort
- @expand_list_arg(num_req_args=0)
def mkRecordSort(self, *fields):
- '''
- Supports the following arguments:
- Sort mkRecordSort(List[Tuple[str, Sort]] fields)
+ """
+ Create a record sort
- where fields can also be comma-separated arguments of
- type Tuple[str, Sort]
- '''
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param fields: The list of fields of the record.
+ :return: The record sort.
+ """
cdef Sort sort = Sort(self)
cdef vector[pair[string, c_Sort]] v
cdef pair[string, c_Sort] p
return sort
def mkSetSort(self, Sort elemSort):
+ """
+ Create a set sort.
+
+ :param elemSort: The sort of the set elements.
+ :return: The set sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkSetSort(elemSort.csort)
return sort
def mkBagSort(self, Sort elemSort):
+ """
+ Create a bag sort.
+
+ :param elemSort: The sort of the bag elements.
+ :return: The bag sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkBagSort(elemSort.csort)
return sort
def mkSequenceSort(self, Sort elemSort):
+ """
+ Create a sequence sort.
+
+ :param elemSort: The sort of the sequence elements
+ :return: The sequence sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.mkSequenceSort(elemSort.csort)
return sort
- def mkUninterpretedSort(self, str name):
+ def mkUninterpretedSort(self, str name = None):
+ """
+ Create an uninterpreted sort.
+
+ :param symbol: The name of the sort.
+ :return: The uninterpreted sort.
+ """
+ cdef Sort sort = Sort(self)
+ if name is None:
+ sort.csort = self.csolver.mkUninterpretedSort()
+ else:
+ sort.csort = self.csolver.mkUninterpretedSort(name.encode())
+ return sort
+
+ def mkUnresolvedDatatypeSort(self, str name, size_t arity = 0):
+ """
+ Create an unresolved datatype sort.
+
+ This is for creating yet unresolved sort placeholders for mutually
+ recursive datatypes.
+
+ :param symbol: The name of the sort.
+ :param arity: The number of sort parameters of the sort.
+ :return: The unresolved sort.
+ """
cdef Sort sort = Sort(self)
- sort.csort = self.csolver.mkUninterpretedSort(name.encode())
+ sort.csort = self.csolver.mkUnresolvedDatatypeSort(name.encode(), arity)
return sort
- def mkSortConstructorSort(self, str symbol, size_t arity):
+ def mkUninterpretedSortConstructorSort(self, size_t arity, str symbol = None):
+ """
+ Create a sort constructor sort.
+
+ An uninterpreted sort constructor is an uninterpreted sort with
+ arity > 0.
+
+ :param symbol: The symbol of the sort.
+ :param arity: The arity of the sort (must be > 0).
+ :return: The sort constructor sort.
+ """
cdef Sort sort = Sort(self)
- sort.csort =self.csolver.mkSortConstructorSort(symbol.encode(), arity)
+ if symbol is None:
+ sort.csort = self.csolver.mkUninterpretedSortConstructorSort(arity)
+ else:
+ sort.csort = self.csolver.mkUninterpretedSortConstructorSort(
+ arity, symbol.encode())
return sort
- @expand_list_arg(num_req_args=0)
def mkTupleSort(self, *sorts):
- '''
- Supports the following arguments:
- Sort mkTupleSort(List[Sort] sorts)
+ """
+ Create a tuple sort.
- where sorts can also be comma-separated arguments of
- type Sort
- '''
+ :param sorts: Of the elements of the tuple.
+ :return: The tuple sort.
+ """
cdef Sort sort = Sort(self)
cdef vector[c_Sort] v
for s in sorts:
sort.csort = self.csolver.mkTupleSort(v)
return sort
- @expand_list_arg(num_req_args=1)
def mkTerm(self, kind_or_op, *args):
- '''
+ """
+ Create a term.
+
Supports the following arguments:
- Term mkTerm(Kind kind)
- Term mkTerm(Kind kind, Op child1, List[Term] children)
- Term mkTerm(Kind kind, List[Term] children)
- where List[Term] can also be comma-separated arguments
- '''
+ - ``Term mkTerm(Kind kind)``
+ - ``Term mkTerm(Kind kind, List[Term] children)``
+ - ``Term mkTerm(Op op)``
+ - ``Term mkTerm(Op op, List[Term] children)``
+
+ where ``List[Term]`` can also be comma-separated arguments
+ """
cdef Term term = Term(self)
cdef vector[c_Term] v
op = kind_or_op
- if isinstance(kind_or_op, kind):
+ if isinstance(kind_or_op, Kind):
op = self.mkOp(kind_or_op)
if len(args) == 0:
return term
def mkTuple(self, sorts, terms):
+ """
+ Create a tuple term. Terms are automatically converted if sorts are
+ compatible.
+
+ :param sorts: The sorts of the elements in the tuple.
+ :param terms: The elements in the tuple.
+ :return: The tuple Term.
+ """
cdef vector[c_Sort] csorts
cdef vector[c_Term] cterms
result.cterm = self.csolver.mkTuple(csorts, cterms)
return result
+ def mkOp(self, k, *args):
+ """
+ Create operator.
+
+ Supports the following arguments:
- def mkOp(self, kind k, arg0=None, arg1 = None):
- '''
- Supports the following uses:
- Op mkOp(Kind kind)
- Op mkOp(Kind kind, Kind k)
- Op mkOp(Kind kind, const string& arg)
- Op mkOp(Kind kind, uint32_t arg)
- Op mkOp(Kind kind, uint32_t arg0, uint32_t arg1)
- '''
+ - ``Op mkOp(Kind kind)``
+ - ``Op mkOp(Kind kind, const string& arg)``
+ - ``Op mkOp(Kind kind, uint32_t arg0, ...)``
+ """
cdef Op op = Op(self)
+ cdef vector[uint32_t] v
- if arg0 is None:
- op.cop = self.csolver.mkOp(k.k)
- elif arg1 is None:
- if isinstance(arg0, kind):
- op.cop = self.csolver.mkOp(k.k, (<kind?> arg0).k)
- elif isinstance(arg0, str):
- op.cop = self.csolver.mkOp(k.k,
- <const string &>
- arg0.encode())
- elif isinstance(arg0, int):
- op.cop = self.csolver.mkOp(k.k, <int?> arg0)
- else:
- raise ValueError("Unsupported signature"
- " mkOp: {}".format(" X ".join([str(k), str(arg0)])))
+ if len(args) == 0:
+ op.cop = self.csolver.mkOp(<c_Kind> k.value)
+ elif len(args) == 1 and isinstance(args[0], str):
+ op.cop = self.csolver.mkOp(<c_Kind> k.value,
+ <const string &>
+ args[0].encode())
else:
- if isinstance(arg0, int) and isinstance(arg1, int):
- op.cop = self.csolver.mkOp(k.k, <int> arg0,
- <int> arg1)
- else:
- raise ValueError("Unsupported signature"
- " mkOp: {}".format(" X ".join([k, arg0, arg1])))
+ for a in args:
+ if not isinstance(a, int):
+ raise ValueError(
+ "Expected uint32_t for argument {}".format(a))
+ if a < 0 or a >= 2 ** 31:
+ raise ValueError(
+ "Argument {} must fit in a uint32_t".format(a))
+ v.push_back((<uint32_t?> a))
+ op.cop = self.csolver.mkOp(<c_Kind> k.value, v)
return op
def mkTrue(self):
+ """
+ Create a Boolean true constant.
+
+ :return: The true constant.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkTrue()
return term
def mkFalse(self):
+ """
+ Create a Boolean false constant.
+
+ :return: The false constant.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkFalse()
return term
def mkBoolean(self, bint val):
+ """
+ Create a Boolean constant.
+
+ :return: The Boolean constant.
+ :param val: The value of the constant.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkBoolean(val)
return term
def mkPi(self):
+ """
+ Create a constant representing the number Pi.
+
+ :return: A constant representing :py:obj:`Pi <cvc5.Kind.Pi>`.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkPi()
return term
def mkInteger(self, val):
+ """
+ Create an integer constant.
+
+ :param val: Representation of the constant: either a string or
+ integer.
+ :return: A constant of sort Integer.
+ """
cdef Term term = Term(self)
if isinstance(val, str):
- term.cterm = self.csolver.mkInteger(<const string &> str(val).encode())
+ term.cterm = self.csolver.mkInteger(
+ <const string &> str(val).encode())
else:
assert(isinstance(val, int))
term.cterm = self.csolver.mkInteger((<int?> val))
return term
- def mkReal(self, val, den=None):
- '''
- Make a real number term.
-
- Really, makes a rational term.
-
- Can be used in various forms.
- * Given a string "N/D" constructs the corresponding rational.
- * Given a string "W.D" constructs the reduction of (W * P + D)/P, where
- P is the appropriate power of 10.
- * Given a float f, constructs the rational matching f's string
- representation. This means that mkReal(0.3) gives 3/10 and not the
- IEEE-754 approximation of 3/10.
- * Given a string "W" or an integer, constructs that integer.
- * Given two strings and/or integers N and D, constructs N/D.
- '''
+ def mkReal(self, numerator, denominator=None):
+ """
+ Create a real constant from a numerator and an optional denominator.
+
+ First converts the arguments to a temporary string, either
+ ``"<numerator>"`` or ``"<numerator>/<denominator>"``. This temporary
+ string is forwarded to :cpp:func:`cvc5::Solver::mkReal()` and should
+ thus represent an integer, a decimal number or a fraction.
+
+ :param numerator: The numerator.
+ :param denominator: The denominator, or ``None``.
+ :return: A real term with literal value.
+ """
cdef Term term = Term(self)
- if den is None:
- term.cterm = self.csolver.mkReal(str(val).encode())
+ if denominator is None:
+ term.cterm = self.csolver.mkReal(str(numerator).encode())
else:
- if not isinstance(val, int) or not isinstance(den, int):
- raise ValueError("Expecting integers when"
- " constructing a rational"
- " but got: {}".format((val, den)))
- term.cterm = self.csolver.mkReal("{}/{}".format(val, den).encode())
+ term.cterm = self.csolver.mkReal("{}/{}".format(numerator, denominator).encode())
+ return term
+
+ def mkRegexpAll(self):
+ """
+ Create a regular expression all (``re.all``) term.
+
+ :return: The all term.
+ """
+ cdef Term term = Term(self)
+ term.cterm = self.csolver.mkRegexpAll()
return term
- def mkRegexpEmpty(self):
+ def mkRegexpAllchar(self):
+ """
+ Create a regular expression allchar (``re.allchar``) term.
+
+ :return: The allchar term.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkRegexpEmpty()
+ term.cterm = self.csolver.mkRegexpAllchar()
return term
- def mkRegexpSigma(self):
+ def mkRegexpNone(self):
+ """
+ Create a regular expression none (``re.none``) term.
+
+ :return: The none term.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkRegexpSigma()
+ term.cterm = self.csolver.mkRegexpNone()
return term
def mkEmptySet(self, Sort s):
+ """
+ Create a constant representing an empty set of the given sort.
+
+ :param sort: The sort of the set elements.
+ :return: The empty set constant.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkEmptySet(s.csort)
return term
+ def mkEmptyBag(self, Sort s):
+ """
+ Create a constant representing an empty bag of the given sort.
+
+ :param sort: The sort of the bag elements.
+ :return: The empty bag constant.
+ """
+ cdef Term term = Term(self)
+ term.cterm = self.csolver.mkEmptyBag(s.csort)
+ return term
+
+ def mkSepEmp(self):
+ """
+ Create a separation logic empty term.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: The separation logic empty term.
+ """
+ cdef Term term = Term(self)
+ term.cterm = self.csolver.mkSepEmp()
+ return term
def mkSepNil(self, Sort sort):
+ """
+ Create a separation logic nil term.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param sort: The sort of the nil term.
+ :return: The separation logic nil term.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkSepNil(sort.csort)
return term
- def mkString(self, str s):
+ def mkString(self, str s, useEscSequences = None):
+ """
+ Create a String constant from a ``str`` which may contain SMT-LIB
+ compatible escape sequences like ``\\u1234`` to encode unicode
+ characters.
+
+ :param s: The string this constant represents.
+ :param useEscSequences: Determines whether escape sequences in `s`
+ should be converted to the corresponding
+ unicode character
+ :return: The String constant.
+ """
cdef Term term = Term(self)
cdef Py_ssize_t size
cdef wchar_t* tmp = PyUnicode_AsWideCharString(s, &size)
- term.cterm = self.csolver.mkString(c_wstring(tmp, size))
+ if isinstance(useEscSequences, bool):
+ term.cterm = self.csolver.mkString(
+ s.encode(), <bint> useEscSequences)
+ else:
+ term.cterm = self.csolver.mkString(c_wstring(tmp, size))
PyMem_Free(tmp)
return term
def mkEmptySequence(self, Sort sort):
+ """
+ Create an empty sequence of the given element sort.
+
+ :param sort: The element sort of the sequence.
+ :return: The empty sequence with given element sort.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkEmptySequence(sort.csort)
return term
def mkUniverseSet(self, Sort sort):
+ """
+ Create a universe set of the given sort.
+
+ :param sort: The sort of the set elements
+ :return: The universe set constant
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkUniverseSet(sort.csort)
return term
- @expand_list_arg(num_req_args=0)
- def mkBitVector(self, *args):
- '''
+ def mkBitVector(self, int size, *args):
+ """
+ Create bit-vector value.
+
Supports the following arguments:
- Term mkBitVector(int size, int val=0)
- Term mkBitVector(string val, int base = 2)
- Term mkBitVector(int size, string val, int base)
- '''
- cdef Term term = Term(self)
- if len(args) == 1:
- size_or_val = args[0]
- if isinstance(args[0], int):
- size = args[0]
- term.cterm = self.csolver.mkBitVector(<uint32_t> size)
- else:
- assert isinstance(args[0], str)
- val = args[0]
- term.cterm = self.csolver.mkBitVector(<const string&> str(val).encode())
- elif len(args) == 2:
- if isinstance(args[0], int):
- size = args[0]
- assert isinstance(args[1], int)
- val = args[1]
- term.cterm = self.csolver.mkBitVector(<uint32_t> size, <uint32_t> val)
- else:
- assert isinstance(args[0], str)
- assert isinstance(args[1], int)
- val = args[0]
- base = args[1]
- term.cterm = self.csolver.mkBitVector(<const string&> str(val).encode(), <uint32_t> base)
- elif len(args) == 3:
- assert isinstance(args[0], int)
- assert isinstance(args[1], str)
- assert isinstance(args[2], int)
- size = args[0]
- val = args[1]
- base = args[2]
- term.cterm = self.csolver.mkBitVector(<uint32_t> size, <const string&> str(val).encode(), <uint32_t> base)
- return term
+ - ``Term mkBitVector(int size, int val=0)``
+ - ``Term mkBitVector(int size, string val, int base)``
- def mkBitVector(self, size_or_str, val = None):
+ :return: A Term representing a bit-vector value.
+ :param size: The bit-width.
+ :param val: An integer representating the value, in the first form.
+ In the second form, a string representing the value.
+ :param base: The base of the string representation (second form
+ only).
+ """
cdef Term term = Term(self)
- if isinstance(size_or_str, int):
- if val is None:
- term.cterm = self.csolver.mkBitVector(<uint32_t> size_or_str)
- else:
- term.cterm = self.csolver.mkBitVector(<uint32_t> size_or_str,
- <const string &> str(val).encode(),
- 10)
- elif isinstance(size_or_str, str):
- # handle default value
- if val is None:
- term.cterm = self.csolver.mkBitVector(
- <const string &> size_or_str.encode())
- else:
- term.cterm = self.csolver.mkBitVector(
- <const string &> size_or_str.encode(), <uint32_t> val)
+ if len(args) == 0:
+ term.cterm = self.csolver.mkBitVector(<uint32_t> size)
+ elif len(args) == 1:
+ val = args[0]
+ if not isinstance(val, int):
+ raise ValueError(
+ "Invalid second argument to mkBitVector '{}', "
+ "expected integer value".format(size))
+ term.cterm = self.csolver.mkBitVector(
+ <uint32_t> size, <uint32_t> val)
+ elif len(args) == 2:
+ val = args[0]
+ base = args[1]
+ if not isinstance(val, str):
+ raise ValueError(
+ "Invalid second argument to mkBitVector '{}', "
+ "expected value string".format(size))
+ if not isinstance(base, int):
+ raise ValueError(
+ "Invalid third argument to mkBitVector '{}', "
+ "expected base given as integer".format(size))
+ term.cterm = self.csolver.mkBitVector(
+ <uint32_t> size,
+ <const string&> str(val).encode(),
+ <uint32_t> base)
else:
- raise ValueError("Unexpected inputs {} to"
- " mkBitVector".format((size_or_str, val)))
+ raise ValueError("Unexpected inputs to mkBitVector")
return term
def mkConstArray(self, Sort sort, Term val):
+ """
+ Create a constant array with the provided constant value stored at
+ every index
+
+ :param sort: The sort of the constant array (must be an array sort).
+ :param val: The constant value to store (must match the sort's
+ element sort).
+ :return: The constant array term.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkConstArray(sort.csort, val.cterm)
return term
- def mkPosInf(self, int exp, int sig):
- cdef Term term = Term(self)
- term.cterm = self.csolver.mkPosInf(exp, sig)
- return term
+ def mkFloatingPointPosInf(self, int exp, int sig):
+ """
+ Create a positive infinity floating-point constant.
- def mkNegInf(self, int exp, int sig):
+ :param exp: Number of bits in the exponent.
+ :param sig: Number of bits in the significand.
+ :return: The floating-point constant.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkNegInf(exp, sig)
+ term.cterm = self.csolver.mkFloatingPointPosInf(exp, sig)
return term
- def mkNaN(self, int exp, int sig):
- cdef Term term = Term(self)
- term.cterm = self.csolver.mkNaN(exp, sig)
- return term
+ def mkFloatingPointNegInf(self, int exp, int sig):
+ """
+ Create a negative infinity floating-point constant.
- def mkPosZero(self, int exp, int sig):
+ :param exp: Number of bits in the exponent.
+ :param sig: Number of bits in the significand.
+ :return: The floating-point constant.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkPosZero(exp, sig)
+ term.cterm = self.csolver.mkFloatingPointNegInf(exp, sig)
return term
- def mkNegZero(self, int exp, int sig):
+ def mkFloatingPointNaN(self, int exp, int sig):
+ """
+ Create a not-a-number (NaN) floating-point constant.
+
+ :param exp: Number of bits in the exponent.
+ :param sig: Number of bits in the significand.
+ :return: The floating-point constant.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkNegZero(exp, sig)
+ term.cterm = self.csolver.mkFloatingPointNaN(exp, sig)
return term
- def mkRoundingMode(self, RoundingMode rm):
+ def mkFloatingPointPosZero(self, int exp, int sig):
+ """
+ Create a positive zero (+0.0) floating-point constant.
+
+ :param exp: Number of bits in the exponent.
+ :param sig: Number of bits in the significand.
+ :return: The floating-point constant.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkRoundingMode(<c_RoundingMode> rm.crm)
+ term.cterm = self.csolver.mkFloatingPointPosZero(exp, sig)
return term
- def mkUninterpretedConst(self, Sort sort, int index):
+ def mkFloatingPointNegZero(self, int exp, int sig):
+ """
+ Create a negative zero (+0.0) floating-point constant.
+
+ :param exp: Number of bits in the exponent.
+ :param sig: Number of bits in the significand.
+ :return: The floating-point constant.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkUninterpretedConst(sort.csort, index)
+ term.cterm = self.csolver.mkFloatingPointNegZero(exp, sig)
return term
- def mkAbstractValue(self, index):
+ def mkRoundingMode(self, rm):
+ """
+ Create a roundingmode constant.
+
+ :param rm: The floating point rounding mode this constant
+ represents.
+ """
cdef Term term = Term(self)
- try:
- term.cterm = self.csolver.mkAbstractValue(str(index).encode())
- except:
- raise ValueError("mkAbstractValue expects a str representing a number"
- " or an int, but got{}".format(index))
+ term.cterm = self.csolver.mkRoundingMode(<c_RoundingMode> rm.value)
return term
def mkFloatingPoint(self, int exp, int sig, Term val):
+ """
+ Create a floating-point constant.
+
+ :param exp: Size of the exponent.
+ :param sig: Size of the significand.
+ :param val: Value of the floating-point constant as a bit-vector
+ term.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.mkFloatingPoint(exp, sig, val.cterm)
return term
+ def mkCardinalityConstraint(self, Sort sort, int index):
+ """
+ Create cardinality constraint.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param sort: Sort of the constraint.
+ :param index: The upper bound for the cardinality of the sort.
+ """
+ cdef Term term = Term(self)
+ term.cterm = self.csolver.mkCardinalityConstraint(sort.csort, index)
+ return term
+
def mkConst(self, Sort sort, symbol=None):
+ """
+ Create (first-order) constant (0-arity function symbol).
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( declare-const <symbol> <sort> )
+ ( declare-fun <symbol> ( ) <sort> )
+
+ :param sort: The sort of the constant.
+ :param symbol: The name of the constant. If None, a default symbol
+ is used.
+ :return: The first-order constant.
+ """
cdef Term term = Term(self)
if symbol is None:
term.cterm = self.csolver.mkConst(sort.csort)
return term
def mkVar(self, Sort sort, symbol=None):
+ """
+ Create a bound variable to be used in a binder (i.e. a quantifier,
+ a lambda, or a witness binder).
+
+ :param sort: The sort of the variable.
+ :param symbol: The name of the variable.
+ :return: The variable.
+ """
cdef Term term = Term(self)
if symbol is None:
term.cterm = self.csolver.mkVar(sort.csort)
return term
def mkDatatypeConstructorDecl(self, str name):
+ """
+ Create datatype constructor declaration.
+
+ :param name: The name of the constructor.
+ :return: The datatype constructor declaration.
+ """
cdef DatatypeConstructorDecl ddc = DatatypeConstructorDecl(self)
ddc.cddc = self.csolver.mkDatatypeConstructorDecl(name.encode())
return ddc
def mkDatatypeDecl(self, str name, sorts_or_bool=None, isCoDatatype=None):
+ """
+ Create a datatype declaration.
+
+ :param name: The name of the datatype.
+ :param isCoDatatype: True if a codatatype is to be constructed.
+ :return: The datatype declaration.
+ """
cdef DatatypeDecl dd = DatatypeDecl(self)
cdef vector[c_Sort] v
dd.cdd = self.csolver.mkDatatypeDecl(name.encode())
elif sorts_or_bool is not None and isCoDatatype is None:
if isinstance(sorts_or_bool, bool):
- dd.cdd = self.csolver.mkDatatypeDecl(<const string &> name.encode(),
- <bint> sorts_or_bool)
+ dd.cdd = self.csolver.mkDatatypeDecl(
+ <const string &> name.encode(), <bint> sorts_or_bool)
elif isinstance(sorts_or_bool, Sort):
- dd.cdd = self.csolver.mkDatatypeDecl(<const string &> name.encode(),
- (<Sort> sorts_or_bool).csort)
+ dd.cdd = self.csolver.mkDatatypeDecl(
+ <const string &> name.encode(),
+ (<Sort> sorts_or_bool).csort)
elif isinstance(sorts_or_bool, list):
for s in sorts_or_bool:
v.push_back((<Sort?> s).csort)
- dd.cdd = self.csolver.mkDatatypeDecl(<const string &> name.encode(),
- <const vector[c_Sort]&> v)
+ dd.cdd = self.csolver.mkDatatypeDecl(
+ <const string &> name.encode(),
+ <const vector[c_Sort]&> v)
else:
raise ValueError("Unhandled second argument type {}"
.format(type(sorts_or_bool)))
elif sorts_or_bool is not None and isCoDatatype is not None:
if isinstance(sorts_or_bool, Sort):
- dd.cdd = self.csolver.mkDatatypeDecl(<const string &> name.encode(),
- (<Sort> sorts_or_bool).csort,
- <bint> isCoDatatype)
+ dd.cdd = self.csolver.mkDatatypeDecl(
+ <const string &> name.encode(),
+ (<Sort> sorts_or_bool).csort,
+ <bint> isCoDatatype)
elif isinstance(sorts_or_bool, list):
for s in sorts_or_bool:
v.push_back((<Sort?> s).csort)
- dd.cdd = self.csolver.mkDatatypeDecl(<const string &> name.encode(),
- <const vector[c_Sort]&> v,
- <bint> isCoDatatype)
+ dd.cdd = self.csolver.mkDatatypeDecl(
+ <const string &> name.encode(),
+ <const vector[c_Sort]&> v,
+ <bint> isCoDatatype)
else:
raise ValueError("Unhandled second argument type {}"
.format(type(sorts_or_bool)))
else:
- raise ValueError("Can't create DatatypeDecl with {}".format([type(a)
- for a in [name,
- sorts_or_bool,
- isCoDatatype]]))
+ raise ValueError("Can't create DatatypeDecl with {}".format(
+ [type(a) for a in [name, sorts_or_bool, isCoDatatype]]))
return dd
def simplify(self, Term t):
+ """
+ Simplify a formula without doing "much" work. Does not involve the
+ SAT Engine in the simplification, but uses the current definitions,
+ assertions, and the current partial model, if one has been
+ constructed. It also involves theory normalization.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param t: The formula to simplify.
+ :return: The simplified formula.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.simplify(t.cterm)
return term
def assertFormula(self, Term term):
+ """
+ Assert a formula
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( assert <term> )
+
+ :param term: The formula to assert.
+ """
self.csolver.assertFormula(term.cterm)
def checkSat(self):
+ """
+ Check satisfiability.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( check-sat )
+
+ :return: The result of the satisfiability check.
+ """
cdef Result r = Result()
r.cr = self.csolver.checkSat()
return r
def mkSygusGrammar(self, boundVars, ntSymbols):
+ """
+ Create a SyGuS grammar. The first non-terminal is treated as the
+ starting non-terminal, so the order of non-terminals matters.
+
+ :param boundVars: The parameters to corresponding
+ synth-fun/synth-inv.
+ :param ntSymbols: The pre-declaration of the non-terminal symbols.
+ :return: The grammar.
+ """
cdef Grammar grammar = Grammar(self)
cdef vector[c_Term] bvc
cdef vector[c_Term] ntc
grammar.cgrammar = self.csolver.mkSygusGrammar(<const vector[c_Term]&> bvc, <const vector[c_Term]&> ntc)
return grammar
- def mkSygusVar(self, Sort sort, str symbol=""):
+ def declareSygusVar(self, str symbol, Sort sort):
+ """
+ Append symbol to the current list of universal variables.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( declare-var <symbol> <sort> )
+
+ :param sort: The sort of the universal variable.
+ :param symbol: The name of the universal variable.
+ :return: The universal variable.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.mkSygusVar(sort.csort, symbol.encode())
+ term.cterm = self.csolver.declareSygusVar(symbol.encode(), sort.csort)
return term
def addSygusConstraint(self, Term t):
+ """
+ Add a formula to the set of SyGuS constraints.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( constraint <term> )
+
+ :param term: The formula to add as a constraint.
+ """
self.csolver.addSygusConstraint(t.cterm)
+ def addSygusAssume(self, Term t):
+ """
+ Add a formula to the set of Sygus assumptions.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( assume <term> )
+
+ :param term: The formuula to add as an assumption.
+ """
+ self.csolver.addSygusAssume(t.cterm)
+
def addSygusInvConstraint(self, Term inv_f, Term pre_f, Term trans_f, Term post_f):
- self.csolver.addSygusInvConstraint(inv_f.cterm, pre_f.cterm, trans_f.cterm, post_f.cterm)
+ """
+ Add a set of SyGuS constraints to the current state that correspond
+ to an invariant synthesis problem.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( inv-constraint <inv> <pre> <trans> <post> )
+
+ :param inv: The function-to-synthesize.
+ :param pre: The pre-condition.
+ :param trans: The transition relation.
+ :param post: The post-condition.
+ """
+ self.csolver.addSygusInvConstraint(
+ inv_f.cterm, pre_f.cterm, trans_f.cterm, post_f.cterm)
def synthFun(self, str symbol, bound_vars, Sort sort, Grammar grammar=None):
+ """
+ Synthesize n-ary function following specified syntactic constraints.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( synth-fun <symbol> ( <boundVars>* ) <sort> <g> )
+
+ :param symbol: The name of the function.
+ :param boundVars: The parameters to this function.
+ :param sort: The sort of the return value of this function.
+ :param grammar: The syntactic constraints.
+ :return: The function.
+ """
cdef Term term = Term(self)
cdef vector[c_Term] v
for bv in bound_vars:
return term
def checkSynth(self):
- cdef Result r = Result()
+ """
+ Try to find a solution for the synthesis conjecture corresponding
+ to the current list of functions-to-synthesize, universal variables
+ and constraints.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( check-synth )
+
+ :return: The result of the check, which is "solution" if the check
+ found a solution in which case solutions are available via
+ getSynthSolutions, "no solution" if it was determined
+ there is no solution, or "unknown" otherwise.
+ """
+ cdef SynthResult r = SynthResult()
r.cr = self.csolver.checkSynth()
return r
+ def checkSynthNext(self):
+ """
+ Try to find a next solution for the synthesis conjecture
+ corresponding to the current list of functions-to-synthesize,
+ universal variables and constraints. Must be called immediately
+ after a successful call to check-synth or check-synth-next.
+ Requires incremental mode.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( check-synth )
+
+ :return: The result of the check, which is "solution" if the check
+ found a solution in which case solutions are available via
+ getSynthSolutions, "no solution" if it was determined
+ there is no solution, or "unknown" otherwise.
+ """
+ cdef SynthResult r = SynthResult()
+ r.cr = self.csolver.checkSynthNext()
+ return r
+
def getSynthSolution(self, Term term):
+ """
+ Get the synthesis solution of the given term. This method should be
+ called immediately after the solver answers unsat for sygus input.
+
+ :param term: The term for which the synthesis solution is queried.
+ :return: The synthesis solution of the given term.
+ """
cdef Term t = Term(self)
t.cterm = self.csolver.getSynthSolution(term.cterm)
return t
def getSynthSolutions(self, list terms):
+ """
+ Get the synthesis solutions of the given terms. This method should
+ be called immediately after the solver answers unsat for sygus
+ input.
+
+ :param terms: The terms for which the synthesis solutions is
+ queried.
+ :return: The synthesis solutions of the given terms.
+ """
result = []
cdef vector[c_Term] vec
for t in terms:
def synthInv(self, symbol, bound_vars, Grammar grammar=None):
+ """
+ Synthesize invariant.
+
+ SyGuS v2:
+
+ .. code-block:: smtlib
+
+ ( synth-inv <symbol> ( <boundVars>* ) <grammar> )
+
+ :param symbol: The name of the invariant.
+ :param boundVars: The parameters to this invariant.
+ :param grammar: The syntactic constraints.
+ :return: The invariant.
+ """
cdef Term term = Term(self)
cdef vector[c_Term] v
for bv in bound_vars:
v.push_back((<Term?> bv).cterm)
if grammar is None:
- term.cterm = self.csolver.synthInv(symbol.encode(), <const vector[c_Term]&> v)
+ term.cterm = self.csolver.synthInv(
+ symbol.encode(), <const vector[c_Term]&> v)
else:
- term.cterm = self.csolver.synthInv(symbol.encode(), <const vector[c_Term]&> v, grammar.cgrammar)
+ term.cterm = self.csolver.synthInv(
+ symbol.encode(),
+ <const vector[c_Term]&> v,
+ grammar.cgrammar)
return term
- @expand_list_arg(num_req_args=0)
def checkSatAssuming(self, *assumptions):
- '''
- Supports the following arguments:
- Result checkSatAssuming(List[Term] assumptions)
+ """
+ Check satisfiability assuming the given formula.
- where assumptions can also be comma-separated arguments of
- type (boolean) Term
- '''
- cdef Result r = Result()
- # used if assumptions is a list of terms
- cdef vector[c_Term] v
- for a in assumptions:
- v.push_back((<Term?> a).cterm)
- r.cr = self.csolver.checkSatAssuming(<const vector[c_Term]&> v)
- return r
+ SMT-LIB:
- @expand_list_arg(num_req_args=0)
- def checkEntailed(self, *assumptions):
- '''
- Supports the following arguments:
- Result checkEntailed(List[Term] assumptions)
+ .. code-block:: smtlib
+
+ ( check-sat-assuming ( <prop_literal> ) )
- where assumptions can also be comma-separated arguments of
- type (boolean) Term
- '''
+ :param assumptions: The formulas to assume.
+ :return: The result of the satisfiability check.
+ """
cdef Result r = Result()
# used if assumptions is a list of terms
cdef vector[c_Term] v
for a in assumptions:
v.push_back((<Term?> a).cterm)
- r.cr = self.csolver.checkEntailed(<const vector[c_Term]&> v)
+ r.cr = self.csolver.checkSatAssuming(<const vector[c_Term]&> v)
return r
- @expand_list_arg(num_req_args=1)
def declareDatatype(self, str symbol, *ctors):
- '''
- Supports the following arguments:
- Sort declareDatatype(str symbol, List[Term] ctors)
+ """
+ Create datatype sort.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
- where ctors can also be comma-separated arguments of
- type DatatypeConstructorDecl
- '''
+ ( declare-datatype <symbol> <datatype_decl> )
+
+ :param symbol: The name of the datatype sort.
+ :param ctors: The constructor declarations of the datatype sort.
+ :return: The datatype sort.
+ """
cdef Sort sort = Sort(self)
cdef vector[c_DatatypeConstructorDecl] v
return sort
def declareFun(self, str symbol, list sorts, Sort sort):
+ """
+ Declare n-ary function symbol.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( declare-fun <symbol> ( <sort>* ) <sort> )
+
+ :param symbol: The name of the function.
+ :param sorts: The sorts of the parameters to this function.
+ :param sort: The sort of the return value of this function.
+ :return: The function.
+ """
cdef Term term = Term(self)
cdef vector[c_Sort] v
for s in sorts:
return term
def declareSort(self, str symbol, int arity):
+ """
+ Declare uninterpreted sort.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( declare-sort <symbol> <numeral> )
+
+ .. note::
+
+ This corresponds to :py:meth:`Solver.mkUninterpretedSort()` if
+ arity = 0, and to
+ :py:meth:`Solver.mkUninterpretedSortConstructorSort()` if
+ arity > 0.
+
+ :param symbol: The name of the sort.
+ :param arity: The arity of the sort.
+ :return: The sort.
+ """
cdef Sort sort = Sort(self)
sort.csort = self.csolver.declareSort(symbol.encode(), arity)
return sort
- def defineFun(self, sym_or_fun, bound_vars, sort_or_term, t=None, glbl=False):
- '''
- Supports two uses:
- Term defineFun(str symbol, List[Term] bound_vars,
- Sort sort, Term term, bool glbl)
- Term defineFun(Term fun, List[Term] bound_vars,
- Term term, bool glbl)
- '''
+ def defineFun(self, str symbol, list bound_vars, Sort sort, Term term, glbl=False):
+ """
+ Define n-ary function.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( define-fun <function_def> )
+
+ :param symbol: The name of the function.
+ :param bound_vars: The parameters to this function.
+ :param sort: The sort of the return value of this function.
+ :param term: The function body.
+ :param glbl: Determines whether this definition is global (i.e.
+ persists when popping the context).
+ :return: The function.
+ """
+ cdef Term fun = Term(self)
+ cdef vector[c_Term] v
+ for bv in bound_vars:
+ v.push_back((<Term?> bv).cterm)
+
+ fun.cterm = self.csolver.defineFun(symbol.encode(),
+ <const vector[c_Term] &> v,
+ sort.csort,
+ term.cterm,
+ <bint> glbl)
+ return fun
+
+ def defineFunRec(self, sym_or_fun, bound_vars, sort_or_term, t=None, glbl=False):
+ """
+ Define recursive functions.
+
+ Supports the following arguments:
+
+ - ``Term defineFunRec(str symbol, List[Term] bound_vars, Sort sort, Term term, bool glbl)``
+ - ``Term defineFunRec(Term fun, List[Term] bound_vars, Term term, bool glbl)``
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( define-funs-rec ( <function_decl>^n ) ( <term>^n ) )
+
+ Create elements of parameter ``funs`` with :py:meth:`mkConst() <cvc5.Solver.mkConst()>`.
+
+ :param funs: The sorted functions.
+ :param bound_vars: The list of parameters to the functions.
+ :param terms: The list of function bodies of the functions.
+ :param global: Determines whether this definition is global (i.e.
+ persists when popping the context).
+ :return: The function.
+ """
cdef Term term = Term(self)
cdef vector[c_Term] v
for bv in bound_vars:
v.push_back((<Term?> bv).cterm)
if t is not None:
- term.cterm = self.csolver.defineFun((<str?> sym_or_fun).encode(),
- <const vector[c_Term] &> v,
- (<Sort?> sort_or_term).csort,
- (<Term?> t).cterm,
- <bint> glbl)
- else:
- term.cterm = self.csolver.defineFun((<Term?> sym_or_fun).cterm,
- <const vector[c_Term]&> v,
- (<Term?> sort_or_term).cterm,
- <bint> glbl)
-
- return term
-
- def defineFunRec(self, sym_or_fun, bound_vars, sort_or_term, t=None, glbl=False):
- '''
- Supports two uses:
- Term defineFunRec(str symbol, List[Term] bound_vars,
- Sort sort, Term term, bool glbl)
- Term defineFunRec(Term fun, List[Term] bound_vars,
- Term term, bool glbl)
- '''
- cdef Term term = Term(self)
- cdef vector[c_Term] v
- for bv in bound_vars:
- v.push_back((<Term?> bv).cterm)
-
- if t is not None:
- term.cterm = self.csolver.defineFunRec((<str?> sym_or_fun).encode(),
+ term.cterm = self.csolver.defineFunRec((<str?> sym_or_fun).encode(),
<const vector[c_Term] &> v,
(<Sort?> sort_or_term).csort,
(<Term?> t).cterm,
return term
def defineFunsRec(self, funs, bound_vars, terms):
+ """
+ Define recursive functions.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( define-funs-rec ( <function_decl>^n ) ( <term>^n ) )
+
+ Create elements of parameter ``funs`` with :py:meth:`mkConst() <cvc5.Solver.mkConst()>`.
+
+ :param funs: The sorted functions.
+ :param bound_vars: The list of parameters to the functions.
+ :param terms: The list of function bodies of the functions.
+ :param global: Determines whether this definition is global (i.e.
+ persists when popping the context).
+ :return: The function.
+ """
cdef vector[c_Term] vf
cdef vector[vector[c_Term]] vbv
cdef vector[c_Term] vt
for t in terms:
vf.push_back((<Term?> t).cterm)
+ def getProof(self):
+ """
+ Get the refutation proof
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ (get-proof)
+
+ Requires to enable option
+ :ref:`produce-proofs <lbl-option-produce-proofs>`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: A string representing the proof, according to the value of
+ :ref:`proof-format-mode <lbl-option-proof-format-mode>`.
+ """
+ return self.csolver.getProof()
+
+ def getLearnedLiterals(self):
+ """
+ Get a list of literals that are entailed by the current set of assertions
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-learned-literals )
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: The list of literals.
+ """
+ lits = []
+ for a in self.csolver.getLearnedLiterals():
+ term = Term(self)
+ term.cterm = a
+ lits.append(term)
+ return lits
+
def getAssertions(self):
+ """
+ Get the list of asserted formulas.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-assertions )
+
+ :return: The list of asserted formulas.
+ """
assertions = []
for a in self.csolver.getAssertions():
term = Term(self)
return assertions
def getInfo(self, str flag):
+ """
+ Get info from the solver.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-info <info_flag> )
+
+ :param flag: The info flag.
+ :return: The info.
+ """
return self.csolver.getInfo(flag.encode())
def getOption(self, str option):
- return self.csolver.getOption(option.encode())
+ """
+ Get the value of a given option.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-option <keyword> )
+
+ :param option: The option for which the value is queried.
+ :return: A string representation of the option value.
+ """
+ return self.csolver.getOption(option.encode()).decode()
+
+ def getOptionNames(self):
+ """
+ Get all option names that can be used with
+ :py:meth:`Solver.setOption()`, :py:meth:`Solver.getOption()`
+ and :py:meth:`Solver.getOptionInfo()`.
+
+ :return: All option names.
+ """
+ return [s.decode() for s in self.csolver.getOptionNames()]
+
+ def getOptionInfo(self, str option):
+ """
+ Get some information about the given option.
+ Returns the information provided by the C++
+ :cpp:func:`OptionInfo <cvc5::OptionInfo>` as a dictionary.
+
+ :return: Information about the given option.
+ """
+ # declare all the variables we may need later
+ cdef c_OptionInfo.ValueInfo[c_bool] vib
+ cdef c_OptionInfo.ValueInfo[string] vis
+ cdef c_OptionInfo.NumberInfo[int64_t] nii
+ cdef c_OptionInfo.NumberInfo[uint64_t] niu
+ cdef c_OptionInfo.NumberInfo[double] nid
+ cdef c_OptionInfo.ModeInfo mi
+
+ oi = self.csolver.getOptionInfo(option.encode())
+ # generic information
+ res = {
+ 'name': oi.name.decode(),
+ 'aliases': [s.decode() for s in oi.aliases],
+ 'setByUser': oi.setByUser,
+ }
+
+ # now check which type is actually in the variant
+ if c_holds[c_OptionInfo.VoidInfo](oi.valueInfo):
+ # it's a void
+ res['type'] = None
+ elif c_holds[c_OptionInfo.ValueInfo[c_bool]](oi.valueInfo):
+ # it's a bool
+ res['type'] = bool
+ vib = c_getVariant[c_OptionInfo.ValueInfo[c_bool]](oi.valueInfo)
+ res['current'] = vib.currentValue
+ res['default'] = vib.defaultValue
+ elif c_holds[c_OptionInfo.ValueInfo[string]](oi.valueInfo):
+ # it's a string
+ res['type'] = str
+ vis = c_getVariant[c_OptionInfo.ValueInfo[string]](oi.valueInfo)
+ res['current'] = vis.currentValue.decode()
+ res['default'] = vis.defaultValue.decode()
+ elif c_holds[c_OptionInfo.NumberInfo[int64_t]](oi.valueInfo):
+ # it's an int64_t
+ res['type'] = int
+ nii = c_getVariant[c_OptionInfo.NumberInfo[int64_t]](oi.valueInfo)
+ res['current'] = nii.currentValue
+ res['default'] = nii.defaultValue
+ res['minimum'] = nii.minimum.value() \
+ if nii.minimum.has_value() else None
+ res['maximum'] = nii.maximum.value() \
+ if nii.maximum.has_value() else None
+ elif c_holds[c_OptionInfo.NumberInfo[uint64_t]](oi.valueInfo):
+ # it's a uint64_t
+ res['type'] = int
+ niu = c_getVariant[c_OptionInfo.NumberInfo[uint64_t]](oi.valueInfo)
+ res['current'] = niu.currentValue
+ res['default'] = niu.defaultValue
+ res['minimum'] = niu.minimum.value() \
+ if niu.minimum.has_value() else None
+ res['maximum'] = niu.maximum.value() \
+ if niu.maximum.has_value() else None
+ elif c_holds[c_OptionInfo.NumberInfo[double]](oi.valueInfo):
+ # it's a double
+ res['type'] = float
+ nid = c_getVariant[c_OptionInfo.NumberInfo[double]](oi.valueInfo)
+ res['current'] = nid.currentValue
+ res['default'] = nid.defaultValue
+ res['minimum'] = nid.minimum.value() \
+ if nid.minimum.has_value() else None
+ res['maximum'] = nid.maximum.value() \
+ if nid.maximum.has_value() else None
+ elif c_holds[c_OptionInfo.ModeInfo](oi.valueInfo):
+ # it's a mode
+ res['type'] = 'mode'
+ mi = c_getVariant[c_OptionInfo.ModeInfo](oi.valueInfo)
+ res['current'] = mi.currentValue.decode()
+ res['default'] = mi.defaultValue.decode()
+ res['modes'] = [s.decode() for s in mi.modes]
+ return res
def getUnsatAssumptions(self):
+ """
+ Get the set of unsat ("failed") assumptions.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-unsat-assumptions )
+
+ Requires to enable option :ref:`produce-unsat-assumptions
+ <lbl-option-produce-unsat-assumptions>`.
+
+ :return: The set of unsat assumptions.
+ """
assumptions = []
for a in self.csolver.getUnsatAssumptions():
term = Term(self)
return assumptions
def getUnsatCore(self):
+ """
+ Get the unsatisfiable core.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ (get-unsat-core)
+
+ Requires to enable option :ref:`produce-unsat-cores
+ <lbl-option-produce-unsat-cores>`.
+
+ .. note::
+
+ In contrast to SMT-LIB, the API does not distinguish between
+ named and unnamed assertions when producing an unsatisfiable
+ core. Additionally, the API allows this option to be called after
+ a check with assumptions. A subset of those assumptions may be
+ included in the unsatisfiable core returned by this method.
+
+ :return: A set of terms representing the unsatisfiable core.
+ """
core = []
for a in self.csolver.getUnsatCore():
term = Term(self)
core.append(term)
return core
+ def getDifficulty(self):
+ """
+ Get a difficulty estimate for an asserted formula. This method is
+ intended to be called immediately after any response to a
+ :py:meth:`Solver.checkSat()` call.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: A map from (a subset of) the input assertions to a real
+ value that is an estimate of how difficult each assertion
+ was to solver. Unmentioned assertions can be assumed to
+ have zero difficulty.
+ """
+ diffi = {}
+ for p in self.csolver.getDifficulty():
+ k = p.first
+ v = p.second
+
+ termk = Term(self)
+ termk.cterm = k
+
+ termv = Term(self)
+ termv.cterm = v
+
+ diffi[termk] = termv
+ return diffi
+
def getValue(self, Term t):
+ """
+ Get the value of the given term in the current model.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-value ( <term> ) )
+
+ :param term: The term for which the value is queried.
+ :return: The value of the given term.
+ """
cdef Term term = Term(self)
term.cterm = self.csolver.getValue(t.cterm)
return term
- def getSeparationHeap(self):
+ def getModelDomainElements(self, Sort s):
+ """
+ Get the domain elements of uninterpreted sort s in the current
+ model. The current model interprets s as the finite sort whose
+ domain elements are given in the return value of this method.
+
+ :param s: The uninterpreted sort in question.
+ :return: The domain elements of s in the current model.
+ """
+ result = []
+ cresult = self.csolver.getModelDomainElements(s.csort)
+ for e in cresult:
+ term = Term(self)
+ term.cterm = e
+ result.append(term)
+ return result
+
+ def isModelCoreSymbol(self, Term v):
+ """
+ This returns False if the model value of free constant v was not
+ essential for showing the satisfiability of the last call to
+ checkSat using the current model. This method will only return
+ false (for any v) if the model-cores option has been set.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param v: The term in question.
+ :return: True if v is a model core symbol.
+ """
+ return self.csolver.isModelCoreSymbol(v.cterm)
+
+ def getQuantifierElimination(self, Term term):
+ """
+ Do quantifier elimination.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-qe <q> )
+
+ Requires a logic that supports quantifier elimination.
+ Currently, the only logics supported by quantifier elimination
+ are LRA and LIA.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param q: A quantified formula of the form
+ :math:`Q\\bar{x_1}\\dots Q\\bar{x}_n. P( x_1 \\dots x_i, y_1 \\dots y_j)`
+ where
+ :math:`Q\\bar{x}` is a set of quantified variables of the
+ form :math:`Q x_1...x_k` and
+ :math:`P( x_1...x_i, y_1...y_j )` is a quantifier-free
+ formula
+ :return: A formula :math:`\\phi` such that, given the current set
+ of formulas :math:`A` asserted to this solver:
+
+ - :math:`(A \\wedge q)` :math:`(A \\wedge \\phi)` are
+ equivalent
+ - :math:`\\phi` is quantifier-free formula containing only
+ free variables in :math:`y_1...y_n`.
+ """
+ cdef Term result = Term(self)
+ result.cterm = self.csolver.getQuantifierElimination(term.cterm)
+ return result
+
+ def getQuantifierEliminationDisjunct(self, Term term):
+ """
+ Do partial quantifier elimination, which can be used for
+ incrementally computing the result of a quantifier elimination.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-qe-disjunct <q> )
+
+ Requires a logic that supports quantifier elimination.
+ Currently, the only logics supported by quantifier elimination
+ are LRA and LIA.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param q: A quantified formula of the form
+ :math:`Q\\bar{x_1} ... Q\\bar{x_n}. P( x_1...x_i, y_1...y_j)`
+ where :math:`Q\\bar{x}` is a set of quantified variables of
+ the form :math:`Q x_1...x_k` and
+ :math:`P( x_1...x_i, y_1...y_j )` is a quantifier-free formula.
+
+ :return: A formula :math:`\\phi` such that, given the current set
+ of formulas :math:`A` asserted to this solver:
+
+ - :math:`(A \\wedge q \\implies A \\wedge \\phi)` if :math:`Q`
+ is :math:`\\forall`, and
+ :math:`(A \\wedge \\phi \\implies A \\wedge q)` if
+ :math:`Q` is :math:`\\exists`
+ - :math:`\\phi` is quantifier-free formula containing only
+ free variables in :math:`y_1...y_n`
+ - If :math:`Q` is :math:`\\exists`, let :math:`(A \\wedge Q_n)`
+ be the formula
+ :math:`(A \\wedge \\neg (\\phi \wedge Q_1) \\wedge ... \\wedge \\neg (\\phi \\wedge Q_n))`
+ where for each :math:`i = 1...n`, formula
+ :math:`(\\phi \\wedge Q_i)` is the result of calling
+ :py:meth:`getQuantifierEliminationDisjunct()`
+ for :math:`q` with the set of assertions
+ :math:`(A \\wedge Q_{i-1})`.
+ Similarly, if :math:`Q` is :math:`\\forall`, then let
+ :math:`(A \\wedge Q_n)` be
+ :math:`(A \\wedge (\\phi \\wedge Q_1) \\wedge ... \\wedge (\\phi \\wedge Q_n))`
+ where :math:`(\\phi \\wedge Q_i)` is the same as above.
+ In either case, we have that :math:`(\\phi \\wedge Q_j)`
+ will eventually be true or false, for some finite :math:`j`.
+ """
+ cdef Term result = Term(self)
+ result.cterm = self.csolver.getQuantifierEliminationDisjunct(term.cterm)
+ return result
+
+ def getModel(self, sorts, consts):
+ """
+ Get the model
+
+ SMT-LIB:
+
+ .. code:: smtlib
+
+ (get-model)
+
+ Requires to enable option
+ :ref:`produce-models <lbl-option-produce-models>`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param sorts: The list of uninterpreted sorts that should be
+ printed in the model.
+ :param vars: The list of free constants that should be printed in
+ the model. A subset of these may be printed based on
+ :py:meth:`Solver.isModelCoreSymbol()`.
+ :return: A string representing the model.
+ """
+
+ cdef vector[c_Sort] csorts
+ for sort in sorts:
+ csorts.push_back((<Sort?> sort).csort)
+
+ cdef vector[c_Term] cconsts
+ for const in consts:
+ cconsts.push_back((<Term?> const).cterm)
+
+ return self.csolver.getModel(csorts, cconsts)
+
+ def getValueSepHeap(self):
+ """
+ When using separation logic, obtain the term for the heap.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: The term for the heap.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.getSeparationHeap()
+ term.cterm = self.csolver.getValueSepHeap()
return term
- def declareSeparationHeap(self, Sort locType, Sort dataType):
- self.csolver.declareSeparationHeap(locType.csort, dataType.csort)
+ def getValueSepNil(self):
+ """
+ When using separation logic, obtain the term for nil.
- def getSeparationNilTerm(self):
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: The term for nil.
+ """
cdef Term term = Term(self)
- term.cterm = self.csolver.getSeparationNilTerm()
+ term.cterm = self.csolver.getValueSepNil()
return term
+ def declareSepHeap(self, Sort locType, Sort dataType):
+ """
+ When using separation logic, this sets the location sort and the
+ datatype sort to the given ones. This method should be invoked
+ exactly once, before any separation logic constraints are provided.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param locSort: The location sort of the heap.
+ :param dataSort: The data sort of the heap.
+ """
+ self.csolver.declareSepHeap(locType.csort, dataType.csort)
+
def declarePool(self, str symbol, Sort sort, initValue):
+ """
+ Declare a symbolic pool of terms with the given initial value.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( declare-pool <symbol> <sort> ( <term>* ) )
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param symbol: The name of the pool.
+ :param sort: The sort of the elements of the pool.
+ :param initValue: The initial value of the pool.
+ """
cdef Term term = Term(self)
cdef vector[c_Term] niv
for v in initValue:
return term
def pop(self, nscopes=1):
+ """
+ Pop ``nscopes`` level(s) from the assertion stack.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( pop <numeral> )
+
+ :param nscopes: The number of levels to pop.
+ """
self.csolver.pop(nscopes)
def push(self, nscopes=1):
+ """
+ Push ``nscopes`` level(s) to the assertion stack.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( push <numeral> )
+
+ :param nscopes: The number of levels to push.
+ """
self.csolver.push(nscopes)
def resetAssertions(self):
+ """
+ Remove all assertions.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( reset-assertions )
+
+ """
self.csolver.resetAssertions()
def setInfo(self, str keyword, str value):
+ """
+ Set info.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( set-info <attribute> )
+
+ :param keyword: The info flag.
+ :param value: The value of the info flag.
+ """
self.csolver.setInfo(keyword.encode(), value.encode())
def setLogic(self, str logic):
+ """
+ Set logic.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( set-logic <symbol> )
+
+ :param logic: The logic to set.
+ """
self.csolver.setLogic(logic.encode())
def setOption(self, str option, str value):
+ """
+ Set option.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( set-option <option> )
+
+ :param option: The option name.
+ :param value: The option value.
+ """
self.csolver.setOption(option.encode(), value.encode())
+ def getInterpolant(self, Term conj, Grammar grammar=None):
+ """
+ Get an interpolant.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-interpolant <conj> )
+ ( get-interpolant <conj> <grammar> )
+
+ Requires option :ref:`produce-interpolants
+ <lbl-option-produce-interpolants>` to be set to a mode different
+ from `none`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+ :param conj: The conjecture term.
+ :param grammar: A grammar for the inteprolant.
+ :return: The interpolant.
+ See :cpp:func:`cvc5::Solver::getInterpolant` for details.
+ """
+ cdef Term result = Term(self)
+ if grammar is None:
+ result.cterm = self.csolver.getInterpolant(conj.cterm)
+ else:
+ result.cterm = self.csolver.getInterpolant(conj.cterm, grammar.cgrammar)
+ return result
+
+
+ def getInterpolantNext(self):
+ """
+ Get the next interpolant. Can only be called immediately after
+ a successful call to :py:func:`Solver.getInterpolant()` or
+ :py:func:`Solver.getInterpolantNext()`.
+ Is guaranteed to produce a syntactically different interpolant wrt
+ the last returned interpolant if successful.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-interpolant-next )
+
+ Requires to enable incremental mode, and option
+ :ref:`produce-interpolants <lbl-option-produce-interpolants>` to be
+ set to a mode different from ``none``.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param output: The term where the result will be stored.
+ :return: True iff an interpolant was found.
+ """
+ cdef Term result = Term(self)
+ result.cterm = self.csolver.getInterpolantNext()
+ return result
+ def getAbduct(self, Term conj, Grammar grammar=None):
+ """
+ Get an abduct.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-abduct <conj> )
+ ( get-abduct <conj> <grammar> )
+
+ Requires to enable option :ref:`produce-abducts
+ <lbl-option-produce-abducts>`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+ :param conj: The conjecture term.
+ :param grammar: A grammar for the abduct.
+ :return: The abduct.
+ See :cpp:func:`cvc5::Solver::getAbduct` for details.
+ """
+ cdef Term result = Term(self)
+ if grammar is None:
+ result.cterm = self.csolver.getAbduct(conj.cterm)
+ else:
+ result.cterm = self.csolver.getAbduct(conj.cterm, grammar.cgrammar)
+ return result
+
+ def getAbductNext(self):
+ """
+ Get the next abduct. Can only be called immediately after
+ a succesful call to :py:func:`Solver.getAbduct()` or
+ :py:func:`Solver.getAbductNext()`.
+ Is guaranteed to produce a syntactically different abduct wrt the
+ last returned abduct if successful.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ ( get-abduct-next )
+
+ Requires to enable incremental mode, and
+ option :ref:`produce-abducts <lbl-option-produce-abducts>`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param output: The term where the result will be stored.
+ :return: True iff an abduct was found.
+ """
+ cdef Term result = Term(self)
+ result.cterm = self.csolver.getAbductNext()
+ return result
+
+ def blockModel(self, mode):
+ """
+ Block the current model. Can be called only if immediately preceded
+ by a SAT or INVALID query.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ (block-model)
+
+ Requires enabling option
+ :ref:`produce-models <lbl-option-produce-models>`
+ and setting option
+ :ref:`block-models <lbl-option-block-models>`
+ to a mode other than ``none``.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param mode: The mode to use for blocking
+ """
+ self.csolver.blockModel(<c_BlockModelsMode> mode.value)
+
+ def blockModelValues(self, terms):
+ """
+ Block the current model values of (at least) the values in terms.
+ Can be called only if immediately preceded by a SAT or NOT_ENTAILED
+ query.
+
+ SMT-LIB:
+
+ .. code-block:: smtlib
+
+ (block-model-values ( <terms>+ ))
+
+ Requires enabling option
+ :ref:`produce-models <lbl-option-produce-models>`.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+ """
+ cdef vector[c_Term] nts
+ for t in terms:
+ nts.push_back((<Term?> t).cterm)
+ self.csolver.blockModelValues(nts)
+
+ def getInstantiations(self):
+ """
+ Return a string that contains information about all instantiations
+ made by the quantifiers module.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+ """
+ return self.csolver.getInstantiations()
+
+ def getStatistics(self):
+ """
+ Returns a snapshot of the current state of the statistic values of
+ this solver. The returned object is completely decoupled from the
+ solver and will not change when the solver is used again.
+ """
+ res = Statistics()
+ res.cstats = self.csolver.getStatistics()
+ return res
+
+
cdef class Sort:
+ """
+ The sort of a cvc5 term.
+
+ Wrapper class for :cpp:class:`cvc5::Sort`.
+ """
cdef c_Sort csort
cdef Solver solver
def __cinit__(self, Solver solver):
def __hash__(self):
return csorthash(self.csort)
+ def hasSymbol(self):
+ """
+ :return: True iff this sort has a symbol.
+ """
+ return self.csort.hasSymbol()
+
+ def getSymbol(self):
+ """
+ Asserts :py:meth:`hasSymbol()`.
+
+ :return: The raw symbol of the sort.
+ """
+ return self.csort.getSymbol().decode()
+
+ def isNull(self):
+ """
+ :return: True if this Sort is a null sort.
+ """
+ return self.csort.isNull()
+
def isBoolean(self):
+ """
+ Is this a Boolean sort?
+
+ :return: True if the sort is the Boolean sort.
+ """
return self.csort.isBoolean()
def isInteger(self):
+ """
+ Is this an integer sort?
+
+ :return: True if the sort is the integer sort.
+ """
return self.csort.isInteger()
def isReal(self):
+ """
+ Is this a real sort?
+
+ :return: True if the sort is the real sort.
+ """
return self.csort.isReal()
def isString(self):
+ """
+ Is this a string sort?
+
+ :return: True if the sort is the string sort.
+ """
return self.csort.isString()
def isRegExp(self):
+ """
+ Is this a regexp sort?
+
+ :return: True if the sort is the regexp sort.
+ """
return self.csort.isRegExp()
def isRoundingMode(self):
+ """
+ Is this a rounding mode sort?
+
+ :return: True if the sort is the rounding mode sort.
+ """
return self.csort.isRoundingMode()
def isBitVector(self):
+ """
+ Is this a bit-vector sort?
+
+ :return: True if the sort is a bit-vector sort.
+ """
return self.csort.isBitVector()
def isFloatingPoint(self):
+ """
+ Is this a floating-point sort?
+
+ :return: True if the sort is a bit-vector sort.
+ """
return self.csort.isFloatingPoint()
def isDatatype(self):
+ """
+ Is this a datatype sort?
+
+ :return: True if the sort is a datatype sort.
+ """
return self.csort.isDatatype()
- def isParametricDatatype(self):
- return self.csort.isParametricDatatype()
+ def isDatatypeConstructor(self):
+ """
+ Is this a datatype constructor sort?
+
+ :return: True if the sort is a datatype constructor sort.
+ """
+ return self.csort.isDatatypeConstructor()
+
+ def isDatatypeSelector(self):
+ """
+ Is this a datatype selector sort?
+
+ :return: True if the sort is a datatype selector sort.
+ """
+ return self.csort.isDatatypeSelector()
- def isConstructor(self):
- return self.csort.isConstructor()
+ def isDatatypeTester(self):
+ """
+ Is this a tester sort?
- def isSelector(self):
- return self.csort.isSelector()
+ :return: True if the sort is a selector sort.
+ """
+ return self.csort.isDatatypeTester()
- def isTester(self):
- return self.csort.isTester()
+ def isDatatypeUpdater(self):
+ """
+ Is this a datatype updater sort?
+
+ :return: True if the sort is a datatype updater sort.
+ """
+ return self.csort.isDatatypeUpdater()
def isFunction(self):
+ """
+ Is this a function sort?
+
+ :return: True if the sort is a function sort.
+ """
return self.csort.isFunction()
def isPredicate(self):
+ """
+ Is this a predicate sort?
+ That is, is this a function sort mapping to Boolean? All predicate
+ sorts are also function sorts.
+
+ :return: True if the sort is a predicate sort.
+ """
return self.csort.isPredicate()
def isTuple(self):
+ """
+ Is this a tuple sort?
+
+ :return: True if the sort is a tuple sort.
+ """
return self.csort.isTuple()
def isRecord(self):
+ """
+ Is this a record sort?
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :return: True if the sort is a record sort.
+ """
return self.csort.isRecord()
def isArray(self):
+ """
+ Is this an array sort?
+
+ :return: True if the sort is an array sort.
+ """
return self.csort.isArray()
def isSet(self):
+ """
+ Is this a set sort?
+
+ :return: True if the sort is a set sort.
+ """
return self.csort.isSet()
def isBag(self):
+ """
+ Is this a bag sort?
+
+ :return: True if the sort is a bag sort.
+ """
return self.csort.isBag()
-
+
def isSequence(self):
+ """
+ Is this a sequence sort?
+
+ :return: True if the sort is a sequence sort.
+ """
return self.csort.isSequence()
def isUninterpretedSort(self):
+ """
+ Is this a sort uninterpreted?
+
+ :return: True if the sort is uninterpreted.
+ """
return self.csort.isUninterpretedSort()
- def isSortConstructor(self):
- return self.csort.isSortConstructor()
+ def isUninterpretedSortConstructor(self):
+ """
+ Is this a sort constructor kind?
+
+ An uninterpreted sort constructor is an uninterpreted sort with
+ arity > 0.
- def isFirstClass(self):
- return self.csort.isFirstClass()
+ :return: True if this a sort constructor kind.
+ """
+ return self.csort.isUninterpretedSortConstructor()
- def isFunctionLike(self):
- return self.csort.isFunctionLike()
+ def isInstantiated(self):
+ """
+ Is this an instantiated (parametric datatype or uninterpreted sort
+ constructor) sort?
- def isSubsortOf(self, Sort sort):
- return self.csort.isSubsortOf(sort.csort)
+ An instantiated sort is a sort that has been constructed from
+ instantiating a sort parameters with sort arguments
+ (see :py:meth:`instantiate()`).
- def isComparableTo(self, Sort sort):
- return self.csort.isComparableTo(sort.csort)
+ :return: True if this is an instantiated sort.
+ """
+ return self.csort.isInstantiated()
+
+ def getUninterpretedSortConstructor(self):
+ """
+ Get the associated uninterpreted sort constructor of an
+ instantiated uninterpreted sort.
+
+ :return: The uninterpreted sort constructor sort
+ """
+ cdef Sort sort = Sort(self.solver)
+ sort.csort = self.csort.getUninterpretedSortConstructor()
+ return sort
def getDatatype(self):
+ """
+ :return: The underlying datatype of a datatype sort
+ """
cdef Datatype d = Datatype(self.solver)
d.cd = self.csort.getDatatype()
return d
def instantiate(self, params):
+ """
+ Instantiate a parameterized datatype sort or uninterpreted sort
+ constructor sort.
+
+ Create sorts parameter with :py:meth:`Solver.mkParamSort()`
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+
+ :param params: The list of sort parameters to instantiate with
+ :return: The instantiated sort
+ """
cdef Sort sort = Sort(self.solver)
cdef vector[c_Sort] v
for s in params:
sort.csort = self.csort.instantiate(v)
return sort
- def getConstructorArity(self):
- return self.csort.getConstructorArity()
+ def getInstantiatedParameters(self):
+ """
+ Get the sorts used to instantiate the sort parameters of a
+ parametric sort (parametric datatype or uninterpreted sort
+ constructor sort, see :py:meth:`instantiate()`).
+
+ :return: The sorts used to instantiate the sort parameters of a
+ parametric sort
+ """
+ instantiated_sorts = []
+ for s in self.csort.getInstantiatedParameters():
+ sort = Sort(self.solver)
+ sort.csort = s
+ instantiated_sorts.append(sort)
+ return instantiated_sorts
+
+ def substitute(self, sort_or_list_1, sort_or_list_2):
+ """
+ Substitution of Sorts.
+
+ Note that this replacement is applied during a pre-order traversal
+ and only once to the sort. It is not run until fix point. In the
+ case that sort_or_list_1 contains duplicates, the replacement
+ earliest in the list takes priority.
+
+ For example,
+ ``(Array A B) .substitute([A, C], [(Array C D), (Array A B)])``
+ will return ``(Array (Array C D) B)``.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
- def getConstructorDomainSorts(self):
+ :param sort_or_list_1: The subsort or subsorts to be substituted
+ within this sort.
+ :param sort_or_list_2: The sort or list of sorts replacing the
+ substituted subsort.
+ """
+
+ # The resulting sort after substitution
+ cdef Sort sort = Sort(self.solver)
+ # lists for substitutions
+ cdef vector[c_Sort] ces
+ cdef vector[c_Sort] creplacements
+
+ # normalize the input parameters to be lists
+ if isinstance(sort_or_list_1, list):
+ assert isinstance(sort_or_list_2, list)
+ es = sort_or_list_1
+ replacements = sort_or_list_2
+ if len(es) != len(replacements):
+ raise RuntimeError("Expecting list inputs to substitute to "
+ "have the same length but got: "
+ "{} and {}".format(
+ len(es), len(replacements)))
+
+ for e, r in zip(es, replacements):
+ ces.push_back((<Sort?> e).csort)
+ creplacements.push_back((<Sort?> r).csort)
+
+ else:
+ # add the single elements to the vectors
+ ces.push_back((<Sort?> sort_or_list_1).csort)
+ creplacements.push_back((<Sort?> sort_or_list_2).csort)
+
+ # call the API substitute method with lists
+ sort.csort = self.csort.substitute(ces, creplacements)
+ return sort
+
+
+ def getDatatypeConstructorArity(self):
+ """
+ :return: The arity of a datatype constructor sort.
+ """
+ return self.csort.getDatatypeConstructorArity()
+
+ def getDatatypeConstructorDomainSorts(self):
+ """
+ :return: The domain sorts of a datatype constructor sort.
+ """
domain_sorts = []
- for s in self.csort.getConstructorDomainSorts():
+ for s in self.csort.getDatatypeConstructorDomainSorts():
sort = Sort(self.solver)
sort.csort = s
domain_sorts.append(sort)
return domain_sorts
- def getConstructorCodomainSort(self):
+ def getDatatypeConstructorCodomainSort(self):
+ """
+ :return: The codomain sort of a datatype constructor sort.
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.csort.getConstructorCodomainSort()
+ sort.csort = self.csort.getDatatypeConstructorCodomainSort()
return sort
- def getSelectorDomainSort(self):
+ def getDatatypeSelectorDomainSort(self):
+ """
+ :return: The domain sort of a datatype selector sort.
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.csort.getSelectorDomainSort()
+ sort.csort = self.csort.getDatatypeSelectorDomainSort()
return sort
- def getSelectorCodomainSort(self):
+ def getDatatypeSelectorCodomainSort(self):
+ """
+ :return: The codomain sort of a datatype selector sort.
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.csort.getSelectorCodomainSort()
+ sort.csort = self.csort.getDatatypeSelectorCodomainSort()
return sort
- def getTesterDomainSort(self):
+ def getDatatypeTesterDomainSort(self):
+ """
+ :return: The domain sort of a datatype tester sort.
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.csort.getTesterDomainSort()
+ sort.csort = self.csort.getDatatypeTesterDomainSort()
return sort
- def getTesterCodomainSort(self):
+ def getDatatypeTesterCodomainSort(self):
+ """
+ :return: the codomain sort of a datatype tester sort, which is the
+ Boolean sort
+ """
cdef Sort sort = Sort(self.solver)
- sort.csort = self.csort.getTesterCodomainSort()
+ sort.csort = self.csort.getDatatypeTesterCodomainSort()
return sort
-
+
def getFunctionArity(self):
+ """
+ :return: The arity of a function sort.
+ """
return self.csort.getFunctionArity()
def getFunctionDomainSorts(self):
+ """
+ :return: The domain sorts of a function sort.
+ """
domain_sorts = []
for s in self.csort.getFunctionDomainSorts():
sort = Sort(self.solver)
return domain_sorts
def getFunctionCodomainSort(self):
+ """
+ :return: The codomain sort of a function sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getFunctionCodomainSort()
return sort
def getArrayIndexSort(self):
+ """
+ :return: The array index sort of an array sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getArrayIndexSort()
return sort
def getArrayElementSort(self):
+ """
+ :return: The array element sort of an array sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getArrayElementSort()
return sort
def getSetElementSort(self):
+ """
+ :return: The element sort of a set sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getSetElementSort()
return sort
def getBagElementSort(self):
+ """
+ :return: The element sort of a bag sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getBagElementSort()
return sort
def getSequenceElementSort(self):
+ """
+ :return: The element sort of a sequence sort.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.csort.getSequenceElementSort()
return sort
- def getUninterpretedSortName(self):
- return self.csort.getUninterpretedSortName().decode()
-
- def isUninterpretedSortParameterized(self):
- return self.csort.isUninterpretedSortParameterized()
-
- def getUninterpretedSortParamSorts(self):
- param_sorts = []
- for s in self.csort.getUninterpretedSortParamSorts():
- sort = Sort(self.solver)
- sort.csort = s
- param_sorts.append(sort)
- return param_sorts
-
- def getSortConstructorName(self):
- return self.csort.getSortConstructorName().decode()
-
- def getSortConstructorArity(self):
- return self.csort.getSortConstructorArity()
-
- def getBVSize(self):
- return self.csort.getBVSize()
-
- def getFPExponentSize(self):
- return self.csort.getFPExponentSize()
-
- def getFPSignificandSize(self):
- return self.csort.getFPSignificandSize()
-
- def getDatatypeParamSorts(self):
- param_sorts = []
- for s in self.csort.getDatatypeParamSorts():
- sort = Sort(self.solver)
- sort.csort = s
- param_sorts.append(sort)
- return param_sorts
+ def getUninterpretedSortConstructorArity(self):
+ """
+ :return: The arity of a sort constructor sort.
+ """
+ return self.csort.getUninterpretedSortConstructorArity()
+
+ def getBitVectorSize(self):
+ """
+ :return: The bit-width of the bit-vector sort.
+ """
+ return self.csort.getBitVectorSize()
+
+ def getFloatingPointExponentSize(self):
+ """
+ :return: The bit-width of the exponent of the floating-point sort.
+ """
+ return self.csort.getFloatingPointExponentSize()
+
+ def getFloatingPointSignificandSize(self):
+ """
+ :return: The width of the significand of the floating-point sort.
+ """
+ return self.csort.getFloatingPointSignificandSize()
def getDatatypeArity(self):
+ """
+ :return: The arity of a datatype sort.
+ """
return self.csort.getDatatypeArity()
def getTupleLength(self):
+ """
+ :return: The length of a tuple sort.
+ """
return self.csort.getTupleLength()
def getTupleSorts(self):
+ """
+ :return: The element sorts of a tuple sort.
+ """
tuple_sorts = []
for s in self.csort.getTupleSorts():
sort = Sort(self.solver)
return tuple_sorts
+cdef class Statistics:
+ """
+ The cvc5 Statistics.
+
+ Wrapper class for :cpp:class:`cvc5::Statistics`.
+ Obtain a single statistic value using ``stats["name"]`` and a dictionary
+ with all (visible) statistics using
+ ``stats.get(internal=False, defaulted=False)``.
+ """
+ cdef c_Statistics cstats
+
+ cdef __stat_to_dict(self, const c_Stat& s):
+ res = None
+ if s.isInt():
+ res = s.getInt()
+ elif s.isDouble():
+ res = s.getDouble()
+ elif s.isString():
+ res = s.getString().decode()
+ elif s.isHistogram():
+ res = { h.first.decode(): h.second for h in s.getHistogram() }
+ return {
+ 'defaulted': s.isDefault(),
+ 'internal': s.isInternal(),
+ 'value': res
+ }
+
+ def __getitem__(self, str name):
+ """
+ Get the statistics information for the statistic called ``name``.
+ """
+ return self.__stat_to_dict(self.cstats.get(name.encode()))
+
+ def get(self, bint internal = False, bint defaulted = False):
+ """
+ Get all statistics as a dictionary. See :cpp:func:`cvc5::Statistics::begin()`
+ for more information on which statistics are included based on the parameters.
+
+ :return: A dictionary with all available statistics.
+ """
+ cdef c_Statistics.iterator it = self.cstats.begin(internal, defaulted)
+ cdef pair[string,c_Stat]* s
+ res = {}
+ while it != self.cstats.end():
+ s = &dereference(it)
+ res[s.first.decode()] = self.__stat_to_dict(s.second)
+ preincrement(it)
+ return res
+
+
cdef class Term:
+ """
+ A cvc5 Term.
+
+ Wrapper class for :cpp:class:`cvc5::Term`.
+ """
cdef c_Term cterm
cdef Solver solver
def __cinit__(self, Solver solver):
return self.cterm >= other.cterm
def __getitem__(self, int index):
+ """
+ Get the child term at a given index.
+
+ :param index: The index of the child term to return.
+ :return: The child term with the given index.
+ """
cdef Term term = Term(self.solver)
if index >= 0:
term.cterm = self.cterm[index]
return self.cterm.toString().decode()
def __iter__(self):
+ """Iterate over all child terms."""
for ci in self.cterm:
term = Term(self.solver)
term.cterm = ci
return ctermhash(self.cterm)
def getNumChildren(self):
+ """
+ :return: The number of children of this term.
+ """
return self.cterm.getNumChildren()
def getId(self):
+ """
+ :return: The id of this term.
+ """
return self.cterm.getId()
def getKind(self):
- return kind(<int> self.cterm.getKind())
+ """
+ :return: The :py:class:`cvc5.Kind` of this term.
+ """
+ return Kind(<int> self.cterm.getKind())
def getSort(self):
+ """
+ :return: The :py:class:`cvc5.Sort` of this term.
+ """
cdef Sort sort = Sort(self.solver)
sort.csort = self.cterm.getSort()
return sort
def substitute(self, term_or_list_1, term_or_list_2):
+ """
+ :return: The result of simultaneously replacing the term(s) stored
+ in ``term_or_list_1`` by the term(s) stored in
+ ``term_or_list_2`` in this term.
+
+ .. note::
+
+ This replacement is applied during a pre-order traversal and
+ only once to the term. It is not run until fix point. In the
+ case that terms contains duplicates, the replacement earliest
+ in the list takes priority. For example, calling substitute on
+ ``f(x,y)`` with
+
+ .. code:: python
+
+ term_or_list_1 = [ x, z ], term_or_list_2 = [ g(z), w ]
+
+ results in the term ``f(g(z),y)``.
+ """
# The resulting term after substitution
cdef Term term = Term(self.solver)
# lists for substitutions
cdef vector[c_Term] ces
cdef vector[c_Term] creplacements
-
+
# normalize the input parameters to be lists
if isinstance(term_or_list_1, list):
assert isinstance(term_or_list_2, list)
# add the single elements to the vectors
ces.push_back((<Term?> term_or_list_1).cterm)
creplacements.push_back((<Term?> term_or_list_2).cterm)
-
+
# call the API substitute method with lists
term.cterm = self.cterm.substitute(ces, creplacements)
return term
def hasOp(self):
+ """
+ :return: True iff this term has an operator.
+ """
return self.cterm.hasOp()
def getOp(self):
+ """
+ :return: The :py:class:`cvc5.Op` used to create this Term.
+
+ .. note::
+
+ This is safe to call when :py:meth:`hasOp()` returns True.
+
+ """
cdef Op op = Op(self.solver)
op.cop = self.cterm.getOp()
return op
+ def hasSymbol(self):
+ """
+ :return: True iff this term has a symbol.
+ """
+ return self.cterm.hasSymbol()
+
+ def getSymbol(self):
+ """
+ Asserts :py:meth:`hasSymbol()`.
+
+ :return: The raw symbol of the term.
+ """
+ return self.cterm.getSymbol().decode()
+
def isNull(self):
+ """
+ :return: True iff this term is a null term.
+ """
return self.cterm.isNull()
def notTerm(self):
+ """
+ Boolean negation.
+
+ :return: The Boolean negation of this term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.notTerm()
return term
def andTerm(self, Term t):
+ """
+ Boolean and.
+
+ :param t: A Boolean term.
+ :return: The conjunction of this term and the given term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.andTerm((<Term> t).cterm)
return term
def orTerm(self, Term t):
+ """
+ Boolean or.
+
+ :param t: A Boolean term.
+ :return: The disjunction of this term and the given term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.orTerm(t.cterm)
return term
def xorTerm(self, Term t):
+ """
+ Boolean exclusive or.
+
+ :param t: A Boolean term.
+ :return: The exclusive disjunction of this term and the given term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.xorTerm(t.cterm)
return term
def eqTerm(self, Term t):
+ """
+ Equality
+
+ :param t: A Boolean term.
+ :return: The Boolean equivalence of this term and the given term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.eqTerm(t.cterm)
return term
def impTerm(self, Term t):
+ """
+ Boolean Implication.
+
+ :param t: A Boolean term.
+ :return: The implication of this term and the given term.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.impTerm(t.cterm)
return term
def iteTerm(self, Term then_t, Term else_t):
+ """
+ If-then-else with this term as the Boolean condition.
+
+ :param then_t: The `then` term.
+ :param else_t: The `else` term.
+ :return: The if-then-else term with this term as the Boolean
+ condition.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.iteTerm(then_t.cterm, else_t.cterm)
return term
def isConstArray(self):
+ """
+ :return: True iff this term is a constant array.
+ """
return self.cterm.isConstArray()
def getConstArrayBase(self):
+ """
+ Asserts :py:meth:`isConstArray()`.
+
+ :return: The base (element stored at all indicies) of this constant
+ array.
+ """
cdef Term term = Term(self.solver)
term.cterm = self.cterm.getConstArrayBase()
return term
def isBooleanValue(self):
+ """
+ :return: True iff this term is a Boolean value.
+ """
return self.cterm.isBooleanValue()
def getBooleanValue(self):
+ """
+ Asserts :py:meth:`isBooleanValue()`
+
+ :return: The representation of a Boolean value as a native Boolean
+ value.
+ """
return self.cterm.getBooleanValue()
def isStringValue(self):
+ """
+ :return: True iff this term is a string value.
+ """
return self.cterm.isStringValue()
def getStringValue(self):
+ """
+ Asserts :py:meth:`isStringValue()`.
+
+ .. note::
+ This method is not to be confused with :py:meth:`__str__()`
+ which returns the term in some string representation, whatever
+ data it may hold.
+
+ :return: The string term as a native string value.
+ """
cdef Py_ssize_t size
cdef c_wstring s = self.cterm.getStringValue()
return PyUnicode_FromWideChar(s.data(), s.size())
+ def getRealOrIntegerValueSign(self):
+ """
+ Get integer or real value sign. Must be called on integer or real
+ values, or otherwise an exception is thrown.
+
+ :return: 0 if this term is zero, -1 if this term is a negative real
+ or integer value, 1 if this term is a positive real or
+ integer value.
+ """
+ return self.cterm.getRealOrIntegerValueSign()
+
def isIntegerValue(self):
+ """
+ :return: True iff this term is an integer value.
+ """
return self.cterm.isIntegerValue()
- def isAbstractValue(self):
- return self.cterm.isAbstractValue()
- def getAbstractValue(self):
- return self.cterm.getAbstractValue().decode()
+ def getIntegerValue(self):
+ """
+ Asserts :py:meth:`isIntegerValue()`.
+
+ :return: The integer term as a native python integer.
+ """
+ return int(self.cterm.getIntegerValue().decode())
def isFloatingPointPosZero(self):
+ """
+ :return: True iff the term is the floating-point value for positive
+ zero.
+ """
return self.cterm.isFloatingPointPosZero()
-
+
def isFloatingPointNegZero(self):
+ """
+ :return: True iff the term is the floating-point value for negative
+ zero.
+ """
return self.cterm.isFloatingPointNegZero()
-
+
def isFloatingPointPosInf(self):
+ """
+ :return: True iff the term is the floating-point value for positive
+ infinity.
+ """
return self.cterm.isFloatingPointPosInf()
-
+
def isFloatingPointNegInf(self):
+ """
+ :return: True iff the term is the floating-point value for negative
+ infinity.
+ """
return self.cterm.isFloatingPointNegInf()
-
+
def isFloatingPointNaN(self):
+ """
+ :return: True iff the term is the floating-point value for not a
+ number.
+ """
return self.cterm.isFloatingPointNaN()
-
+
def isFloatingPointValue(self):
+ """
+ :return: True iff this term is a floating-point value.
+ """
return self.cterm.isFloatingPointValue()
def getFloatingPointValue(self):
- cdef c_tuple[uint32_t, uint32_t, c_Term] t = self.cterm.getFloatingPointValue()
+ """
+ Asserts :py:meth:`isFloatingPointValue()`.
+
+ :return: The representation of a floating-point value as a tuple of
+ the exponent width, the significand width and a bit-vector
+ value.
+ """
+ cdef c_tuple[uint32_t, uint32_t, c_Term] t = \
+ self.cterm.getFloatingPointValue()
cdef Term term = Term(self.solver)
term.cterm = get2(t)
return (get0(t), get1(t), term)
def isSetValue(self):
+ """
+ A term is a set value if it is considered to be a (canonical)
+ constant set value. A canonical set value is one whose AST is:
+
+ .. code:: smtlib
+
+ (set.union
+ (set.singleton c1) ...
+ (set.union (set.singleton c_{n-1}) (set.singleton c_n))))
+
+ where :math:`c_1 \dots c_n` are values ordered by id such that
+ :math:`c_1 > \cdots > c_n`.
+
+ .. note::
+ A universe set term ``(kind SET_UNIVERSE)`` is not considered
+ to be a set value.
+
+ :return: True if the term is a set value.
+ """
return self.cterm.isSetValue()
def getSetValue(self):
+ """
+ Asserts :py:meth:`isSetValue()`.
+
+ :return: The representation of a set value as a set of terms.
+ """
elems = set()
for e in self.cterm.getSetValue():
term = Term(self.solver)
return elems
def isSequenceValue(self):
+ """
+ :return: True iff this term is a sequence value.
+ """
return self.cterm.isSequenceValue()
def getSequenceValue(self):
+ """
+ Asserts :py:meth:`isSequenceValue()`.
+
+ .. note::
+
+ It is usually necessary for sequences to call
+ :py:meth:`Solver.simplify()` to turn a sequence that is
+ constructed by, e.g., concatenation of unit sequences, into a
+ sequence value.
+
+ :return: The representation of a sequence value as a vector of
+ terms.
+ """
elems = []
for e in self.cterm.getSequenceValue():
term = Term(self.solver)
elems.append(term)
return elems
- def isUninterpretedValue(self):
- return self.cterm.isUninterpretedValue()
-
- def getUninterpretedValue(self):
- cdef pair[c_Sort, int32_t] p = self.cterm.getUninterpretedValue()
+ def isCardinalityConstraint(self):
+ """
+ :return: True if the term is a cardinality constraint.
+
+ .. warning:: This method is experimental and may change in future
+ versions.
+ """
+ return self.cterm.isCardinalityConstraint()
+
+ def getCardinalityConstraint(self):
+ """
+ :return: The sort the cardinality constraint is for and its upper
+ bound.
+ .. warning:: This method is experimental and may change in future
+ versions.
+ """
+ cdef pair[c_Sort, uint32_t] p
+ p = self.cterm.getCardinalityConstraint()
cdef Sort sort = Sort(self.solver)
sort.csort = p.first
- i = p.second
- return (sort, i)
+ return (sort, p.second)
+
+
+ def isUninterpretedSortValue(self):
+ """
+ :return: True iff this term is a value from an uninterpreted sort.
+ """
+ return self.cterm.isUninterpretedSortValue()
+
+ def getUninterpretedSortValue(self):
+ """
+ Asserts :py:meth:`isUninterpretedSortValue()`.
+
+ :return: The representation of an uninterpreted value as a pair of
+ its sort and its index.
+ """
+ return self.cterm.getUninterpretedSortValue()
def isTupleValue(self):
+ """
+ :return: True iff this term is a tuple value.
+ """
return self.cterm.isTupleValue()
+ def isRoundingModeValue(self):
+ """
+ :return: True if the term is a floating-point rounding mode
+ value.
+ """
+ return self.cterm.isRoundingModeValue()
+
+ def getRoundingModeValue(self):
+ """
+ Asserts :py:meth:`isRoundingModeValue()`.
+ :return: The floating-point rounding mode value held by the term.
+ """
+ return RoundingMode(<int> self.cterm.getRoundingModeValue())
+
def getTupleValue(self):
+ """
+ Asserts :py:meth:`isTupleValue()`.
+
+ :return: The representation of a tuple value as a vector of terms.
+ """
elems = []
for e in self.cterm.getTupleValue():
term = Term(self.solver)
elems.append(term)
return elems
- def getIntegerValue(self):
- return int(self.cterm.getIntegerValue().decode())
-
def isRealValue(self):
+ """
+ :return: True iff this term is a rational value.
+
+ .. note::
+
+ A term of kind :py:obj:`Pi <cvc5.Kind.Pi>` is not considered
+ to be a real value.
+
+ """
return self.cterm.isRealValue()
def getRealValue(self):
- '''Returns the value of a real term as a Fraction'''
+ """
+ Asserts :py:meth:`isRealValue()`.
+
+ :return: The representation of a rational value as a python Fraction.
+ """
return Fraction(self.cterm.getRealValue().decode())
def isBitVectorValue(self):
+ """
+ :return: True iff this term is a bit-vector value.
+ """
return self.cterm.isBitVectorValue()
def getBitVectorValue(self, base = 2):
- '''Returns the value of a bit-vector term as a 0/1 string'''
+ """
+ Asserts :py:meth:`isBitVectorValue()`.
+ Supported bases are 2 (bit string), 10 (decimal string) or 16
+ (hexdecimal string).
+
+ :return: The representation of a bit-vector value in string
+ representation.
+ """
return self.cterm.getBitVectorValue(base).decode()
def toPythonObj(self):
- '''
- Converts a constant value Term to a Python object.
-
- Currently supports:
- Boolean -- returns a Python bool
- Int -- returns a Python int
- Real -- returns a Python Fraction
- BV -- returns a Python int (treats BV as unsigned)
- String -- returns a Python Unicode string
- Array -- returns a Python dict mapping indices to values
- -- the constant base is returned as the default value
- '''
+ """
+ Converts a constant value Term to a Python object.
+
+ Currently supports:
+
+ - **Boolean:** Returns a Python bool
+ - **Int :** Returns a Python int
+ - **Real :** Returns a Python Fraction
+ - **BV :** Returns a Python int (treats BV as unsigned)
+ - **String :** Returns a Python Unicode string
+ - **Array :** Returns a Python dict mapping indices to values. The constant base is returned as the default value.
+
+ """
if self.isBooleanValue():
return self.getBooleanValue()
# on a constant array
while to_visit:
t = to_visit.pop()
- if t.getKind() == kinds.Store:
+ if t.getKind().value == c_Kind.STORE:
# save the mappings
keys.append(t[1].toPythonObj())
values.append(t[2].toPythonObj())
to_visit.append(t[0])
else:
- assert t.getKind() == kinds.ConstArray
+ assert t.getKind().value == c_Kind.CONST_ARRAY
base_value = t.getConstArrayBase().toPythonObj()
assert len(keys) == len(values)
return res
-# Generate rounding modes
-cdef __rounding_modes = {
- <int> ROUND_NEAREST_TIES_TO_EVEN: "RoundNearestTiesToEven",
- <int> ROUND_TOWARD_POSITIVE: "RoundTowardPositive",
- <int> ROUND_TOWARD_NEGATIVE: "RoundTowardNegative",
- <int> ROUND_TOWARD_ZERO: "RoundTowardZero",
- <int> ROUND_NEAREST_TIES_TO_AWAY: "RoundNearestTiesToAway"
-}
-
-mod_ref = sys.modules[__name__]
-for rm_int, name in __rounding_modes.items():
- r = RoundingMode(rm_int)
-
- if name in dir(mod_ref):
- raise RuntimeError("Redefinition of Python RoundingMode %s."%name)
-
- setattr(mod_ref, name, r)
-
-del r
-del rm_int
-del name
projects / cvc5.git / blobdiff