1 /******************************************************************************
2 * Top contributors (to current version):
3 * Aina Niemetz, Andrew Reynolds, Makai Mann
5 * This file is part of the cvc5 project.
7 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8 * in the top-level source directory and their institutional affiliations.
9 * All rights reserved. See the file COPYING in the top-level source
10 * directory for licensing information.
11 * ****************************************************************************
13 * The term kinds of the cvc5 C++ API.
16 #include "cvc5_export.h"
18 #ifndef CVC5__API__CVC5_KIND_H
19 #define CVC5__API__CVC5_KIND_H
26 /* -------------------------------------------------------------------------- */
28 /* -------------------------------------------------------------------------- */
30 // TODO(Gereon): Fix links that involve std::vector. See
31 // https://github.com/doxygen/doxygen/issues/8503
34 * The kind of a cvc5 term.
38 * Note that the API type `cvc5::api::Kind` roughly corresponds to
39 * `cvc5::Kind`, but is a different type. It hides internal kinds that should
40 * not be exported to the API, and maps all kinds that we want to export to its
41 * corresponding internal kinds. The underlying type of `cvc5::api::Kind` must
42 * be signed (to enable range checks for validity). The size of this type
43 * depends on the size of `cvc5::Kind` (`NodeValue::NBITS_KIND`, currently 10
44 * bits, see expr/node_value.h).
50 * Should never be exposed or created via the API.
55 * Should never be exposed or created via the API.
59 * Null kind (kind of null term `Term::Term()`).
60 * Do not explicitly create via API functions other than `Term::Term()`.
64 /* Builtin --------------------------------------------------------------- */
67 * Uninterpreted constant.
70 * - 1: Sort of the constant
71 * - 2: Index of the constant
74 * - `Solver::mkUninterpretedConst(const Sort& sort, int32_t index) const`
76 UNINTERPRETED_CONSTANT
,
78 * Abstract value (other than uninterpreted sort constants).
81 * - 1: Index of the abstract value
84 * - `Solver::mkAbstractValue(const std::string& index) const`
85 * - `Solver::mkAbstractValue(uint64_t index) const`
89 /* Built-in operator */
93 * Equality, chainable.
96 * - 1..n: Terms with same sorts
99 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
100 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
101 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
108 * - 1..n: Terms with same sorts
111 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
112 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
113 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
117 * First-order constant.
119 * Not permitted in bindings (forall, exists, ...).
122 * - See @ref cvc5::api::Solver::mkConst() "mkConst()".
125 * - `Solver::mkConst(const Sort& sort, const std::string& symbol) const`
126 * - `Solver::mkConst(const Sort& sort) const`
132 * Permitted in bindings and in the lambda and quantifier bodies only.
135 * - See @ref cvc5::api::Solver::mkVar() "mkVar()".
138 * - `Solver::mkVar(const Sort& sort, const std::string& symbol) const`
142 /* Skolem variable (internal only) */
146 * Symbolic expression.
152 * - `Solver::mkTerm(Kind kind, const Term& child) const`
153 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
154 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
155 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
162 * - 1: BOUND_VAR_LIST
166 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
167 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
171 * The syntax of a witness term is similar to a quantified formula except that
172 * only one bound variable is allowed.
173 * The term `(witness ((x T)) F)` returns an element `x` of type `T`
176 * The witness operator behaves like the description operator
177 * (see https://planetmath.org/hilbertsvarepsilonoperator) if there is no x
178 * that satisfies F. But if such x exists, the witness operator does not
179 * enforce the axiom that ensures uniqueness up to logical equivalence:
182 * \forall x. F \equiv G \Rightarrow witness~x. F = witness~x. G
185 * For example if there are 2 elements of type T that satisfy F, then the
186 * following formula is satisfiable:
189 * (witness ((x Int)) F)
190 * (witness ((x Int)) F))
192 * This kind is primarily used internally, but may be returned in models
193 * (e.g. for arithmetic terms in non-linear queries). However, it is not
194 * supported by the parser. Moreover, the user of the API should be cautious
195 * when using this operator. In general, all witness terms
196 * `(witness ((x Int)) F)` should be such that `(exists ((x Int)) F)` is a
197 * valid formula. If this is not the case, then the semantics in formulas that
198 * use witness terms may be unintuitive. For example, the following formula is
200 * `(or (= (witness ((x Int)) false) 0) (not (= (witness ((x Int)) false) 0))`
201 * whereas notice that `(or (= z 0) (not (= z 0)))` is true for any `z`.
204 * - 1: BOUND_VAR_LIST
208 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
209 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
213 /* Boolean --------------------------------------------------------------- */
219 * - 1: Boolean value of the constant
222 * - `Solver::mkTrue() const`
223 * - `Solver::mkFalse() const`
224 * - `Solver::mkBoolean(bool val) const`
231 * - 1: Boolean Term to negate
234 * - `Solver::mkTerm(Kind kind, const Term& child) const`
238 * Logical conjunction.
241 * - 1..n: Boolean Term of the conjunction
244 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
245 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
246 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
250 * Logical implication.
253 * - 1..n: Boolean Terms, right associative
256 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
257 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
258 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
262 * Logical disjunction.
265 * - 1..n: Boolean Term of the disjunction
268 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
269 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
270 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
274 * Logical exclusive disjunction, left associative.
277 * - 1..n: Boolean Terms, `[1] xor ... xor [n]`
280 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
281 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
282 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
289 * - 1: is a Boolean condition Term
290 * - 2: the 'then' Term
291 * - 3: the 'else' Term
293 * 'then' and 'else' term must have same base sort.
296 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
297 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
301 /* UF -------------------------------------------------------------------- */
304 * Application of an uninterpreted function.
308 * - 2..n: Function argument instantiation Terms
311 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
312 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
313 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
317 /* Boolean term variable */
318 BOOLEAN_TERM_VARIABLE
,
321 * Cardinality constraint on uninterpreted sort S.
322 * Interpreted as a predicate that is true when the cardinality of S
323 * is less than or equal to the value of the second argument.
326 * - 1: Term of sort S
327 * - 2: Positive integer constant that bounds the cardinality of sort S
330 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
331 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
333 CARDINALITY_CONSTRAINT
,
335 /* Partial uninterpreted function application. */
339 * Higher-order applicative encoding of function application, left
343 * - 1: Function to apply
344 * - 2..n: Arguments of the function
347 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
348 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
349 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
353 /* Arithmetic ------------------------------------------------------------ */
356 * Arithmetic addition.
359 * - 1..n: Terms of sort Integer, Real (sorts must match)
362 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
363 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
364 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
368 * Arithmetic multiplication.
371 * - 1..n: Terms of sort Integer, Real (sorts must match)
374 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
375 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
376 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
380 * Operator for bit-wise AND over integers, parameterized by a (positive)
383 * ((_ iand k) i1 i2) is equivalent to:
384 * (bv2int (bvand ((_ int2bv k) i1) ((_ int2bv k) i2)))
385 * for all integers i1, i2.
388 * - 1: Size of the bit-vector that determines the semantics of the IAND
391 * - `Solver::mkOp(Kind kind, uint32_t param) const`
396 * - 1: Op of kind IAND
401 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2) const`
402 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
406 * Operator for raising 2 to a non-negative integer power.
409 * - `Solver::mkOp(Kind kind) const`
412 * - 1: Op of kind IAND
415 * Apply 2 to the power operator.
418 * - `Solver::mkTerm(const Op& op, const Term& child) const`
419 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
423 /* Synonym for MULT. */
427 * Arithmetic subtraction, left associative.
430 * - 1..n: Terms of sort Integer, Real (sorts must match)
433 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
434 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
435 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
439 * Arithmetic negation.
442 * - 1: Term of sort Integer, Real
445 * - `Solver::mkTerm(Kind kind, const Term& child) const`
449 * Real division, division by 0 undefined, left associative.
452 * - 1..n: Terms of sort Integer, Real
455 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
456 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
457 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
461 * Integer division, division by 0 undefined, left associative.
464 * - 1..n: Terms of sort Integer
467 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
468 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
469 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
473 * Integer modulus, division by 0 undefined.
476 * - 1: Term of sort Integer
477 * - 2: Term of sort Integer
480 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
481 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
488 * - 1: Term of sort Integer
491 * - `Solver::mkTerm(Kind kind, const Term& child) const`
498 * - 1: Term of sort Integer, Real
499 * - 2: Term of sort Integer, Real
502 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
503 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
507 * Exponential function.
510 * - 1: Term of sort Integer, Real
513 * - `Solver::mkTerm(Kind kind, const Term& child) const`
520 * - 1: Term of sort Integer, Real
523 * - `Solver::mkTerm(Kind kind, const Term& child) const`
530 * - 1: Term of sort Integer, Real
533 * - `Solver::mkTerm(Kind kind, const Term& child) const`
540 * - 1: Term of sort Integer, Real
543 * - `Solver::mkTerm(Kind kind, const Term& child) const`
550 * - 1: Term of sort Integer, Real
553 * - `Solver::mkTerm(Kind kind, const Term& child) const`
560 * - 1: Term of sort Integer, Real
563 * - `Solver::mkTerm(Kind kind, const Term& child) const`
567 * Cotangent function.
570 * - 1: Term of sort Integer, Real
573 * - `Solver::mkTerm(Kind kind, const Term& child) const`
580 * - 1: Term of sort Integer, Real
583 * - `Solver::mkTerm(Kind kind, const Term& child) const`
587 * Arc cosine function.
590 * - 1: Term of sort Integer, Real
593 * - `Solver::mkTerm(Kind kind, const Term& child) const`
597 * Arc tangent function.
600 * - 1: Term of sort Integer, Real
603 * - `Solver::mkTerm(Kind kind, const Term& child) const`
607 * Arc cosecant function.
610 * - 1: Term of sort Integer, Real
613 * - `Solver::mkTerm(Kind kind, const Term& child) const`
617 * Arc secant function.
620 * - 1: Term of sort Integer, Real
623 * - `Solver::mkTerm(Kind kind, const Term& child) const`
627 * Arc cotangent function.
630 * - 1: Term of sort Integer, Real
633 * - `Solver::mkTerm(Kind kind, const Term& child) const`
640 * - 1: Term of sort Integer, Real
643 * - `Solver::mkTerm(Kind kind, const Term& child) const`
647 * Operator for the divisibility-by-k predicate.
650 * - 1: The k to divide by (sort Integer)
653 * - `Solver::mkOp(Kind kind, uint32_t param) const`
655 * Apply divisibility-by-k predicate.
658 * - 1: Op of kind DIVISIBLE
662 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2) const`
663 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
667 * Multiple-precision rational constant.
670 * See @ref cvc5::api::Solver::mkInteger() "mkInteger()", @ref cvc5::api::Solver::mkReal() "mkReal()".
673 * - `Solver::mkInteger(const std::string& s) const`
674 * - `Solver::mkInteger(int64_t val) const`
675 * - `Solver::mkReal(const std::string& s) const`
676 * - `Solver::mkReal(int64_t val) const`
677 * - `Solver::mkReal(int64_t num, int64_t den) const`
681 * Less than, chainable.
684 * - 1..n: Terms of sort Integer, Real; [1] < ... < [n]
687 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
688 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
689 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
693 * Less than or equal, chainable.
696 * - 1..n: Terms of sort Integer, Real; [1] <= ... <= [n]
699 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
700 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
704 * Greater than, chainable.
707 * - 1..n: Terms of sort Integer, Real, [1] > ... > [n]
710 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
711 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
712 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
716 * Greater than or equal, chainable.
719 * - 1..n: Terms of sort Integer, Real; [1] >= ... >= [n]
722 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
723 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
724 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
728 * Is-integer predicate.
731 * - 1: Term of sort Integer, Real
734 * - `Solver::mkTerm(Kind kind, const Term& child) const`
738 * Convert Term to Integer by the floor function.
741 * - 1: Term of sort Integer, Real
744 * - `Solver::mkTerm(Kind kind, const Term& child) const`
748 * Convert Term to Real.
752 * - 1: Term of sort Integer, Real
754 * This is a no-op in cvc5, as Integer is a subtype of Real.
760 * Note that PI is considered a special symbol of sort Real, but is not
761 * a real value, i.e., `Term::isRealValue() const` will return false.
764 * - `Solver::mkPi() const`
765 * - `Solver::mkTerm(Kind kind) const`
769 /* BV -------------------------------------------------------------------- */
772 * Fixed-size bit-vector constant.
775 * See @ref cvc5::api::Solver::mkBitVector() "mkBitVector()".
778 * - `Solver::mkBitVector(uint32_t size, uint64_t val) const`
779 * - `Solver::mkBitVector(const std::string& s, uint32_t base) const`
780 * - `Solver::mkBitVector(uint32_t size, const std::string& s, uint32_t base) const`
784 * Concatenation of two or more bit-vectors.
787 * - 1..n: Terms of bit-vector sort
790 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
791 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
792 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
799 * - 1..n: Terms of bit-vector sort (sorts must match)
802 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
803 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
804 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
811 * - 1..n: Terms of bit-vector sort (sorts must match)
814 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
815 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
816 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
823 * - 1..n: Terms of bit-vector sort (sorts must match)
826 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
827 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
828 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
835 * - 1: Term of bit-vector sort
838 * - `Solver::mkTerm(Kind kind, const Term& child) const`
845 * - 1..2: Terms of bit-vector sort (sorts must match)
848 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
849 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
856 * - 1..2: Terms of bit-vector sort (sorts must match)
859 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
860 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
864 * Bit-wise xnor, left associative.
867 * - 1..n: Terms of bit-vector sort (sorts must match)
870 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
871 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
875 * Equality comparison (returns bit-vector of size 1).
878 * - 1..2: Terms of bit-vector sort (sorts must match)
881 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
882 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
883 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
887 * Multiplication of two or more bit-vectors.
890 * - 1..n: Terms of bit-vector sort (sorts must match)
893 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
894 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
895 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
899 * Addition of two or more bit-vectors.
902 * - 1..n: Terms of bit-vector sort (sorts must match)
905 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
906 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
907 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
911 * Subtraction of two bit-vectors.
914 * - 1..2: Terms of bit-vector sort (sorts must match)
917 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
918 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
922 * Negation of a bit-vector (two's complement).
925 * - 1: Term of bit-vector sort
928 * - `Solver::mkTerm(Kind kind, const Term& child) const`
932 * Unsigned division of two bit-vectors, truncating towards 0. If the divisor
933 * is zero, the result is all ones.
936 * - 1..2: Terms of bit-vector sort (sorts must match)
939 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
940 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
944 * Unsigned remainder from truncating division of two bit-vectors. If the
945 * modulus is zero, the result is the dividend.
948 * - 1..2: Terms of bit-vector sort (sorts must match)
951 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
952 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
956 * Two's complement signed division of two bit-vectors. If the divisor is
957 * zero and the dividend is positive, the result is all ones. If the divisor
958 * is zero and the dividend is negative, the result is one.
961 * - 1..2: Terms of bit-vector sort (sorts must match)
964 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
965 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
969 * Two's complement signed remainder of two bit-vectors (sign follows
970 * dividend). If the modulus is zero, the result is the dividend.
973 * - 1..2: Terms of bit-vector sort (sorts must match)
976 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
977 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
981 * Two's complement signed remainder (sign follows divisor). If the modulus
982 * is zero, the result is the dividend.
985 * - 1..2: Terms of bit-vector sort (sorts must match)
988 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
989 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
993 * Bit-vector shift left.
994 * The two bit-vector parameters must have same width.
997 * - 1..2: Terms of bit-vector sort (sorts must match)
1000 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1001 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1005 * Bit-vector logical shift right.
1006 * The two bit-vector parameters must have same width.
1009 * - 1..2: Terms of bit-vector sort (sorts must match)
1012 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1013 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1017 * Bit-vector arithmetic shift right.
1018 * The two bit-vector parameters must have same width.
1021 * - 1..2: Terms of bit-vector sort (sorts must match)
1024 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1025 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1029 * Bit-vector unsigned less than.
1030 * The two bit-vector parameters must have same width.
1033 * - 1..2: Terms of bit-vector sort (sorts must match)
1036 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1037 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1041 * Bit-vector unsigned less than or equal.
1042 * The two bit-vector parameters must have same width.
1045 * - 1..2: Terms of bit-vector sort (sorts must match)
1048 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1049 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1053 * Bit-vector unsigned greater than.
1054 * The two bit-vector parameters must have same width.
1057 * - 1..2: Terms of bit-vector sort (sorts must match)
1060 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1061 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1065 * Bit-vector unsigned greater than or equal.
1066 * The two bit-vector parameters must have same width.
1069 * - 1..2: Terms of bit-vector sort (sorts must match)
1072 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1073 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1077 * Bit-vector signed less than.
1078 * The two bit-vector parameters must have same width.
1081 * - 1..2: Terms of bit-vector sort (sorts must match)
1084 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1085 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1089 * Bit-vector signed less than or equal.
1090 * The two bit-vector parameters must have same width.
1093 * - 1..2: Terms of bit-vector sort (sorts must match)
1096 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1097 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1101 * Bit-vector signed greater than.
1102 * The two bit-vector parameters must have same width.
1105 * - 1..2: Terms of bit-vector sort (sorts must match)
1108 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1109 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1113 * Bit-vector signed greater than or equal.
1114 * The two bit-vector parameters must have same width.
1117 * - 1..2: Terms of bit-vector sort (sorts must match)
1120 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1121 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1125 * Bit-vector unsigned less than, returns bit-vector of size 1.
1128 * - 1..2: Terms of bit-vector sort (sorts must match)
1131 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1132 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1136 * Bit-vector signed less than. returns bit-vector of size 1.
1139 * - 1..2: Terms of bit-vector sort (sorts must match)
1142 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1143 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1147 * Same semantics as regular ITE, but condition is bit-vector of size 1.
1150 * - 1: Term of bit-vector sort of size 1, representing the condition
1151 * - 2: Term reprsenting the 'then' branch
1152 * - 3: Term representing the 'else' branch
1154 * 'then' and 'else' term must have same base sort.
1157 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1158 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1165 * - 1: Term of bit-vector sort
1168 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1172 * Bit-vector redand.
1175 * - 1: Term of bit-vector sort
1178 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1182 /* formula to be treated as a bv atom via eager bit-blasting
1183 * (internal-only symbol) */
1184 BITVECTOR_EAGER_ATOM
,
1185 /* term to be treated as a variable. used for eager bit-blasting Ackermann
1186 * expansion of bvudiv (internal-only symbol) */
1187 BITVECTOR_ACKERMANIZE_UDIV
,
1188 /* term to be treated as a variable. used for eager bit-blasting Ackermann
1189 * expansion of bvurem (internal-only symbol) */
1190 BITVECTOR_ACKERMANIZE_UREM
,
1193 * Operator for bit-vector extract (from index 'high' to 'low').
1196 * - 1: The 'high' index
1197 * - 2: The 'low' index
1200 * - `Solver::mkOp(Kind kind, uint32_t param, uint32_t param) const`
1202 * Apply bit-vector extract.
1205 * - 1: Op of kind BITVECTOR_EXTRACT
1206 * - 2: Term of bit-vector sort
1209 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1210 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1214 * Operator for bit-vector repeat.
1217 * - 1: Number of times to repeat a given bit-vector
1220 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1222 * Apply bit-vector repeat.
1225 * - 1: Op of kind BITVECTOR_REPEAT
1226 * - 2: Term of bit-vector sort
1229 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1230 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1234 * Operator for bit-vector zero-extend.
1237 * - 1: Number of bits by which a given bit-vector is to be extended
1240 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1242 * Apply bit-vector zero-extend.
1245 * - 1: Op of kind BITVECTOR_ZERO_EXTEND
1246 * - 2: Term of bit-vector sort
1249 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1250 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1252 BITVECTOR_ZERO_EXTEND
,
1254 * Operator for bit-vector sign-extend.
1257 * - 1: Number of bits by which a given bit-vector is to be extended
1260 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1262 * Apply bit-vector sign-extend.
1265 * - 1: Op of kind BITVECTOR_SIGN_EXTEND
1266 * - 2: Term of bit-vector sort
1269 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1270 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1272 BITVECTOR_SIGN_EXTEND
,
1274 * Operator for bit-vector rotate left.
1277 * - 1: Number of bits by which a given bit-vector is to be rotated
1280 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1282 * Apply bit-vector rotate left.
1285 * - 1: Op of kind BITVECTOR_ROTATE_LEFT
1286 * - 2: Term of bit-vector sort
1289 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1290 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1292 BITVECTOR_ROTATE_LEFT
,
1294 * Operator for bit-vector rotate right.
1297 * - 1: Number of bits by which a given bit-vector is to be rotated
1300 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1302 * Apply bit-vector rotate right.
1305 * - 1: Op of kind BITVECTOR_ROTATE_RIGHT
1306 * - 2: Term of bit-vector sort
1309 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1310 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1312 BITVECTOR_ROTATE_RIGHT
,
1314 /* bit-vector boolean bit extract. */
1318 * Operator for the conversion from Integer to bit-vector.
1321 * - 1: Size of the bit-vector to convert to
1324 * - `Solver::mkOp(Kind kind, uint32_t param) const`.
1326 * Apply integer conversion to bit-vector.
1329 * - 1: Op of kind INT_TO_BITVECTOR
1333 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1334 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1338 * Bit-vector conversion to (nonnegative) integer.
1341 * - 1: Term of bit-vector sort
1344 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1348 /* FP -------------------------------------------------------------------- */
1351 * Floating-point constant, constructed from a double or string.
1354 * - 1: Size of the exponent
1355 * - 2: Size of the significand
1356 * - 3: Value of the floating-point constant as a bit-vector term
1359 * - `Solver::mkFloatingPoint(uint32_t exp, uint32_t sig, Term val) const`
1361 CONST_FLOATINGPOINT
,
1363 * Floating-point rounding mode term.
1366 * - `Solver::mkRoundingMode(RoundingMode rm) const`
1370 * Create floating-point literal from bit-vector triple.
1373 * - 1: Sign bit as a bit-vector term
1374 * - 2: Exponent bits as a bit-vector term
1375 * - 3: Significand bits as a bit-vector term (without hidden bit)
1378 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1379 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1383 * Floating-point equality.
1386 * - 1..2: Terms of floating point sort
1389 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1390 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1394 * Floating-point absolute value.
1397 * - 1: Term of floating point sort
1400 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1404 * Floating-point negation.
1407 * - 1: Term of floating point sort
1410 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1414 * Floating-point addition.
1417 * - 1: CONST_ROUNDINGMODE
1418 * - 2: Term of sort FloatingPoint
1419 * - 3: Term of sort FloatingPoint
1422 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1423 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1427 * Floating-point sutraction.
1430 * - 1: CONST_ROUNDINGMODE
1431 * - 2: Term of sort FloatingPoint
1432 * - 3: Term of sort FloatingPoint
1435 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1436 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1440 * Floating-point multiply.
1443 * - 1: CONST_ROUNDINGMODE
1444 * - 2: Term of sort FloatingPoint
1445 * - 3: Term of sort FloatingPoint
1448 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1449 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1453 * Floating-point division.
1456 * - 1: CONST_ROUNDINGMODE
1457 * - 2: Term of sort FloatingPoint
1458 * - 3: Term of sort FloatingPoint
1461 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1462 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1466 * Floating-point fused multiply and add.
1469 * - 1: CONST_ROUNDINGMODE
1470 * - 2: Term of sort FloatingPoint
1471 * - 3: Term of sort FloatingPoint
1472 * - 4: Term of sort FloatingPoint
1475 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1479 * Floating-point square root.
1482 * - 1: CONST_ROUNDINGMODE
1483 * - 2: Term of sort FloatingPoint
1486 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1487 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1491 * Floating-point remainder.
1494 * - 1..2: Terms of floating point sort
1497 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1498 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1502 * Floating-point round to integral.
1505 * -1..2: Terms of floating point sort
1508 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1509 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1513 * Floating-point minimum.
1516 * - 1..2: Terms of floating point sort
1519 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1520 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1524 * Floating-point maximum.
1527 * - 1..2: Terms of floating point sort
1530 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1531 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1535 * Floating-point less than or equal.
1538 * - 1..2: Terms of floating point sort
1541 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1542 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1546 * Floating-point less than.
1549 * - 1..2: Terms of floating point sort
1552 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1553 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1557 * Floating-point greater than or equal.
1560 * - 1..2: Terms of floating point sort
1563 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1564 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1568 * Floating-point greater than.
1571 * - 1..2: Terms of floating point sort
1574 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1575 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1579 * Floating-point is normal.
1582 * - 1: Term of floating point sort
1585 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1589 * Floating-point is sub-normal.
1592 * - 1: Term of floating point sort
1595 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1599 * Floating-point is zero.
1602 * - 1: Term of floating point sort
1605 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1609 * Floating-point is infinite.
1612 * - 1: Term of floating point sort
1615 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1617 FLOATINGPOINT_ISINF
,
1619 * Floating-point is NaN.
1622 * - 1: Term of floating point sort
1625 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1627 FLOATINGPOINT_ISNAN
,
1629 * Floating-point is negative.
1632 * - 1: Term of floating point sort
1635 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1637 FLOATINGPOINT_ISNEG
,
1639 * Floating-point is positive.
1642 * - 1: Term of floating point sort
1645 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1647 FLOATINGPOINT_ISPOS
,
1649 * Operator for to_fp from bit vector.
1652 * - 1: Exponent size
1653 * - 2: Significand size
1656 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1658 * Conversion from an IEEE-754 bit vector to floating-point.
1661 * - 1: Op of kind FLOATINGPOINT_TO_FP_IEEE_BITVECTOR
1662 * - 2: Term of sort FloatingPoint
1665 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1666 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1668 FLOATINGPOINT_TO_FP_IEEE_BITVECTOR
,
1670 * Operator for to_fp from floating point.
1673 * - 1: Exponent size
1674 * - 2: Significand size
1677 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1679 * Conversion between floating-point sorts.
1682 * - 1: Op of kind FLOATINGPOINT_TO_FP_FLOATINGPOINT
1683 * - 2: Term of sort FloatingPoint
1686 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1687 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1689 FLOATINGPOINT_TO_FP_FLOATINGPOINT
,
1691 * Operator for to_fp from real.
1694 * - 1: Exponent size
1695 * - 2: Significand size
1698 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1700 * Conversion from a real to floating-point.
1703 * - 1: Op of kind FLOATINGPOINT_TO_FP_REAL
1704 * - 2: Term of sort FloatingPoint
1707 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1708 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1710 FLOATINGPOINT_TO_FP_REAL
,
1712 * Operator for to_fp from signed bit vector
1715 * - 1: Exponent size
1716 * - 2: Significand size
1719 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1721 * Conversion from a signed bit vector to floating-point.
1724 * - 1: Op of kind FLOATINGPOINT_TO_FP_SIGNED_BITVECTOR
1725 * - 2: Term of sort FloatingPoint
1728 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1729 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1731 FLOATINGPOINT_TO_FP_SIGNED_BITVECTOR
,
1733 * Operator for to_fp from unsigned bit vector.
1736 * - 1: Exponent size
1737 * - 2: Significand size
1740 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1742 * Converting an unsigned bit vector to floating-point.
1745 * - 1: Op of kind FLOATINGPOINT_TO_FP_UNSIGNED_BITVECTOR
1746 * - 2: Term of sort FloatingPoint
1749 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1750 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1752 FLOATINGPOINT_TO_FP_UNSIGNED_BITVECTOR
,
1754 * Operator for a generic to_fp.
1757 * - 1: exponent size
1758 * - 2: Significand size
1761 * - `Solver::mkOp(Kind kind, uint32_t param1, uint32_t param2) const`
1763 * Generic conversion to floating-point, used in parsing only.
1766 * - 1: Op of kind FLOATINGPOINT_TO_FP_GENERIC
1767 * - 2: Term of sort FloatingPoint
1770 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1771 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1773 FLOATINGPOINT_TO_FP_GENERIC
,
1775 * Operator for to_ubv.
1778 * - 1: Size of the bit-vector to convert to
1781 * - `Solver::mkOp(Kind kind, uint32_t param) const`
1783 * Conversion from a floating-point value to an unsigned bit vector.
1786 * - 1: Op of kind FLOATINGPOINT_TO_FP_TO_UBV
1787 * - 2: Term of sort FloatingPoint
1790 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1791 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1793 FLOATINGPOINT_TO_UBV
,
1795 * Operator for to_sbv.
1798 * - 1: Size of the bit-vector to convert to
1801 * - `Solver::mkOp(Kind kind, uint32_t param) const`
1803 * Conversion from a floating-point value to a signed bit vector.
1806 * - 1: Op of kind FLOATINGPOINT_TO_FP_TO_SBV
1807 * - 2: Term of sort FloatingPoint
1810 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1811 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1813 FLOATINGPOINT_TO_SBV
,
1815 * Floating-point to real.
1818 * - 1: Term of sort FloatingPoint
1821 * - `Solver::mkTerm(Kind kind, const Term& child) const`
1823 FLOATINGPOINT_TO_REAL
,
1825 /* Arrays ---------------------------------------------------------------- */
1831 * - 1: Term of array sort
1832 * - 2: Selection index
1835 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2) const`
1836 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1843 * - 1: Term of array sort
1845 * - 3: Term to store at the index
1848 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2, const Term& child3) const`
1849 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1857 * - 2: Term representing a constant
1860 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2) const`
1861 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1863 * @note We currently support the creation of constant arrays, but under some
1864 * conditions when there is a chain of equalities connecting two constant
1865 * arrays, the solver doesn't know what to do and aborts (Issue <a
1866 * href="https://github.com/cvc5/cvc5/issues/1667">#1667</a>).
1870 * Equality over arrays a and b over a given range [i,j], i.e.,
1872 * \forall k . i \leq k \leq j \Rightarrow a[k] = b[k]
1878 * - 3: Lower bound of range (inclusive)
1879 * - 4: Uppper bound of range (inclusive)
1882 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1884 * Note: We currently support the creation of array equalities over index
1885 * types bit-vector, floating-point, integer and real. Option --arrays-exp is
1886 * required to support this operator.
1890 /* array table function (internal-only symbol) */
1892 /* array lambda (internal-only symbol) */
1894 /* partial array select, for internal use only */
1896 /* partial array select, for internal use only */
1900 /* Datatypes ------------------------------------------------------------- */
1903 * Constructor application.
1906 * - 1: Constructor (operator)
1907 * - 2..n: Parameters to the constructor
1910 * - `Solver::mkTerm(const Op& op) const`
1911 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1912 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2) const`
1913 * - `Solver::mkTerm(const Op& op, const Term& child1, const Term& child2, const Term& child3) const`
1914 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
1918 * Datatype selector application, which is undefined if misapplied.
1921 * - 1: Selector (operator)
1922 * - 2: Datatype term
1925 * - `Solver::mkTerm(const Op& op, const Term& child) const`
1929 * Datatype tester application.
1933 * - 2: Datatype term
1936 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1937 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1941 * Datatype update application, which does not change the argument if
1945 * - 1: Updater (operator)
1946 * - 2: Datatype term
1947 * - 3: Value to update a field of the datatype term with
1950 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1951 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1955 * Match expressions.
1956 * For example, the smt2 syntax match term
1957 * `(match l (((cons h t) h) (nil 0)))`
1958 * is represented by the AST
1961 * (MATCH_BIND_CASE (BOUND_VAR_LIST h t) (cons h t) h)
1962 * (MATCH_CASE nil 0))
1964 * The type of the last argument of each case term could be equal.
1967 * - 1..n: Terms of kind MATCH_CASE or MATCH_BIND_CASE
1970 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1971 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
1972 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1978 * A (constant) case expression to be used within a match expression.
1981 * - 1: Term denoting the pattern expression
1982 * - 2: Term denoting the return value
1985 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
1986 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
1991 * A (non-constant) case expression to be used within a match expression.
1994 * - 1: a BOUND_VAR_LIST Term containing the free variables of the case
1995 * - 2: Term denoting the pattern expression
1996 * - 3: Term denoting the return value
1999 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2000 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2005 * An operator mapping datatypes to an integer denoting the number of
2006 * non-nullary applications of constructors they contain.
2009 * - 1: Datatype term
2012 * - `Solver::mkTerm(Kind kind, const Term& child1) const`
2013 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2017 * Operator for tuple projection indices
2020 * - 1: The tuple projection indices
2023 * - `Solver::mkOp(Kind TUPLE_PROJECT, std::vector<uint32_t> param) const`
2025 * Constructs a new tuple from an existing one using the elements at the
2029 * - 1: a term of tuple sort
2032 * - `Solver::mkTerm(const Op& op, const Term& child) const`
2033 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
2037 /* datatypes height bound */
2039 /* datatypes height bound */
2041 /* datatypes sygus bound */
2043 /* datatypes sygus term order */
2044 DT_SYGUS_TERM_ORDER
,
2045 /* datatypes sygus is constant */
2049 /* Separation Logic ------------------------------------------------------ */
2052 * Separation logic nil term.
2057 * - `Solver::mkSepNil(const Sort& sort) const`
2061 * Separation logic empty heap constraint
2064 * - `Solver::mkTerm(Kind kind) const`
2068 * Separation logic points-to relation.
2071 * - 1: Location of the points-to constraint
2072 * - 2: Data of the points-to constraint
2075 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2076 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2080 * Separation logic star.
2083 * - 1..n: Child constraints that hold in disjoint (separated) heaps
2086 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2087 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2088 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2092 * Separation logic magic wand.
2095 * - 1: Antecendant of the magic wand constraint
2096 * - 2: Conclusion of the magic wand constraint, which is asserted to
2097 * hold in all heaps that are disjoint extensions of the antecedent.
2100 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2101 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2105 /* separation label (internal use only) */
2109 /* Sets ------------------------------------------------------------------ */
2112 * Empty set constant.
2115 * - 1: Sort of the set elements
2118 * - `Solver::mkEmptySet(const Sort& sort) const`
2125 * - 1..2: Terms of set sort
2128 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2129 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2136 * - 1..2: Terms of set sort
2139 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2140 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2147 * - 1..2: Terms of set sort
2150 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2151 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2158 * - 1..2: Terms of set sort, [1] a subset of set [2]?
2161 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2162 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2166 * Set membership predicate.
2169 * - 1..2: Terms of set sort, [1] a member of set [2]?
2172 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2173 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2177 * Construct a singleton set from an element given as a parameter.
2178 * The returned set has same type of the element.
2181 * - 1: Single element
2184 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2188 * The set obtained by inserting elements;
2191 * - 1..n-1: Elements inserted into set [n]
2195 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2196 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2197 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2198 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2205 * - 1: Set to determine the cardinality of
2208 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2212 * Set complement with respect to finite universe.
2215 * - 1: Set to complement
2218 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2222 * Finite universe set.
2223 * All set variables must be interpreted as subsets of it.
2225 * Note that SET_UNIVERSE is considered a special symbol of the theory of
2226 * sets and is not considered as a set value,
2227 * i.e., `Term::isSetValue() const` will return false.
2230 * - `Solver::mkUniverseSet(const Sort& sort) const`
2235 * A set comprehension is specified by a bound variable list x1 ... xn,
2236 * a predicate P[x1...xn], and a term t[x1...xn]. A comprehension C with the
2237 * above form has members given by the following semantics:
2239 * \forall y. ( \exists x_1...x_n. P[x_1...x_n] \hat{} t[x_1...x_n] = y )
2240 * \Leftrightarrow (member y C)
2242 * where y ranges over the element type of the (set) type of the
2243 * comprehension. If @f$ t[x_1..x_n] @f$ is not provided, it is equivalent to
2244 * y in the above formula.
2247 * - 1: Term BOUND_VAR_LIST
2248 * - 2: Term denoting the predicate of the comprehension
2249 * - 3: (optional) a Term denoting the generator for the comprehension
2252 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2253 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2254 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2258 * Returns an element from a given set.
2259 * If a set A = {x}, then the term (choose A) is equivalent to the term x.
2260 * If the set is empty, then (choose A) is an arbitrary value.
2261 * If the set has cardinality > 1, then (choose A) will deterministically
2262 * return an element in A.
2265 * - 1: Term of set sort
2268 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2272 * Set is_singleton predicate.
2275 * - 1: Term of set sort, is [1] a singleton set?
2278 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2282 /* Relations ------------------------------------------------------------- */
2288 * - 1..2: Terms of set sort
2291 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2292 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2296 * Set cartesian product.
2299 * - 1..2: Terms of set sort
2302 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2303 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2310 * - 1: Term of set sort
2313 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2317 * Set transitive closure.
2320 * - 1: Term of set sort
2323 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2330 * - 1..2: Terms of set sort
2333 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2334 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2336 RELATION_JOIN_IMAGE
,
2341 * - 1: Term of set sort
2344 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2348 /* Bags ------------------------------------------------------------------ */
2351 * Empty bag constant.
2354 * - 1: Sort of the bag elements
2357 * mkEmptyBag(const Sort& sort)
2363 * - 1..2: Terms of bag sort
2366 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2367 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2371 * Bag disjoint union (sum).
2374 * -1..2: Terms of bag sort
2377 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2378 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2382 * Bag intersection (min).
2385 * - 1..2: Terms of bag sort
2388 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2389 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2393 * Bag difference subtract (subtracts multiplicities of the second from the
2397 * - 1..2: Terms of bag sort
2400 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2401 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2403 DIFFERENCE_SUBTRACT
,
2405 * Bag difference 2 (removes shared elements in the two bags).
2408 * - 1..2: Terms of bag sort
2411 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2412 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2416 * Inclusion predicate for bags
2417 * (multiplicities of the first bag <= multiplicities of the second bag).
2420 * - 1..2: Terms of bag sort
2423 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2424 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2428 * Element multiplicity in a bag
2431 * - 1..2: Terms of bag sort (Bag E), [1] an element of sort E
2434 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2435 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2439 * Eliminate duplicates in a given bag. The returned bag contains exactly the
2440 * same elements in the given bag, but with multiplicity one.
2443 * - 1: a term of bag sort
2446 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2447 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2451 * The bag of the single element given as a parameter.
2454 * - 1: Single element
2457 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2464 * - 1: Bag to determine the cardinality of
2467 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2471 * Returns an element from a given bag.
2472 * If a bag A = {(x,n)} where n is the multiplicity, then the term (choose A)
2473 * is equivalent to the term x.
2474 * If the bag is empty, then (choose A) is an arbitrary value.
2475 * If the bag contains distinct elements, then (choose A) will
2476 * deterministically return an element in A.
2479 * - 1: Term of bag sort
2482 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2486 * Bag is_singleton predicate (single element with multiplicity exactly one).
2488 * - 1: Term of bag sort, is [1] a singleton bag?
2491 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2495 * Bag.from_set converts a set to a bag.
2498 * - 1: Term of set sort
2501 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2505 * Bag.to_set converts a bag to a set.
2508 * - 1: Term of bag sort
2511 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2515 * bag.map operator applies the first argument, a function of type (-> T1 T2),
2516 * to every element of the second argument, a bag of type (Bag T1),
2517 * and returns a bag of type (Bag T2).
2520 * - 1: a function of type (-> T1 T2)
2521 * - 2: a bag of type (Bag T1)
2524 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2)
2526 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2530 /* Strings --------------------------------------------------------------- */
2536 * - 1..n: Terms of String sort
2539 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2540 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2541 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2545 * String membership.
2548 * - 1: Term of String sort
2549 * - 2: Term of RegExp sort
2552 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2553 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2560 * - 1: Term of String sort
2563 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2568 * Extracts a substring, starting at index i and of length l, from a string
2569 * s. If the start index is negative, the start index is greater than the
2570 * length of the string, or the length is negative, the result is the empty
2574 * - 1: Term of sort String
2575 * - 2: Term of sort Integer (index i)
2576 * - 3: Term of sort Integer (length l)
2579 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2580 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2585 * Updates a string s by replacing its context starting at an index with t.
2586 * If the start index is negative, the start index is greater than the
2587 * length of the string, the result is s. Otherwise, the length of the
2588 * original string is preserved.
2591 * - 1: Term of sort String
2592 * - 2: Term of sort Integer (index i)
2593 * - 3: Term of sort String (replacement string t)
2596 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2597 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2601 * String character at.
2602 * Returns the character at index i from a string s. If the index is negative
2603 * or the index is greater than the length of the string, the result is the
2604 * empty string. Otherwise the result is a string of length 1.
2607 * - 1: Term of sort String (string s)
2608 * - 2: Term of sort Integer (index i)
2611 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2612 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2617 * Checks whether a string s1 contains another string s2. If s2 is empty, the
2618 * result is always true.
2621 * - 1: Term of sort String (the string s1)
2622 * - 2: Term of sort String (the string s2)
2625 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2626 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2631 * Returns the index of a substring s2 in a string s1 starting at index i. If
2632 * the index is negative or greater than the length of string s1 or the
2633 * substring s2 does not appear in string s1 after index i, the result is -1.
2636 * - 1: Term of sort String (substring s1)
2637 * - 2: Term of sort String (substring s2)
2638 * - 3: Term of sort Integer (index i)
2641 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2642 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2646 * String index-of regular expression match.
2647 * Returns the first match of a regular expression r in a string s. If the
2648 * index is negative or greater than the length of string s1, or r does not
2649 * match a substring in s after index i, the result is -1.
2652 * - 1: Term of sort String (string s)
2653 * - 2: Term of sort RegLan (regular expression r)
2654 * - 3: Term of sort Integer (index i)
2657 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2658 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2663 * Replaces a string s2 in a string s1 with string s3. If s2 does not appear
2664 * in s1, s1 is returned unmodified.
2667 * - 1: Term of sort String (string s1)
2668 * - 2: Term of sort String (string s2)
2669 * - 3: Term of sort String (string s3)
2672 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2673 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2677 * String replace all.
2678 * Replaces all occurrences of a string s2 in a string s1 with string s3.
2679 * If s2 does not appear in s1, s1 is returned unmodified.
2682 * - 1: Term of sort String (string s1)
2683 * - 2: Term of sort String (string s2)
2684 * - 3: Term of sort String (string s3)
2687 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2688 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2692 * String replace regular expression match.
2693 * Replaces the first match of a regular expression r in string s1 with
2694 * string s2. If r does not match a substring of s1, s1 is returned
2698 * - 1: Term of sort String (string s1)
2699 * - 2: Term of sort Regexp (regexp r)
2700 * - 3: Term of sort String (string s2)
2703 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2704 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2708 * String replace all regular expression matches.
2709 * Replaces all matches of a regular expression r in string s1 with string
2710 * s2. If r does not match a substring of s1, s1 is returned unmodified.
2713 * - 1: Term of sort String (string s1)
2714 * - 2: Term of sort Regexp (regexp r)
2715 * - 3: Term of sort String (string s2)
2718 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
2719 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2721 STRING_REPLACE_RE_ALL
,
2723 * String to lower case.
2726 * - 1: Term of String sort
2729 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2733 * String to upper case.
2736 * - 1: Term of String sort
2739 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2746 * - 1: Term of String sort
2749 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2754 * Returns the code point of a string if it has length one, or returns -1
2758 * - 1: Term of String sort
2761 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2766 * Returns a string containing a single character whose code point matches
2767 * the argument to this function, or the empty string if the argument is
2771 * - 1: Term of Integer sort
2774 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2779 * Returns true if string s1 is (strictly) less than s2 based on a
2780 * lexiographic ordering over code points.
2783 * - 1: Term of sort String (the string s1)
2784 * - 2: Term of sort String (the string s2)
2787 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2788 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2792 * String less than or equal.
2793 * Returns true if string s1 is less than or equal to s2 based on a
2794 * lexiographic ordering over code points.
2797 * - 1: Term of sort String (the string s1)
2798 * - 2: Term of sort String (the string s2)
2801 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2802 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2807 * Checks whether a string s1 is a prefix of string s2. If string s1 is
2808 * empty, this operator returns true.
2811 * - 1: Term of sort String (string s1)
2812 * - 2: Term of sort String (string s2)
2815 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2816 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2821 * Checks whether a string s1 is a suffix of string 2. If string s1 is empty,
2822 * this operator returns true.
2825 * - 1: Term of sort String (string s1)
2826 * - 2: Term of sort String (string s2)
2829 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2830 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2835 * Returns true if string s is digit (it is one of "0", ..., "9").
2838 * - 1: Term of sort String
2841 * - `Solver::mkTerm(Kind kind, const Term& child1) const`
2842 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2846 * Integer to string.
2847 * If the integer is negative this operator returns the empty string.
2850 * - 1: Term of sort Integer
2853 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2857 * String to integer (total function).
2858 * If the string does not contain an integer or the integer is negative, the
2859 * operator returns -1.
2862 * - 1: Term of sort String
2865 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2872 * - See @ref cvc5::api::Solver::mkString() "mkString()".
2875 * - `Solver::mkString(const std::string& s, bool useEscSequences) const`
2876 * - `Solver::mkString(const unsigned char c) const`
2877 * - `Solver::mkString(const std::vector<uint32_t>& s) const`
2881 * Conversion from string to regexp.
2884 * - 1: Term of sort String
2887 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2891 * Regexp Concatenation.
2894 * - 1..2: Terms of Regexp sort
2897 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2898 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2905 * - 1..2: Terms of Regexp sort
2908 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2909 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2913 * Regexp intersection.
2916 * - 1..2: Terms of Regexp sort
2919 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2920 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2924 * Regexp difference.
2927 * - 1..2: Terms of Regexp sort
2930 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2931 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2938 * - 1: Term of sort Regexp
2941 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2948 * - 1: Term of sort Regexp
2951 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2958 * - 1: Term of sort Regexp
2961 * - `Solver::mkTerm(Kind kind, const Term& child) const`
2968 * - 1: Lower bound character for the range
2969 * - 2: Upper bound character for the range
2972 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
2973 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
2977 * Operator for regular expression repeat.
2980 * - 1: The number of repetitions
2983 * - `Solver::mkOp(Kind kind, uint32_t param) const`
2985 * Apply regular expression loop.
2988 * - 1: Op of kind REGEXP_REPEAT
2989 * - 2: Term of regular expression sort
2992 * - `Solver::mkTerm(const Op& op, const Term& child) const`
2993 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
2997 * Operator for regular expression loop, from lower bound to upper bound
2998 * number of repetitions.
3001 * - 1: The lower bound
3002 * - 2: The upper bound
3005 * - `Solver::mkOp(Kind kind, uint32_t param, uint32_t param) const`
3007 * Apply regular expression loop.
3010 * - 1: Op of kind REGEXP_LOOP
3011 * - 2: Term of regular expression sort
3014 * - `Solver::mkTerm(const Op& op, const Term& child) const`
3015 * - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`
3024 * - `Solver::mkRegexpEmpty() const`
3025 * - `Solver::mkTerm(Kind kind) const`
3029 * Regexp all characters.
3034 * - `Solver::mkRegexpSigma() const`
3035 * - `Solver::mkTerm(Kind kind) const`
3039 * Regexp complement.
3042 * - 1: Term of sort RegExp
3045 * - `Solver::mkTerm(Kind kind, const Term& child1) const`
3053 * - 1..n: Terms of Sequence sort
3056 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3057 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3058 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3065 * - 1: Term of Sequence sort
3068 * - `Solver::mkTerm(Kind kind, const Term& child) const`
3073 * Extracts a subsequence, starting at index i and of length l, from a
3074 * sequence s. If the start index is negative, the start index is greater
3075 * than the length of the sequence, or the length is negative, the result is
3076 * the empty sequence.
3079 * - 1: Term of sort Sequence
3080 * - 2: Term of sort Integer (index i)
3081 * - 3: Term of sort Integer (length l)
3084 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3085 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3090 * Updates a sequence s by replacing its context starting at an index with t.
3091 * If the start index is negative, the start index is greater than the
3092 * length of the sequence, the result is s. Otherwise, the length of the
3093 * original sequence is preserved.
3096 * - 1: Term of sort Sequence
3097 * - 2: Term of sort Integer (index i)
3098 * - 3: Term of sort Sequence (replacement sequence t)
3101 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3102 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3106 * Sequence element at.
3107 * Returns the element at index i from a sequence s. If the index is negative
3108 * or the index is greater or equal to the length of the sequence, the result
3109 * is the empty sequence. Otherwise the result is a sequence of length 1.
3112 * - 1: Term of sequence sort (string s)
3113 * - 2: Term of sort Integer (index i)
3116 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3117 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3121 * Sequence contains.
3122 * Checks whether a sequence s1 contains another sequence s2. If s2 is empty,
3123 * the result is always true.
3126 * - 1: Term of sort Sequence (the sequence s1)
3127 * - 2: Term of sort Sequence (the sequence s2)
3130 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3131 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3135 * Sequence index-of.
3136 * Returns the index of a subsequence s2 in a sequence s1 starting at index i.
3137 * If the index is negative or greater than the length of sequence s1 or the
3138 * subsequence s2 does not appear in sequence s1 after index i, the result is
3142 * - 1: Term of sort Sequence (subsequence s1)
3143 * - 2: Term of sort Sequence (subsequence s2)
3144 * - 3: Term of sort Integer (index i)
3147 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3148 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3153 * Replaces the first occurrence of a sequence s2 in a sequence s1 with
3154 * sequence s3. If s2 does not appear in s1, s1 is returned unmodified.
3157 * - 1: Term of sort Sequence (sequence s1)
3158 * - 2: Term of sort Sequence (sequence s2)
3159 * - 3: Term of sort Sequence (sequence s3)
3162 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3163 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3167 * Sequence replace all.
3168 * Replaces all occurrences of a sequence s2 in a sequence s1 with sequence
3169 * s3. If s2 does not appear in s1, s1 is returned unmodified.
3172 * - 1: Term of sort Sequence (sequence s1)
3173 * - 2: Term of sort Sequence (sequence s2)
3174 * - 3: Term of sort Sequence (sequence s3)
3177 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3178 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3185 * - 1: Term of Sequence sort
3188 * - `Solver::mkTerm(Kind kind, const Term& child) const`
3192 * Sequence prefix-of.
3193 * Checks whether a sequence s1 is a prefix of sequence s2. If sequence s1 is
3194 * empty, this operator returns true.
3197 * - 1: Term of sort Sequence (sequence s1)
3198 * - 2: Term of sort Sequence (sequence s2)
3201 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3202 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3206 * Sequence suffix-of.
3207 * Checks whether a sequence s1 is a suffix of sequence s2. If sequence s1 is
3208 * empty, this operator returns true.
3211 * - 1: Term of sort Sequence (sequence s1)
3212 * - 2: Term of sort Sequence (sequence s2)
3215 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3216 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3220 * Constant sequence.
3223 * - See @ref cvc5::api::Solver::mkEmptySequence() "mkEmptySequence()".
3226 * - `Solver::mkEmptySequence(const Sort& sort) const`
3228 * Note that a constant sequence is a term that is equivalent to:
3230 * (seq.++ (seq.unit c1) ... (seq.unit cn))
3232 * where n>=0 and c1, ..., cn are constants of some sort. The elements
3233 * can be extracted by `Term::getSequenceValue()`.
3237 * Sequence unit, corresponding to a sequence of length one with the given
3241 * - 1: Element term.
3244 * - `Solver::mkTerm(Kind kind, const Term& child1) const`
3248 * Sequence nth, corresponding to the nth element of a sequence.
3251 * - 1: Sequence term.
3252 * - 2: Integer term.
3255 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3259 /* Quantifiers ----------------------------------------------------------- */
3262 * Universally quantified formula.
3265 * - 1: BOUND_VAR_LIST Term
3266 * - 2: Quantifier body
3267 * - 3: (optional) INST_PATTERN_LIST Term
3270 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3271 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3272 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3276 * Existentially quantified formula.
3279 * - 1: BOUND_VAR_LIST Term
3280 * - 2: Quantifier body
3281 * - 3: (optional) INST_PATTERN_LIST Term
3284 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3285 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3286 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3290 * A list of bound variables (used to bind variables under a quantifier)
3293 * - 1..n: Terms with kind BOUND_VARIABLE
3296 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3297 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3298 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3302 * An instantiation pattern.
3303 * Specifies a (list of) terms to be used as a pattern for quantifier
3307 * - 1..n: Terms with kind BOUND_VARIABLE
3310 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3311 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3312 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3316 * An instantiation no-pattern.
3317 * Specifies a (list of) terms that should not be used as a pattern for
3318 * quantifier instantiation.
3321 * - 1..n: Terms with kind BOUND_VARIABLE
3324 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3325 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3326 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3330 * An instantiation pool.
3331 * Specifies an annotation for pool based instantiation.
3333 * - 1..n: Terms that comprise the pools, which are one-to-one with
3334 * the variables of the quantified formula to be instantiated.
3336 * - `mkTerm(Kind kind, Term child1, Term child2)
3337 * - `mkTerm(Kind kind, Term child1, Term child2, Term child3)
3338 * - `mkTerm(Kind kind, const std::vector<Term>& children)
3342 * A instantantiation-add-to-pool annotation.
3344 * - 1: The pool to add to.
3346 * - `mkTerm(Kind kind, Term child)
3350 * A skolemization-add-to-pool annotation.
3352 * - 1: The pool to add to.
3354 * - `mkTerm(Kind kind, Term child)
3358 * An instantiation attribute
3359 * Specifies a custom property for a quantified formula given by a
3360 * term that is ascribed a user attribute.
3362 * Parameters: n >= 1
3363 * - 1: The keyword of the attribute (a term with kind CONST_STRING).
3364 * - 2...n: The values of the attribute.
3367 * - `mkTerm(Kind kind, Term child1, Term child2)
3368 * - `mkTerm(Kind kind, Term child1, Term child2, Term child3)
3369 * - `mkTerm(Kind kind, const std::vector<Term>& children)
3373 * A list of instantiation patterns and/or attributes.
3376 * - 1..n: Terms with kind INST_PATTERN, INST_NO_PATTERN, or
3380 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2) const`
3381 * - `Solver::mkTerm(Kind kind, const Term& child1, const Term& child2, const Term& child3) const`
3382 * - `Solver::mkTerm(Kind kind, const std::vector<Term>& children) const`
3387 /* Sort Kinds ------------------------------------------------------------ */
3391 /* a type parameter for type ascription */
3395 /* a datatype type index */
3399 /* set type, takes as parameter the type of the elements */
3401 /* bag type, takes as parameter the type of the elements */
3405 /* specifies types of user-declared 'uninterpreted' sorts */
3409 /* a representation for basic types */
3411 /* a function type */
3413 /* the type of a symbolic expression */
3415 /* bit-vector type */
3417 /* floating-point type */
3421 /* ----------------------------------------------------------------------- */
3422 /** Marks the upper-bound of this enumeration. */
3428 * Get the string representation of a given kind.
3430 * @return the string representation of kind k
3432 std::string
kindToString(Kind k
) CVC5_EXPORT
;
3435 * Serialize a kind to given stream.
3436 * @param out the output stream
3437 * @param k the kind to be serialized to the given output stream
3438 * @return the output stream
3440 std::ostream
& operator<<(std::ostream
& out
, Kind k
) CVC5_EXPORT
;
3448 * Hash function for Kinds.
3451 struct CVC5_EXPORT hash
<cvc5::api::Kind
>
3454 * Hashes a Kind to a size_t.
3456 size_t operator()(cvc5::api::Kind k
) const;