From: Aina Niemetz Date: Tue, 5 Apr 2022 04:08:36 +0000 (-0700) Subject: api: More fixes in the java API. (#8571) X-Git-Tag: cvc5-1.0.0~6 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5b9485d6f2da4834c329793b28e4a63ed4c39829;p=cvc5.git api: More fixes in the java API. (#8571) --- diff --git a/src/api/cpp/cvc5.h b/src/api/cpp/cvc5.h index 460ee2179..25313d960 100644 --- a/src/api/cpp/cvc5.h +++ b/src/api/cpp/cvc5.h @@ -3698,7 +3698,7 @@ class CVC5_EXPORT Solver Term mkConstArray(const Sort& sort, const Term& val) const; /** - * Create a positive infinity floating-point constant. + * Create a positive infinity floating-point constant (SMT-LIB: `+oo`). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -3706,7 +3706,7 @@ class CVC5_EXPORT Solver Term mkFloatingPointPosInf(uint32_t exp, uint32_t sig) const; /** - * Create a negative infinity floating-point constant. + * Create a negative infinity floating-point constant (SMT-LIB: `-oo`). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -3714,7 +3714,7 @@ class CVC5_EXPORT Solver Term mkFloatingPointNegInf(uint32_t exp, uint32_t sig) const; /** - * Create a not-a-number (NaN) floating-point constant. + * Create a not-a-number floating-point constant (SMT-LIB: `NaN`). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -3722,7 +3722,7 @@ class CVC5_EXPORT Solver Term mkFloatingPointNaN(uint32_t exp, uint32_t sig) const; /** - * Create a positive zero (+0.0) floating-point constant. + * Create a positive zero floating-point constant (SMT-LIB: +zero). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -3730,7 +3730,7 @@ class CVC5_EXPORT Solver Term mkFloatingPointPosZero(uint32_t exp, uint32_t sig) const; /** - * Create a negative zero (-0.0) floating-point constant. + * Create a negative zero floating-point constant (SMT-LIB: -zero). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -3738,7 +3738,7 @@ class CVC5_EXPORT Solver Term mkFloatingPointNegZero(uint32_t exp, uint32_t sig) const; /** - * Create a roundingmode constant. + * Create a rounding mode constant. * @param rm The floating point rounding mode this constant represents. */ Term mkRoundingMode(RoundingMode rm) const; @@ -4036,7 +4036,8 @@ class CVC5_EXPORT Solver * (define-fun-rec ) * \endverbatim * - * Create parameter 'fun' with mkConst(). + * Create parameter `fun` with mkConst(). + * * @param fun The sorted function. * @param bound_vars The parameters to this function. * @param term The function body. diff --git a/src/api/java/io/github/cvc5/Op.java b/src/api/java/io/github/cvc5/Op.java index d5a123bfc..393ed5ccf 100644 --- a/src/api/java/io/github/cvc5/Op.java +++ b/src/api/java/io/github/cvc5/Op.java @@ -43,7 +43,7 @@ public class Op extends AbstractPointer * Syntactic equality operator. * @api.note Both operators must belong to the same solver object. * @param t The operator to compare to for equality. - * @return True If the operators are syntactically identical. + * @return True if the operators are syntactically identical. */ @Override public boolean equals(Object t) @@ -58,7 +58,7 @@ public class Op extends AbstractPointer private native boolean equals(long pointer1, long pointer2); /** - * @return The Kind of this operator. + * @return The kind of this operator. */ public Kind getKind() { @@ -77,7 +77,7 @@ public class Op extends AbstractPointer private native int getKind(long pointer); /** - * @return True If this operator is a null term. + * @return True if this operator is a null term. */ public boolean isNull() { @@ -87,7 +87,7 @@ public class Op extends AbstractPointer private native boolean isNull(long pointer); /** - * @return True Iff this operator is indexed. + * @return True iff this operator is indexed. */ public boolean isIndexed() { @@ -97,7 +97,7 @@ public class Op extends AbstractPointer private native boolean isIndexed(long pointer); /** - * @return The Number of indices of this op. + * @return The number of indices of this op. */ public int getNumIndices() { @@ -109,7 +109,7 @@ public class Op extends AbstractPointer /** * Get the index at position {@code i}. * @param i The position of the index to return. - * @return The Index at position i. + * @return The index at position {@code i}. */ public Term get(int i) throws CVC5ApiException { @@ -121,7 +121,7 @@ public class Op extends AbstractPointer private native long get(long pointer, int i); /** - * @return A String representation of this operator. + * @return A string representation of this operator. */ protected native String toString(long pointer); } diff --git a/src/api/java/io/github/cvc5/OptionInfo.java b/src/api/java/io/github/cvc5/OptionInfo.java index 974d0bcca..44d55f13d 100644 --- a/src/api/java/io/github/cvc5/OptionInfo.java +++ b/src/api/java/io/github/cvc5/OptionInfo.java @@ -74,7 +74,7 @@ public class OptionInfo extends AbstractPointer } /** - * @return a String representation of this optionInfo. + * @return A string representation of this OptionInfo. */ protected native String toString(long pointer); diff --git a/src/api/java/io/github/cvc5/Result.java b/src/api/java/io/github/cvc5/Result.java index e66f07d46..88b6b5257 100644 --- a/src/api/java/io/github/cvc5/Result.java +++ b/src/api/java/io/github/cvc5/Result.java @@ -39,7 +39,7 @@ public class Result extends AbstractPointer // endregion /** - * @return true if Result is empty, i.e., a nullary Result, and not an actual + * @return True if Result is empty, i.e., a nullary Result, and not an actual * result returned from a checkSat() (and friends) query. */ public boolean isNull() @@ -50,7 +50,7 @@ public class Result extends AbstractPointer private native boolean isNull(long pointer); /** - * @return true if query was a satisfiable checkSat() or checkSatAssuming() + * @return True if query was a satisfiable checkSat() or checkSatAssuming() * query. */ public boolean isSat() @@ -61,7 +61,7 @@ public class Result extends AbstractPointer private native boolean isSat(long pointer); /** - * @return true if query was an unsatisfiable checkSat() or + * @return True if query was an unsatisfiable checkSat() or * checkSatAssuming() query. */ public boolean isUnsat() @@ -72,7 +72,7 @@ public class Result extends AbstractPointer private native boolean isUnsat(long pointer); /** - * @return true if query was a checkSat() or checkSatAssuming() query and + * @return True if query was a checkSat() or checkSatAssuming() query and * cvc5 was not able to determine (un)satisfiability. */ public boolean isUnknown() @@ -85,7 +85,7 @@ public class Result extends AbstractPointer /** * Operator overloading for equality of two results. * @param r the result to compare to for equality - * @return true if the results are equal + * @return True if the results are equal */ @Override public boolean equals(Object r) @@ -105,7 +105,7 @@ public class Result extends AbstractPointer private native boolean equals(long pointer1, long pointer2); /** - * @return an explanation for an unknown query result. + * @return An explanation for an unknown query result. */ public UnknownExplanation getUnknownExplanation() { @@ -124,7 +124,7 @@ public class Result extends AbstractPointer private native int getUnknownExplanation(long pointer); /** - * @return a string representation of this result. + * @return A string representation of this result. */ protected native String toString(long pointer); } diff --git a/src/api/java/io/github/cvc5/Solver.java b/src/api/java/io/github/cvc5/Solver.java index 41b50c4e7..a489062cc 100644 --- a/src/api/java/io/github/cvc5/Solver.java +++ b/src/api/java/io/github/cvc5/Solver.java @@ -106,7 +106,7 @@ public class Solver implements IPointer, AutoCloseable private native long getBooleanSort(long pointer); /** - * @return Sort Integer (in cvc5, Integer is a subtype of Real). + * @return Sort Integer. */ public Sort getIntegerSort() { @@ -651,7 +651,7 @@ public class Solver implements IPointer, AutoCloseable /** * Create an operator for a builtin Kind * The Kind may not be the Kind for an indexed operator - * (e.g. BITVECTOR_EXTRACT). + * (e.g. {@link Kind#BITVECTOR_EXTRACT}). * * @api.note In this case, the Op simply wraps the Kind. The Kind can be used * in mkTerm directly without creating an op first. @@ -667,8 +667,11 @@ public class Solver implements IPointer, AutoCloseable private native long mkOp(long pointer, int kindValue); /** * Create operator of kind: - * - RECORD_UPDATE - * - DIVISIBLE (to support arbitrary precision integers) + * * See enum {@link Kind} for a description of the parameters. * @param kind The kind of the operator. * @param arg The string argument to this operator. @@ -683,18 +686,20 @@ public class Solver implements IPointer, AutoCloseable /** * Create operator of kind: - * - DIVISIBLE - * - BITVECTOR_REPEAT - * - BITVECTOR_ZERO_EXTEND - * - BITVECTOR_SIGN_EXTEND - * - BITVECTOR_ROTATE_LEFT - * - BITVECTOR_ROTATE_RIGHT - * - INT_TO_BITVECTOR - * - FLOATINGPOINT_TO_UBV - * - FLOATINGPOINT_TO_UBV_TOTAL - * - FLOATINGPOINT_TO_SBV - * - FLOATINGPOINT_TO_SBV_TOTAL - * - TUPLE_UPDATE + * * See enum {@link Kind} for a description of the parameters. * @param kind The kind of the operator. * @param arg The unsigned int argument to this operator. @@ -711,12 +716,14 @@ public class Solver implements IPointer, AutoCloseable /** * Create operator of Kind: - * - BITVECTOR_EXTRACT - * - FLOATINGPOINT_TO_FP_FROM_IEEE_BV - * - FLOATINGPOINT_TO_FP_FROM_FP - * - FLOATINGPOINT_TO_FP_FROM_REAL - * - FLOATINGPOINT_TO_FP_FROM_SBV - * - FLOATINGPOINT_TO_FP_FROM_UBV + * * See enum {@link Kind} for a description of the parameters. * @param kind The kind of the operator. * @param arg1 The first unsigned int argument to this operator. @@ -735,7 +742,9 @@ public class Solver implements IPointer, AutoCloseable /** * Create operator of Kind: - * - TUPLE_PROJECT + * * See enum {@link Kind} for a description of the parameters. * @param kind The kind of the operator. * @param args The arguments (indices) of the operator. @@ -755,7 +764,7 @@ public class Solver implements IPointer, AutoCloseable /* .................................................................... */ /** - * Create a Boolean true constant. + * Create a Boolean {@code true} constant. * @return The true constant. */ public Term mkTrue() @@ -766,7 +775,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkTrue(long pointer); /** - * Create a Boolean false constant. + * Create a Boolean {@code false} constant. * @return The false constant. */ public Term mkFalse() @@ -803,7 +812,8 @@ public class Solver implements IPointer, AutoCloseable * Create an integer constant from a string. * @param s The string representation of the constant, may represent an. * integer (e.g., "123"). - * @return A constant of sort Integer assuming 's' represents an integer) + * @return A constant of sort Integer assuming {@code s} represents an + * integer). * @throws CVC5ApiException */ public Term mkInteger(String s) throws CVC5ApiException @@ -815,7 +825,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkInteger(long pointer, String s) throws CVC5ApiException; /** - * Create an integer constant from a c++ int. + * Create an integer constant from a C++ {@code int}. * @param val The value of the constant. * @return A constant of sort Integer. */ @@ -868,7 +878,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkReal(long pointer, long num, long den); /** - * Create a regular expression none (re.none) term. + * Create a regular expression none ({@code re.none}) term. * @return The none term. */ public Term mkRegexpNone() @@ -880,7 +890,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkRegexpNone(long pointer); /** - * Create a regular expression all (re.all) term. + * Create a regular expression all ({@code re.all}) term. * @return The all term. */ public Term mkRegexpAll() @@ -892,7 +902,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkRegexpAll(long pointer); /** - * Create a regular expression allchar (re.allchar) term. + * Create a regular expression allchar ({@code re.allchar}) term. * @return The allchar term. */ public Term mkRegexpAllchar() @@ -972,8 +982,9 @@ public class Solver implements IPointer, AutoCloseable /** * Create a String constant. * @param s The string this constant represents. - * @param useEscSequences Determines whether escape sequences in `s` - * should be converted to the corresponding unicode character + * @param useEscSequences Determines whether escape sequences in {@code s} + * should be converted to the corresponding unicode + * character. * @return The String constant. */ public Term mkString(String s, boolean useEscSequences) @@ -987,9 +998,8 @@ public class Solver implements IPointer, AutoCloseable /** * Create a String constant. - * @param s A list of unsigned (unicode) values this constant represents. - * as - * string + * @param s A list of unsigned (unicode) values this constant represents + * as string. * @return The String constant. * @throws CVC5ApiException */ @@ -1084,8 +1094,8 @@ public class Solver implements IPointer, AutoCloseable * 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) + * @param val The constant value to store (must match the sort's element + * sort). * @return The constant array term. */ public Term mkConstArray(Sort sort, Term val) @@ -1096,7 +1106,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkConstArray(long pointer, long sortPointer, long valPointer); /** - * Create a positive infinity floating-point constant. + * Create a positive infinity floating-point constant (SMT-LIB: {@code +oo}). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -1112,7 +1122,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkFloatingPointPosInf(long pointer, int exp, int sig); /** - * Create a negative infinity floating-point constant. + * Create a negative infinity floating-point constant (SMT-LIB: {@code -oo}). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -1128,7 +1138,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkFloatingPointNegInf(long pointer, int exp, int sig); /** - * Create a not-a-number (NaN) floating-point constant. + * Create a not-a-number floating-point constant (SMT-LIB: {@code NaN}). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -1145,7 +1155,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkFloatingPointNaN(long pointer, int exp, int sig); /** - * Create a positive zero (+0.0) floating-point constant. + * Create a positive zero floating-point constant (SMT-LIB: {@code +zero}). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -1162,7 +1172,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkFloatingPointPosZero(long pointer, int exp, int sig); /** - * Create a negative zero (-0.0) floating-point constant. + * Create a negative zero floating-point constant (SMT-LIB: {@code -zero}). * @param exp Number of bits in the exponent. * @param sig Number of bits in the significand. * @return The floating-point constant. @@ -1179,7 +1189,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkFloatingPointNegZero(long pointer, int exp, int sig); /** - * Create a roundingmode constant. + * Create a rounding mode constant. * @param rm The floating point rounding mode this constant represents. */ public Term mkRoundingMode(RoundingMode rm) @@ -1231,7 +1241,8 @@ public class Solver implements IPointer, AutoCloseable /* .................................................................... */ /** - * Create (first-order) constant (0-arity function symbol). + * Create a free constant. + * * SMT-LIB: * {@code * ( declare-const ) @@ -1251,8 +1262,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkConst(long pointer, long sortPointer, String symbol); /** - * Create (first-order) constant (0-arity function symbol), with a default - * symbol name. + * Create a free constant with a default symbol name. * * @param sort The sort of the constant. * @return The first-order constant. @@ -1266,7 +1276,7 @@ public class Solver implements IPointer, AutoCloseable private native long mkConst(long pointer, long sortPointer); /** - * Create a bound variable to be used in a binder (i.e. a quantifier, a + * 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. * @return The variable. @@ -1277,7 +1287,7 @@ public class Solver implements IPointer, AutoCloseable } /** - * Create a bound variable to be used in a binder (i.e. a quantifier, a + * 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. @@ -1338,7 +1348,8 @@ public class Solver implements IPointer, AutoCloseable /** * Create a datatype declaration. - * Create sorts parameter with Solver::mkParamSort(). + * + * Create sorts parameter with {@link Solver#mkParamSort(String)}. * * @api.note This method is experimental and may change in future versions. * @@ -1353,7 +1364,9 @@ public class Solver implements IPointer, AutoCloseable /** * Create a datatype declaration. - * Create sorts parameter with Solver::mkParamSort(). + * + * Create sorts parameter with {@link Solver#mkParamSort(String)}. + * * @param name The name of the datatype. * @param params A list of sort parameters. * @param isCoDatatype True if a codatatype is to be constructed. @@ -1374,10 +1387,11 @@ public class Solver implements IPointer, AutoCloseable /* .................................................................... */ /** - * 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. + * 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. * * @api.note This method is experimental and may change in future versions. * @@ -1409,10 +1423,12 @@ public class Solver implements IPointer, AutoCloseable /** * Check satisfiability. + * * SMT-LIB: * {@code * ( check-sat ) * } + * * @return The result of the satisfiability check. */ public Result checkSat() @@ -1424,10 +1440,12 @@ public class Solver implements IPointer, AutoCloseable private native long checkSat(long pointer); /** * Check satisfiability assuming the given formula. + * * SMT-LIB: * {@code * ( check-sat-assuming ( ) ) * } + * * @param assumption The formula to assume. * @return The result of the satisfiability check. */ @@ -1441,10 +1459,12 @@ public class Solver implements IPointer, AutoCloseable /** * Check satisfiability assuming the given formulas. + * * SMT-LIB: * {@code * ( check-sat-assuming ( + ) ) * } + * * @param assumptions The formulas to assume. * @return The result of the satisfiability check. */ @@ -1459,10 +1479,12 @@ public class Solver implements IPointer, AutoCloseable /** * Create datatype sort. + * * SMT-LIB: * {@code * ( declare-datatype ) * } + * * @param symbol The name of the datatype sort. * @param ctors The constructor declarations of the datatype sort. * @return The datatype sort. @@ -1478,10 +1500,12 @@ public class Solver implements IPointer, AutoCloseable /** * Declare n-ary function symbol. + * * SMT-LIB: * {@code * ( declare-fun ( * ) ) * } + * * @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. @@ -1499,13 +1523,14 @@ public class Solver implements IPointer, AutoCloseable /** * Declare uninterpreted sort. + * * SMT-LIB: * {@code * ( declare-sort ) * } * * @api.note This corresponds to mkUninterpretedSort() const if arity = 0, and - * to mkUninterpretedSortConstructorSort() const if arity > 0. + * to mkUninterpretedSortConstructorSort() const if arity > 0. * * @param symbol The name of the sort. * @param arity The arity of the sort. @@ -1523,10 +1548,12 @@ public class Solver implements IPointer, AutoCloseable /** * Define n-ary function in the current context. + * * SMT-LIB: * {@code * ( define-fun ) * } + * * @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. @@ -1540,10 +1567,12 @@ public class Solver implements IPointer, AutoCloseable /** * Define n-ary function. + * * SMT-LIB: * {@code * ( define-fun ) * } + * * @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. @@ -1569,10 +1598,12 @@ public class Solver implements IPointer, AutoCloseable /** * Define recursive function in the current context. + * * SMT-LIB: * {@code * ( define-fun-rec ) * } + * * @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. @@ -1586,10 +1617,12 @@ public class Solver implements IPointer, AutoCloseable /** * Define recursive function. + * * SMT-LIB: * {@code * ( define-fun-rec ) * } + * * @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. @@ -1615,11 +1648,14 @@ public class Solver implements IPointer, AutoCloseable /** * Define recursive function in the current context. + * * SMT-LIB: * {@code * ( define-fun-rec ) * } - * Create parameter 'fun' with mkConst(). + * + * Create parameter {@code fun} with {@link Solver#mkConst(Sort)}. + * * @param fun The sorted function. * @param boundVars The parameters to this function. * @param term The function body. @@ -1633,11 +1669,14 @@ public class Solver implements IPointer, AutoCloseable /** * Define recursive function. + * * SMT-LIB: * {@code * ( define-fun-rec ) * } - * Create parameter 'fun' with mkConst(). + * + * Create parameter {@code fun} with {@link Solver#mkConst(Sort)}. + * * @param fun The sorted function. * @param boundVars The parameters to this function. * @param term The function body. @@ -1658,11 +1697,15 @@ public class Solver implements IPointer, AutoCloseable /** * Define recursive functions in the current context. + * * SMT-LIB: * {@code * ( define-funs-rec ( ^{n+1} ) ( ^{n+1} ) ) * } - * Create elements of parameter 'funs' with mkConst(). + * + * Create elements of parameter {@code funs} with + * {@link Solver#mkConst(Sort)}. + * * @param funs The sorted functions. * @param boundVars The list of parameters to the functions. * @param terms The list of function bodies of the functions. @@ -1673,11 +1716,15 @@ public class Solver implements IPointer, AutoCloseable } /** * Define recursive functions. + * * SMT-LIB: * {@code * ( define-funs-rec ( ^{n+1} ) ( ^{n+1} ) ) * } - * Create elements of parameter 'funs' with mkConst(). + * + * Create elements of parameter {@code funs} with + * {@link Solver#mkConst(Sort)}. + * * @param funs The sorted functions. * @param boundVars The list of parameters to the functions. * @param terms The list of function bodies of the functions. @@ -1699,7 +1746,8 @@ public class Solver implements IPointer, AutoCloseable boolean global); /** - * Get a list of literals that are entailed by the current set of assertions + * Get a list of literals that are entailed by the current set of assertions. + * * SMT-LIB: * {@code * ( get-learned-literals ) @@ -1719,10 +1767,12 @@ public class Solver implements IPointer, AutoCloseable /** * Get the list of asserted formulas. + * * SMT-LIB: * {@code * ( get-assertions ) * } + * * @return The list of asserted formulas. */ public Term[] getAssertions() @@ -1762,8 +1812,10 @@ public class Solver implements IPointer, AutoCloseable private native String getOption(long pointer, String option); /** - * Get all option names that can be used with `setOption`, `getOption` and - * `getOptionInfo`. + * Get all option names that can be used with + * {@link Solver#setOption(String, String)}, + * {@link Solver#getOption(String)} and + * {@link Solver#getOptionInfo(String)}. * @return All option names. */ public String[] getOptionNames() @@ -1774,8 +1826,11 @@ public class Solver implements IPointer, AutoCloseable private native String[] getOptionNames(long pointer); /** - * Get some information about the given option. Check the `OptionInfo` class - * for more details on which information is available. + * Get some information about the given option. + * + * Check the {@link OptionInfo} class for more details on which information + * is available. + * * @return Information about the given option. */ public OptionInfo getOptionInfo(String option) @@ -1788,11 +1843,14 @@ public class Solver implements IPointer, AutoCloseable /** * Get the set of unsat ("failed") assumptions. + * * SMT-LIB: * {@code * ( get-unsat-assumptions ) * } - * Requires to enable option 'produce-unsat-assumptions'. + * + * Requires to enable option {@code produce-unsat-assumptions}. + * * @return The set of unsat assumptions. */ public Term[] getUnsatAssumptions() @@ -1809,9 +1867,9 @@ public class Solver implements IPointer, AutoCloseable * {@code * (get-unsat-core) * } - * Requires to enable option 'produce-unsat-cores'. + * Requires to enable option {@code produce-unsat-cores}. * - * @api.note In contrast to SMT-LIB, the API does not distinguish between + * @api.note In contrast to SMT-LIB, cvc5's 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 @@ -1854,11 +1912,13 @@ public class Solver implements IPointer, AutoCloseable /** * Get the refutation proof + * * SMT-LIB: * {@code * ( get-proof ) * } - * Requires to enable option 'produce-proofs'. + * + * Requires to enable option {@code produce-proofs}. * * @api.note This method is experimental and may change in future versions. * @@ -1874,10 +1934,12 @@ public class Solver implements IPointer, AutoCloseable /** * Get the value of the given term in the current model. + * * SMT-LIB: * {@code * ( get-value ( ) ) * } + * * @param term The term for which the value is queried. * @return The value of the given term. */ @@ -1891,10 +1953,12 @@ public class Solver implements IPointer, AutoCloseable /** * Get the values of the given terms in the current model. + * * SMT-LIB: * {@code * ( get-value ( + ) ) * } + * * @param terms The terms for which the value is queried. * @return The values of the given terms. */ @@ -1908,12 +1972,13 @@ public class Solver implements IPointer, AutoCloseable private native long[] getValue(long pointer, long[] termPointers); /** - * 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. + * Get the domain elements of uninterpreted sort s in the current model. + * + * The current model interprets {@code 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. + * @return The domain elements of {@code s} in the current model. */ public Term[] getModelDomainElements(Sort s) { @@ -1924,10 +1989,11 @@ public class Solver implements IPointer, AutoCloseable private native long[] getModelDomainElements(long pointer, long sortPointer); /** - * 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. + * This returns false if the model value of free constant {@code v} was not + * essential for showing the satisfiability of the last call to + * {@link Solver#checkSat()} using the current model. This method will only + * return false (for any {@code v}) if the option {@code model-cores} has + * been set. * * @api.note This method is experimental and may change in future versions. * @@ -1943,11 +2009,13 @@ public class Solver implements IPointer, AutoCloseable /** * Get the model + * * SMT-LIB: * {@code * ( get-model ) * } - * Requires to enable option 'produce-models'. + * + * Requires to enable option {@code produce-models}. * * @api.note This method is experimental and may change in future versions. * @@ -2090,6 +2158,7 @@ public class Solver implements IPointer, AutoCloseable /** * Declare a symbolic pool of terms with the given initial value. + * * SMT-LIB: * {@code * ( declare-pool ( * ) ) @@ -2113,10 +2182,12 @@ public class Solver implements IPointer, AutoCloseable /** * Pop a level from the assertion stack. + * * SMT-LIB: * {@code * ( pop ) * } + * * @throws CVC5ApiException */ public void pop() throws CVC5ApiException @@ -2126,10 +2197,12 @@ public class Solver implements IPointer, AutoCloseable /** * Pop (a) level(s) from the assertion stack. + * * SMT-LIB: * {@code * ( pop ) * } + * * @param nscopes The number of levels to pop. * @throws CVC5ApiException */ @@ -2143,18 +2216,22 @@ public class Solver implements IPointer, AutoCloseable /** * Get an interpolant + * * SMT-LIB: * {@code * ( get-interpolant ) * } - * Requires 'produce-interpolants' to be set to a mode different from 'none'. + * + * Requires option {@code produce-interpolants} to be set to a mode different + * from {@code none}. * * @api.note This method is experimental and may change in future versions. * * @param conj The conjecture term. - * @return A Term I such that {@code A->I} and {@code I->B} are valid, where. - * A is the current set of assertions and B is given in the input by - * conj, or the null term if such a term cannot be found. + * @return A Term I such that {@code A->I} and {@code I->B} are valid, where + * {@code A} is the current set of assertions and {@code B} is given + * in the input by {@code conj}, or the null term if such a term + * cannot be found. */ public Term getInterpolant(Term conj) { @@ -2166,19 +2243,23 @@ public class Solver implements IPointer, AutoCloseable /** * Get an interpolant + * * SMT-LIB: * {@code * ( get-interpolant ) * } - * Requires 'produce-interpolants' to be set to a mode different from 'none'. + * + * Requires option {@code produce-interpolants} to be set to a mode different + * from {@code none}. * * @api.note This method is experimental and may change in future versions. * * @param conj The conjecture term. * @param grammar The grammar for the interpolant I. - * @return A Term I such that {@code A->I} and {@code I->B} are valid, where. - * A is the current set of assertions and B is given in the input by - * conj, or the null term if such a term cannot be found. + * @return A Term I such that {@code A->I} and {@code I->B} are valid, where + * {@code A} is the current set of assertions and {@code B} is given + * in the input by {@code conj}, or the null term if such a term + * cannot be found. */ public Term getInterpolant(Term conj, Grammar grammar) { @@ -2189,28 +2270,28 @@ public class Solver implements IPointer, AutoCloseable private native long getInterpolant(long pointer, long conjPointer, long grammarPointer); /** - * Get the next interpolant. Can only be called immediately after a successful - * call to get-interpolant or get-interpolant-next. Is guaranteed to produce a - * syntactically different interpolant wrt the last returned interpolant if - * successful. - * - * SMT-LIB: + * Get the next interpolant. * - * \verbatim embed:rst:leading-asterisk - * .. code:: smtlib + * Can only be called immediately after a successful call to + * {@code get-interpolant} or {@code get-interpolant-next}. Is guaranteed to + * produce a syntactically different interpolant wrt the last returned + * interpolant if successful. * + * SMT-LIB: + * {@code * (get-interpolant-next) + * } * - * Requires to enable incremental mode, and option 'produce-interpolants' to be - * set to a mode different from 'none'. - * \endverbatim + * Requires to enable incremental mode, and option + * {@code produce-interpolants} to be set to a mode different from + * {@code none}. * * @api.note This method is experimental and may change in future versions. * * @return A Term I such that {@code A->I} and {@code I->B} are valid, - * where A is the current set of assertions and B is given in the input - * by conj on the last call to getInterpolant, or the null term if such - * a term cannot be found. + * where {@code A} is the current set of assertions and {@code B} + * is given in the input by conj on the last call to getInterpolant, + * or the null term if such a term cannot be found. */ public Term getInterpolantNext() { @@ -2222,19 +2303,20 @@ public class Solver implements IPointer, AutoCloseable /** * Get an abduct. + * * SMT-LIB: * {@code * ( get-abduct ) * } - * Requires enabling option 'produce-abducts' + * Requires enabling option {@code produce-abducts}. * * @api.note This method is experimental and may change in future versions. * * @param conj The conjecture term. - * @return A term C such that A^C is satisfiable, and A^~B^C is. - * unsatisfiable, where A is the current set of assertions and B is - * given in the input by conj, or the null term if such a term cannot - * be found. + * @return A term {@code C} such that {@code A && C} is satisfiable, and + * {@code A && ~B && C} is unsatisfiable, where {@code A} is the + * current set of assertions and {@code B} is given in the input by + * {@code conj}, or the null term if such a term cannot be found. */ public Term getAbduct(Term conj) { @@ -2245,20 +2327,22 @@ public class Solver implements IPointer, AutoCloseable private native long getAbduct(long pointer, long conjPointer); /** * Get an abduct. + * * SMT-LIB: * {@code * ( get-abduct ) * } - * Requires enabling option 'produce-abducts' + * + * Requires enabling option {@code produce-abducts}. * * @api.note This method is experimental and may change in future versions. * * @param conj The conjecture term. - * @param grammar The grammar for the abduct C. - * @return A term C such that A^C is satisfiable, and A^~B^C is - * unsatisfiable, where A is the current set of assertions and B is - * given in the input by conj, or the null term if such a term cannot - * be found. + * @param grammar The grammar for the abduct {@code C}. + * @return A term {@code C} such that {@code A && C} is satisfiable, and + * {@code A && ~B && C} is unsatisfiable, where {@code A} is the + * current set of assertions and {@code B} is given in the input by + * {@code conj}, or the null term if such a term cannot be found. */ public Term getAbduct(Term conj, Grammar grammar) { @@ -2276,7 +2360,7 @@ public class Solver implements IPointer, AutoCloseable * {@code * ( get-abduct-next ) * } - * Requires enabling incremental mode and option 'produce-abducts' + * Requires enabling incremental mode and option {@code produce-abducts}. * * @api.note This method is experimental and may change in future versions. * @@ -2294,14 +2378,16 @@ public class Solver implements IPointer, AutoCloseable private native long getAbductNext(long pointer); /** - * Block the current model. Can be called only if immediately preceded by a - * SAT or INVALID query. + * Block the current model. + * + * Can be called only if immediately preceded by a SAT or INVALID query. + * * SMT-LIB: * {@code * ( block-model ) * } - * Requires enabling 'produce-models' option and setting 'block-models' option - * to a mode other than "none". + * + * Requires enabling option {@code produce-models}. * * @api.note This method is experimental and may change in future versions. * @@ -2315,13 +2401,16 @@ public class Solver implements IPointer, AutoCloseable private native void blockModel(long pointer, int modeValue); /** - * 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. + * 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-model-values ( + ) ) * } - * Requires enabling 'produce-models' option. + * + * Requires enabling option {@code produce-models}. * * @api.note This method is experimental and may change in future versions. */ @@ -2348,10 +2437,12 @@ public class Solver implements IPointer, AutoCloseable /** * Push a level to the assertion stack. + * * SMT-LIB: * {@code * ( push ) * } + * * @throws CVC5ApiException */ public void push() throws CVC5ApiException @@ -2361,10 +2452,12 @@ public class Solver implements IPointer, AutoCloseable /** * Push (a) level(s) to the assertion stack. + * * SMT-LIB: * {@code * ( push ) * } + * * @param nscopes The number of levels to push. * @throws CVC5ApiException */ @@ -2378,6 +2471,7 @@ public class Solver implements IPointer, AutoCloseable /** * Remove all assertions. + * * SMT-LIB: * {@code * ( reset-assertions ) @@ -2392,10 +2486,12 @@ public class Solver implements IPointer, AutoCloseable /** * Set info. + * * SMT-LIB: * {@code * ( set-info ) * } + * * @param keyword The info flag. * @param value The value of the info flag. * @throws CVC5ApiException @@ -2409,10 +2505,12 @@ public class Solver implements IPointer, AutoCloseable /** * Set logic. + * * SMT-LIB: * {@code * ( set-logic ) * } + * * @param logic The logic to set. * @throws CVC5ApiException */ @@ -2425,10 +2523,12 @@ public class Solver implements IPointer, AutoCloseable /** * Set option. + * * SMT-LIB: * {@code * ( set-option