Z3
Public Member Functions | Protected Member Functions
Expr Class Reference
+ Inheritance diagram for Expr:

Public Member Functions

Expr simplify ()
 
Expr simplify (Params p)
 
FuncDecl getFuncDecl ()
 
Z3_lbool getBoolValue ()
 
int getNumArgs ()
 
Expr[] getArgs ()
 
Expr update (Expr[] args)
 
Expr substitute (Expr[] from, Expr[] to)
 
Expr substitute (Expr from, Expr to)
 
Expr substituteVars (Expr[] to)
 
Expr translate (Context ctx)
 
String toString ()
 
boolean isNumeral ()
 
boolean isWellSorted ()
 
Sort getSort ()
 
boolean isConst ()
 
boolean isIntNum ()
 
boolean isRatNum ()
 
boolean isAlgebraicNumber ()
 
boolean isBool ()
 
boolean isTrue ()
 
boolean isFalse ()
 
boolean isEq ()
 
boolean isDistinct ()
 
boolean isITE ()
 
boolean isAnd ()
 
boolean isOr ()
 
boolean isIff ()
 
boolean isXor ()
 
boolean isNot ()
 
boolean isImplies ()
 
boolean isInt ()
 
boolean isReal ()
 
boolean isArithmeticNumeral ()
 
boolean isLE ()
 
boolean isGE ()
 
boolean isLT ()
 
boolean isGT ()
 
boolean isAdd ()
 
boolean isSub ()
 
boolean isUMinus ()
 
boolean isMul ()
 
boolean isDiv ()
 
boolean isIDiv ()
 
boolean isRemainder ()
 
boolean isModulus ()
 
boolean isIntToReal ()
 
boolean isRealToInt ()
 
boolean isRealIsInt ()
 
boolean isArray ()
 
boolean isStore ()
 
boolean isSelect ()
 
boolean isConstantArray ()
 
boolean isDefaultArray ()
 
boolean isArrayMap ()
 
boolean isAsArray ()
 
boolean isSetUnion ()
 
boolean isSetIntersect ()
 
boolean isSetDifference ()
 
boolean isSetComplement ()
 
boolean isSetSubset ()
 
boolean isBV ()
 
boolean isBVNumeral ()
 
boolean isBVBitOne ()
 
boolean isBVBitZero ()
 
boolean isBVUMinus ()
 
boolean isBVAdd ()
 
boolean isBVSub ()
 
boolean isBVMul ()
 
boolean isBVSDiv ()
 
boolean isBVUDiv ()
 
boolean isBVSRem ()
 
boolean isBVURem ()
 
boolean isBVSMod ()
 
boolean isBVULE ()
 
boolean isBVSLE ()
 
boolean isBVUGE ()
 
boolean isBVSGE ()
 
boolean isBVULT ()
 
boolean isBVSLT ()
 
boolean isBVUGT ()
 
boolean isBVSGT ()
 
boolean isBVAND ()
 
boolean isBVOR ()
 
boolean isBVNOT ()
 
boolean isBVXOR ()
 
boolean isBVNAND ()
 
boolean isBVNOR ()
 
boolean isBVXNOR ()
 
boolean isBVConcat ()
 
boolean isBVSignExtension ()
 
boolean isBVZeroExtension ()
 
boolean isBVExtract ()
 
boolean isBVRepeat ()
 
boolean isBVReduceOR ()
 
boolean isBVReduceAND ()
 
boolean isBVComp ()
 
boolean isBVShiftLeft ()
 
boolean isBVShiftRightLogical ()
 
boolean isBVShiftRightArithmetic ()
 
boolean isBVRotateLeft ()
 
boolean isBVRotateRight ()
 
boolean isBVRotateLeftExtended ()
 
boolean isBVRotateRightExtended ()
 
boolean isIntToBV ()
 
boolean isBVToInt ()
 
boolean isBVCarry ()
 
boolean isBVXOR3 ()
 
boolean isLabel ()
 
boolean isLabelLit ()
 
boolean isString ()
 
String getString ()
 
boolean isConcat ()
 
boolean isOEQ ()
 
boolean isProofTrue ()
 
boolean isProofAsserted ()
 
boolean isProofGoal ()
 
boolean isProofModusPonens ()
 
boolean isProofReflexivity ()
 
boolean isProofSymmetry ()
 
boolean isProofTransitivity ()
 
boolean isProofTransitivityStar ()
 
boolean isProofMonotonicity ()
 
boolean isProofQuantIntro ()
 
boolean isProofDistributivity ()
 
boolean isProofAndElimination ()
 
boolean isProofOrElimination ()
 
boolean isProofRewrite ()
 
boolean isProofRewriteStar ()
 
boolean isProofPullQuant ()
 
boolean isProofPushQuant ()
 
boolean isProofElimUnusedVars ()
 
boolean isProofDER ()
 
boolean isProofQuantInst ()
 
boolean isProofHypothesis ()
 
boolean isProofLemma ()
 
boolean isProofUnitResolution ()
 
boolean isProofIFFTrue ()
 
boolean isProofIFFFalse ()
 
boolean isProofCommutativity ()
 
boolean isProofDefAxiom ()
 
boolean isProofDefIntro ()
 
boolean isProofApplyDef ()
 
boolean isProofIFFOEQ ()
 
boolean isProofNNFPos ()
 
boolean isProofNNFNeg ()
 
boolean isProofSkolemize ()
 
boolean isProofModusPonensOEQ ()
 
boolean isProofTheoryLemma ()
 
boolean isRelation ()
 
boolean isRelationStore ()
 
boolean isEmptyRelation ()
 
boolean isIsEmptyRelation ()
 
boolean isRelationalJoin ()
 
boolean isRelationUnion ()
 
boolean isRelationWiden ()
 
boolean isRelationProject ()
 
boolean isRelationFilter ()
 
boolean isRelationNegationFilter ()
 
boolean isRelationRename ()
 
boolean isRelationComplement ()
 
boolean isRelationSelect ()
 
boolean isRelationClone ()
 
boolean isFiniteDomain ()
 
boolean isFiniteDomainLT ()
 
int getIndex ()
 
- Public Member Functions inherited from AST
boolean equals (Object o)
 
int compareTo (AST other)
 
int hashCode ()
 
int getId ()
 
AST translate (Context ctx)
 
Z3_ast_kind getASTKind ()
 
boolean isExpr ()
 
boolean isApp ()
 
boolean isVar ()
 
boolean isQuantifier ()
 
boolean isSort ()
 
boolean isFuncDecl ()
 
String toString ()
 
String getSExpr ()
 

Protected Member Functions

 Expr (Context ctx, long obj)
 

Detailed Description

Expressions are terms.

Definition at line 30 of file Expr.java.

Constructor & Destructor Documentation

◆ Expr()

Expr ( Context  ctx,
long  obj 
)
inlineprotected

Constructor for Expr

Exceptions
Z3Exceptionon error

Definition at line 2096 of file Expr.java.

2096 {
2097 super(ctx, obj);
2098 }

Member Function Documentation

◆ getArgs()

Expr[] getArgs ( )
inline

The arguments of the expression.

Exceptions
Z3Exceptionon error
Returns
an Expr[]

Definition at line 105 of file Expr.java.

106 {
107 int n = getNumArgs();
108 Expr[] res = new Expr[n];
109 for (int i = 0; i < n; i++) {
110 res[i] = Expr.create(getContext(),
111 Native.getAppArg(getContext().nCtx(), getNativeObject(), i));
112 }
113 return res;
114 }
Expr(Context ctx, long obj)
Definition: Expr.java:2096

Referenced by FuncInterp.toString().

◆ getBoolValue()

Z3_lbool getBoolValue ( )
inline

Indicates whether the expression is the true or false expression or something else (Z3_L_UNDEF).

Exceptions
Z3Exceptionon error
Returns
a Z3_lbool

Definition at line 84 of file Expr.java.

85 {
86 return Z3_lbool.fromInt(Native.getBoolValue(getContext().nCtx(),
87 getNativeObject()));
88 }
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:100

◆ getFuncDecl()

FuncDecl getFuncDecl ( )
inline

The function declaration of the function that is applied in this expression.

Returns
a FuncDecl
Exceptions
Z3Exceptionon error

Definition at line 72 of file Expr.java.

73 {
74 return new FuncDecl(getContext(), Native.getAppDecl(getContext().nCtx(),
75 getNativeObject()));
76 }

Referenced by Model.getConstInterp(), Expr.isAdd(), Expr.isAnd(), Expr.isArithmeticNumeral(), Expr.isArrayMap(), Expr.isAsArray(), Expr.isBVAdd(), Expr.isBVAND(), Expr.isBVBitOne(), Expr.isBVBitZero(), Expr.isBVCarry(), Expr.isBVComp(), Expr.isBVConcat(), Expr.isBVExtract(), Expr.isBVMul(), Expr.isBVNAND(), Expr.isBVNOR(), Expr.isBVNOT(), Expr.isBVNumeral(), Expr.isBVOR(), Expr.isBVReduceAND(), Expr.isBVReduceOR(), Expr.isBVRepeat(), Expr.isBVRotateLeft(), Expr.isBVRotateLeftExtended(), Expr.isBVRotateRight(), Expr.isBVRotateRightExtended(), Expr.isBVSDiv(), Expr.isBVSGE(), Expr.isBVSGT(), Expr.isBVShiftLeft(), Expr.isBVShiftRightArithmetic(), Expr.isBVShiftRightLogical(), Expr.isBVSignExtension(), Expr.isBVSLE(), Expr.isBVSLT(), Expr.isBVSMod(), Expr.isBVSRem(), Expr.isBVSub(), Expr.isBVToInt(), Expr.isBVUDiv(), Expr.isBVUGE(), Expr.isBVUGT(), Expr.isBVULE(), Expr.isBVULT(), Expr.isBVUMinus(), Expr.isBVURem(), Expr.isBVXNOR(), Expr.isBVXOR(), Expr.isBVXOR3(), Expr.isBVZeroExtension(), Expr.isConcat(), Expr.isConst(), Expr.isConstantArray(), Expr.isDefaultArray(), Expr.isDistinct(), Expr.isDiv(), Expr.isEmptyRelation(), Expr.isEq(), Expr.isFalse(), Expr.isFiniteDomainLT(), Expr.isGE(), Expr.isGT(), Expr.isIDiv(), Expr.isIff(), Expr.isImplies(), Expr.isIntToBV(), Expr.isIntToReal(), Expr.isIsEmptyRelation(), Expr.isITE(), Expr.isLabel(), Expr.isLabelLit(), Expr.isLE(), Expr.isLT(), Expr.isModulus(), Expr.isMul(), Expr.isNot(), Expr.isOEQ(), Expr.isOr(), Expr.isProofAndElimination(), Expr.isProofApplyDef(), Expr.isProofAsserted(), Expr.isProofCommutativity(), Expr.isProofDefAxiom(), Expr.isProofDefIntro(), Expr.isProofDER(), Expr.isProofDistributivity(), Expr.isProofElimUnusedVars(), Expr.isProofGoal(), Expr.isProofHypothesis(), Expr.isProofIFFFalse(), Expr.isProofIFFOEQ(), Expr.isProofIFFTrue(), Expr.isProofLemma(), Expr.isProofModusPonens(), Expr.isProofModusPonensOEQ(), Expr.isProofMonotonicity(), Expr.isProofNNFNeg(), Expr.isProofNNFPos(), Expr.isProofOrElimination(), Expr.isProofPullQuant(), Expr.isProofPushQuant(), Expr.isProofQuantInst(), Expr.isProofQuantIntro(), Expr.isProofReflexivity(), Expr.isProofRewrite(), Expr.isProofRewriteStar(), Expr.isProofSkolemize(), Expr.isProofSymmetry(), Expr.isProofTheoryLemma(), Expr.isProofTransitivity(), Expr.isProofTransitivityStar(), Expr.isProofTrue(), Expr.isProofUnitResolution(), Expr.isRealIsInt(), Expr.isRealToInt(), Expr.isRelationalJoin(), Expr.isRelationClone(), Expr.isRelationComplement(), Expr.isRelationFilter(), Expr.isRelationNegationFilter(), Expr.isRelationProject(), Expr.isRelationRename(), Expr.isRelationSelect(), Expr.isRelationStore(), Expr.isRelationUnion(), Expr.isRelationWiden(), Expr.isRemainder(), FPRMNum.isRNA(), FPRMNum.isRNE(), FPRMNum.isRoundNearestTiesToAway(), FPRMNum.isRoundNearestTiesToEven(), FPRMNum.isRoundTowardNegative(), FPRMNum.isRoundTowardPositive(), FPRMNum.isRoundTowardZero(), FPRMNum.isRTN(), FPRMNum.isRTP(), FPRMNum.isRTZ(), Expr.isSelect(), Expr.isSetComplement(), Expr.isSetDifference(), Expr.isSetIntersect(), Expr.isSetSubset(), Expr.isSetUnion(), Expr.isStore(), Expr.isSub(), Expr.isTrue(), Expr.isUMinus(), and Expr.isXor().

◆ getIndex()

int getIndex ( )
inline

The de-Bruijn index of a bound variable. Remarks: Bound variables are indexed by de-Bruijn indices. It is perhaps easiest to explain the meaning of de-Bruijn indices by indicating the compilation process from non-de-Bruijn formulas to de-Bruijn format.
abs(forall (x1) phi) = forall (x1) abs1(phi, x1, 0)
abs(forall (x1, x2) phi) = abs(forall (x1) abs(forall (x2) phi))
abs1(x, x, n) = b_n
abs1(y, x, n) = y
abs1(f(t1,...,tn), x, n) = f(abs1(t1,x,n), ..., abs1(tn,x,n))
abs1(forall (x1) phi, x, n) = forall (x1) (abs1(phi, x, n+1))
The last line is significant: the index of a bound variable is different depending on the scope in which it appears. The deeper x appears, the higher is its index.

Exceptions
Z3Exceptionon error
Returns
an int

Definition at line 2083 of file Expr.java.

2084 {
2085 if (!isVar()) {
2086 throw new Z3Exception("Term is not a bound variable.");
2087 }
2088
2089 return Native.getIndexValue(getContext().nCtx(), getNativeObject());
2090 }
boolean isVar()
Definition: AST.java:141

◆ getNumArgs()

int getNumArgs ( )
inline

The number of arguments of the expression.

Exceptions
Z3Exceptionon error
Returns
an int

Definition at line 95 of file Expr.java.

96 {
97 return Native.getAppNumArgs(getContext().nCtx(), getNativeObject());
98 }

Referenced by Expr.getArgs(), Expr.isConst(), and Expr.update().

◆ getSort()

Sort getSort ( )
inline

The Sort of the term.

Exceptions
Z3Exceptionon error
Returns
a sort

Definition at line 235 of file Expr.java.

236 {
237 return Sort.create(getContext(),
238 Native.getSort(getContext().nCtx(), getNativeObject()));
239 }

Referenced by FPExpr.getEBits(), FPExpr.getSBits(), and BitVecExpr.getSortSize().

◆ getString()

String getString ( )
inline

Retrieve string corresponding to string constant. Remark: the expression should be a string constant, (isString() should return true).

Exceptions
Z3Exceptionon error
Returns
a string

Definition at line 1288 of file Expr.java.

1289 {
1290 return Native.getString(getContext().nCtx(), getNativeObject());
1291 }

◆ isAdd()

boolean isAdd ( )
inline

Indicates whether the term is addition (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 480 of file Expr.java.

481 {
483 }
boolean isApp()
Definition: AST.java:131
FuncDecl getFuncDecl()
Definition: Expr.java:72
Z3_decl_kind getDeclKind()
Definition: FuncDecl.java:119
Z3_decl_kind
The different kinds of interpreted function kinds.
Definition: z3_api.h:1007

◆ isAlgebraicNumber()

boolean isAlgebraicNumber ( )
inline

Indicates whether the term is an algebraic number

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 276 of file Expr.java.

277 {
278 return Native.isAlgebraicNumber(getContext().nCtx(), getNativeObject());
279 }

◆ isAnd()

boolean isAnd ( )
inline

Indicates whether the term is an n-ary conjunction

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 349 of file Expr.java.

◆ isArithmeticNumeral()

boolean isArithmeticNumeral ( )
inline

Indicates whether the term is an arithmetic numeral.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 430 of file Expr.java.

◆ isArray()

boolean isArray ( )
inline

Indicates whether the term is of an array sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 591 of file Expr.java.

592 {
593 return (Native.isApp(getContext().nCtx(), getNativeObject()) && Z3_sort_kind
594 .fromInt(Native.getSortKind(getContext().nCtx(),
595 Native.getSort(getContext().nCtx(), getNativeObject()))) == Z3_sort_kind.Z3_ARRAY_SORT);
596 }
Z3_sort_kind
The different kinds of Z3 types (See Z3_get_sort_kind).
Definition: z3_api.h:148

◆ isArrayMap()

boolean isArrayMap ( )
inline

Indicates whether the term is an array map. Remarks: It satisfies mapf[i] = f(a1[i],...,a_n[i]) for every i.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 648 of file Expr.java.

◆ isAsArray()

boolean isAsArray ( )
inline

Indicates whether the term is an as-array term. Remarks: An as-array term * is n array value that behaves as the function graph of the function * passed as parameter.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 659 of file Expr.java.

◆ isBool()

boolean isBool ( )
inline

Indicates whether the term has Boolean sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 286 of file Expr.java.

287 {
288 return (isExpr() && Native.isEqSort(getContext().nCtx(),
289 Native.mkBoolSort(getContext().nCtx()),
290 Native.getSort(getContext().nCtx(), getNativeObject())));
291 }
boolean isExpr()
Definition: AST.java:112

◆ isBV()

boolean isBV ( )
inline

Indicates whether the terms is of bit-vector sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 719 of file Expr.java.

720 {
721 return Native.getSortKind(getContext().nCtx(),
722 Native.getSort(getContext().nCtx(), getNativeObject())) == Z3_sort_kind.Z3_BV_SORT
723 .toInt();
724 }

◆ isBVAdd()

boolean isBVAdd ( )
inline

Indicates whether the term is a bit-vector addition (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 771 of file Expr.java.

◆ isBVAND()

boolean isBVAND ( )
inline

Indicates whether the term is a bit-wise AND

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 982 of file Expr.java.

◆ isBVBitOne()

boolean isBVBitOne ( )
inline

Indicates whether the term is a one-bit bit-vector with value one

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 741 of file Expr.java.

◆ isBVBitZero()

boolean isBVBitZero ( )
inline

Indicates whether the term is a one-bit bit-vector with value zero

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 751 of file Expr.java.

◆ isBVCarry()

boolean isBVCarry ( )
inline

Indicates whether the term is a bit-vector carry Remarks: Compute the * carry bit in a full-adder. The meaning is given by the equivalence (carry * l1 l2 l3) <=> (or (and l1 l2) (and l1 l3) (and l2 l3)))

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1231 of file Expr.java.

◆ isBVComp()

boolean isBVComp ( )
inline

Indicates whether the term is a bit-vector comparison

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1122 of file Expr.java.

◆ isBVConcat()

boolean isBVConcat ( )
inline

Indicates whether the term is a bit-vector concatenation (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1052 of file Expr.java.

◆ isBVExtract()

boolean isBVExtract ( )
inline

Indicates whether the term is a bit-vector extraction

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1082 of file Expr.java.

◆ isBVMul()

boolean isBVMul ( )
inline

Indicates whether the term is a bit-vector multiplication (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 791 of file Expr.java.

◆ isBVNAND()

boolean isBVNAND ( )
inline

Indicates whether the term is a bit-wise NAND

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1022 of file Expr.java.

◆ isBVNOR()

boolean isBVNOR ( )
inline

Indicates whether the term is a bit-wise NOR

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1032 of file Expr.java.

◆ isBVNOT()

boolean isBVNOT ( )
inline

Indicates whether the term is a bit-wise NOT

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1002 of file Expr.java.

◆ isBVNumeral()

boolean isBVNumeral ( )
inline

Indicates whether the term is a bit-vector numeral

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 731 of file Expr.java.

◆ isBVOR()

boolean isBVOR ( )
inline

Indicates whether the term is a bit-wise OR

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 992 of file Expr.java.

◆ isBVReduceAND()

boolean isBVReduceAND ( )
inline

Indicates whether the term is a bit-vector reduce AND

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1112 of file Expr.java.

◆ isBVReduceOR()

boolean isBVReduceOR ( )
inline

Indicates whether the term is a bit-vector reduce OR

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1102 of file Expr.java.

◆ isBVRepeat()

boolean isBVRepeat ( )
inline

Indicates whether the term is a bit-vector repetition

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1092 of file Expr.java.

◆ isBVRotateLeft()

boolean isBVRotateLeft ( )
inline

Indicates whether the term is a bit-vector rotate left

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1162 of file Expr.java.

◆ isBVRotateLeftExtended()

boolean isBVRotateLeftExtended ( )
inline

Indicates whether the term is a bit-vector rotate left (extended) Remarks: Similar to Z3_OP_ROTATE_LEFT, but it is a binary operator instead of a parametric one.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1184 of file Expr.java.

◆ isBVRotateRight()

boolean isBVRotateRight ( )
inline

Indicates whether the term is a bit-vector rotate right

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1172 of file Expr.java.

◆ isBVRotateRightExtended()

boolean isBVRotateRightExtended ( )
inline

Indicates whether the term is a bit-vector rotate right (extended) Remarks: Similar to Z3_OP_ROTATE_RIGHT, but it is a binary operator instead of a parametric one.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1196 of file Expr.java.

◆ isBVSDiv()

boolean isBVSDiv ( )
inline

Indicates whether the term is a bit-vector signed division (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 801 of file Expr.java.

◆ isBVSGE()

boolean isBVSGE ( )
inline

Indicates whether the term is a signed bit-vector greater-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 932 of file Expr.java.

◆ isBVSGT()

boolean isBVSGT ( )
inline

Indicates whether the term is a signed bit-vector greater-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 972 of file Expr.java.

◆ isBVShiftLeft()

boolean isBVShiftLeft ( )
inline

Indicates whether the term is a bit-vector shift left

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1132 of file Expr.java.

◆ isBVShiftRightArithmetic()

boolean isBVShiftRightArithmetic ( )
inline

Indicates whether the term is a bit-vector arithmetic shift left

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1152 of file Expr.java.

◆ isBVShiftRightLogical()

boolean isBVShiftRightLogical ( )
inline

Indicates whether the term is a bit-vector logical shift right

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1142 of file Expr.java.

◆ isBVSignExtension()

boolean isBVSignExtension ( )
inline

Indicates whether the term is a bit-vector sign extension

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1062 of file Expr.java.

◆ isBVSLE()

boolean isBVSLE ( )
inline

Indicates whether the term is a signed bit-vector less-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 911 of file Expr.java.

◆ isBVSLT()

boolean isBVSLT ( )
inline

Indicates whether the term is a signed bit-vector less-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 952 of file Expr.java.

◆ isBVSMod()

boolean isBVSMod ( )
inline

Indicates whether the term is a bit-vector signed modulus

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 841 of file Expr.java.

◆ isBVSRem()

boolean isBVSRem ( )
inline

Indicates whether the term is a bit-vector signed remainder (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 821 of file Expr.java.

◆ isBVSub()

boolean isBVSub ( )
inline

Indicates whether the term is a bit-vector subtraction (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 781 of file Expr.java.

◆ isBVToInt()

boolean isBVToInt ( )
inline

Indicates whether the term is a coercion from bit-vector to integer

Remarks: This function is not supported by the decision procedures. Only * the most rudimentary simplification rules are applied to this * function.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1220 of file Expr.java.

◆ isBVUDiv()

boolean isBVUDiv ( )
inline

Indicates whether the term is a bit-vector unsigned division (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 811 of file Expr.java.

◆ isBVUGE()

boolean isBVUGE ( )
inline

Indicates whether the term is an unsigned bit-vector greater-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 922 of file Expr.java.

◆ isBVUGT()

boolean isBVUGT ( )
inline

Indicates whether the term is an unsigned bit-vector greater-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 962 of file Expr.java.

◆ isBVULE()

boolean isBVULE ( )
inline

Indicates whether the term is an unsigned bit-vector less-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 901 of file Expr.java.

◆ isBVULT()

boolean isBVULT ( )
inline

Indicates whether the term is an unsigned bit-vector less-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 942 of file Expr.java.

◆ isBVUMinus()

boolean isBVUMinus ( )
inline

Indicates whether the term is a bit-vector unary minus

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 761 of file Expr.java.

◆ isBVURem()

boolean isBVURem ( )
inline

Indicates whether the term is a bit-vector unsigned remainder (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 831 of file Expr.java.

◆ isBVXNOR()

boolean isBVXNOR ( )
inline

Indicates whether the term is a bit-wise XNOR

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1042 of file Expr.java.

◆ isBVXOR()

boolean isBVXOR ( )
inline

Indicates whether the term is a bit-wise XOR

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1012 of file Expr.java.

◆ isBVXOR3()

boolean isBVXOR3 ( )
inline

Indicates whether the term is a bit-vector ternary XOR Remarks: The * meaning is given by the equivalence (xor3 l1 l2 l3) <=> (xor (xor * l1 l2) l3)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1242 of file Expr.java.

◆ isBVZeroExtension()

boolean isBVZeroExtension ( )
inline

Indicates whether the term is a bit-vector zero extension

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1072 of file Expr.java.

◆ isConcat()

boolean isConcat ( )
inline

TBD: sketch for #2522, 'Pointer' seems deprecated and instead approach seems to be around Set/Get CharArrayRegion and updating Native.cpp code generation to produce the char[].

public char[] getNativeString() { Native.IntPtr len = new Native.IntPtr(); long s = Native.getLstring(getContext().nCtx(), getNativeObject(), len); char[] result = new char[len.value]; Pointer ptr = Pointer.createConstant(s); for (int i = 0; i < len.value; ++i) result[i] = ptr.getChar(i); return result; } Check whether expression is a concatenation

Returns
a boolean

Definition at line 1313 of file Expr.java.

◆ isConst()

boolean isConst ( )
inline

Indicates whether the term represents a constant.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 246 of file Expr.java.

247 {
248 return isApp() && getNumArgs() == 0 && getFuncDecl().getDomainSize() == 0;
249 }

◆ isConstantArray()

boolean isConstantArray ( )
inline

Indicates whether the term is a constant array. Remarks: For example, * select(const(v),i) = v holds for every v and i. The function is * unary.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 625 of file Expr.java.

◆ isDefaultArray()

boolean isDefaultArray ( )
inline

Indicates whether the term is a default array. Remarks: For example default(const(v)) = v. The function is unary.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 636 of file Expr.java.

◆ isDistinct()

boolean isDistinct ( )
inline

Indicates whether the term is an n-ary distinct predicate (every argument is mutually distinct).

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 329 of file Expr.java.

◆ isDiv()

boolean isDiv ( )
inline

Indicates whether the term is division (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 520 of file Expr.java.

◆ isEmptyRelation()

boolean isEmptyRelation ( )
inline

Indicates whether the term is an empty relation

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1893 of file Expr.java.

◆ isEq()

boolean isEq ( )
inline

Indicates whether the term is an equality predicate.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 318 of file Expr.java.

◆ isFalse()

boolean isFalse ( )
inline

Indicates whether the term is the constant false.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 308 of file Expr.java.

◆ isFiniteDomain()

boolean isFiniteDomain ( )
inline

Indicates whether the term is of an array sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 2047 of file Expr.java.

2048 {
2049 return (Native.isApp(getContext().nCtx(), getNativeObject()) && Native
2050 .getSortKind(getContext().nCtx(),
2051 Native.getSort(getContext().nCtx(), getNativeObject())) == Z3_sort_kind.Z3_FINITE_DOMAIN_SORT
2052 .toInt());
2053 }

◆ isFiniteDomainLT()

boolean isFiniteDomainLT ( )
inline

Indicates whether the term is a less than predicate over a finite domain.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 2060 of file Expr.java.

◆ isGE()

boolean isGE ( )
inline

Indicates whether the term is a greater-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 450 of file Expr.java.

◆ isGT()

boolean isGT ( )
inline

Indicates whether the term is a greater-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 470 of file Expr.java.

◆ isIDiv()

boolean isIDiv ( )
inline

Indicates whether the term is integer division (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 530 of file Expr.java.

◆ isIff()

boolean isIff ( )
inline

Indicates whether the term is an if-and-only-if (Boolean equivalence, binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 370 of file Expr.java.

◆ isImplies()

boolean isImplies ( )
inline

Indicates whether the term is an implication

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 400 of file Expr.java.

◆ isInt()

boolean isInt ( )
inline

Indicates whether the term is of integer sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 410 of file Expr.java.

411 {
412 return Native.getSortKind(getContext().nCtx(), Native.getSort(getContext().nCtx(), getNativeObject())) == Z3_sort_kind.Z3_INT_SORT.toInt();
413 }

Referenced by Expr.isIntNum().

◆ isIntNum()

boolean isIntNum ( )
inline

Indicates whether the term is an integer numeral.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 256 of file Expr.java.

257 {
258 return isNumeral() && isInt();
259 }
boolean isInt()
Definition: Expr.java:410
boolean isNumeral()
Definition: Expr.java:214

◆ isIntToBV()

boolean isIntToBV ( )
inline

Indicates whether the term is a coercion from integer to bit-vector

Remarks: This function is not supported by the decision procedures. Only * the most rudimentary simplification rules are applied to this * function.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1208 of file Expr.java.

◆ isIntToReal()

boolean isIntToReal ( )
inline

Indicates whether the term is a coercion of integer to real (unary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 560 of file Expr.java.

◆ isIsEmptyRelation()

boolean isIsEmptyRelation ( )
inline

Indicates whether the term is a test for the emptiness of a relation

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1903 of file Expr.java.

◆ isITE()

boolean isITE ( )
inline

Indicates whether the term is a ternary if-then-else term

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 339 of file Expr.java.

◆ isLabel()

boolean isLabel ( )
inline

Indicates whether the term is a label (used by the Boogie Verification condition generator). Remarks: The label has two parameters, a string and a Boolean polarity. It takes one argument, a formula.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1255 of file Expr.java.

◆ isLabelLit()

boolean isLabelLit ( )
inline

Indicates whether the term is a label literal (used by the Boogie Verification condition generator). Remarks: A label literal has a set of string parameters. It takes no arguments.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1268 of file Expr.java.

◆ isLE()

boolean isLE ( )
inline

Indicates whether the term is a less-than-or-equal

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 440 of file Expr.java.

◆ isLT()

boolean isLT ( )
inline

Indicates whether the term is a less-than

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 460 of file Expr.java.

◆ isModulus()

boolean isModulus ( )
inline

Indicates whether the term is modulus (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 550 of file Expr.java.

◆ isMul()

boolean isMul ( )
inline

Indicates whether the term is multiplication (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 510 of file Expr.java.

◆ isNot()

boolean isNot ( )
inline

Indicates whether the term is a negation

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 390 of file Expr.java.

◆ isNumeral()

boolean isNumeral ( )
inline

Indicates whether the term is a numeral

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 214 of file Expr.java.

215 {
216 return Native.isNumeralAst(getContext().nCtx(), getNativeObject());
217 }

Referenced by Expr.isIntNum(), and Expr.isRatNum().

◆ isOEQ()

boolean isOEQ ( )
inline

Indicates whether the term is a binary equivalence modulo namings. Remarks: This binary predicate is used in proof terms. It captures equisatisfiability and equivalence modulo renamings.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1325 of file Expr.java.

◆ isOr()

boolean isOr ( )
inline

Indicates whether the term is an n-ary disjunction

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 359 of file Expr.java.

◆ isProofAndElimination()

boolean isProofAndElimination ( )
inline

Indicates whether the term is a proof by elimination of AND Remarks: * Given a proof for (and l_1 ... l_n), produces a proof for l_i T1: (and * l_1 ... l_n) [and-elim T1]: l_i

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1485 of file Expr.java.

◆ isProofApplyDef()

boolean isProofApplyDef ( )
inline

Indicates whether the term is a proof for application of a definition Remarks: [apply-def T1]: F ~ n F is 'equivalent' to n, given that T1 is a proof that n is a name for F.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1744 of file Expr.java.

◆ isProofAsserted()

boolean isProofAsserted ( )
inline

Indicates whether the term is a proof for a fact asserted by the user.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1345 of file Expr.java.

◆ isProofCommutativity()

boolean isProofCommutativity ( )
inline

Indicates whether the term is a proof by commutativity Remarks: [comm]: (= (f a b) (f b a))

f is a commutative operator.

This proof object has no antecedents. Remark: if f is bool, then = is iff.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1683 of file Expr.java.

◆ isProofDefAxiom()

boolean isProofDefAxiom ( )
inline

Indicates whether the term is a proof for Tseitin-like axioms Remarks: Proof object used to justify Tseitin's like axioms:

(or (not (and p q)) p) (or (not (and p q)) q) (or (not (and p q r)) p) (or (not (and p q r)) q) (or (not (and p q r)) r) ... (or (and p q) (not p) (not q)) (or (not (or p q)) p q) (or (or p q) (not p)) (or (or p q) (not q)) (or (not (iff p q)) (not p) q) (or (not (iff p q)) p (not q)) (or (iff p q) (not p) (not q)) (or (iff p q) p q) (or (not (ite a b c)) (not a) b) (or (not (ite a b c)) a c) (or (ite a b c) (not a) (not b)) (or (ite a b c) a (not c)) (or (not (not a)) (not a)) (or (not a) a)

This proof object has no antecedents. Note: all axioms are propositional tautologies. Note also that 'and' and 'or' can take multiple arguments. You can recover the propositional tautologies by unfolding the Boolean connectives in the axioms a small bounded number of steps (=3).

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1709 of file Expr.java.

◆ isProofDefIntro()

boolean isProofDefIntro ( )
inline

Indicates whether the term is a proof for introduction of a name Remarks: Introduces a name for a formula/term. Suppose e is an expression with free variables x, and def-intro introduces the name n(x). The possible cases are:

When e is of Boolean type: [def-intro]: (and (or n (not e)) (or (not n) e))

or: [def-intro]: (or (not n) e) when e only occurs positively.

When e is of the form (ite cond th el): [def-intro]: (and (or (not cond) (= n th)) (or cond (= n el)))

Otherwise: [def-intro]: (= n e)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1732 of file Expr.java.

◆ isProofDER()

boolean isProofDER ( )
inline

Indicates whether the term is a proof for destructive equality resolution Remarks: A proof for destructive equality resolution: (iff (forall (x) (or (not (= x t)) P[x])) P[t]) if x does not occur in t.

This proof object has no antecedents.

Several variables can be eliminated simultaneously.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1591 of file Expr.java.

◆ isProofDistributivity()

boolean isProofDistributivity ( )
inline

Indicates whether the term is a distributivity proof object. Remarks: Given that f (= or) distributes over g (= and), produces a proof for (= (f a (g c d)) (g (f a c) (f a d))) If f and g are associative, this proof also justifies the following equality: (= (f (g a b) (g c d)) (g (f a c) (f a d) (f b c) (f b d))) where each f and g can have arbitrary number of arguments.

This proof object has no antecedents. Remark. This rule is used by the CNF conversion pass and instantiated by f = or, and g = and.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1474 of file Expr.java.

◆ isProofElimUnusedVars()

boolean isProofElimUnusedVars ( )
inline

Indicates whether the term is a proof for elimination of unused variables. Remarks: A proof for (iff (forall (x_1 ... x_n y_1 ... y_m) p[x_1 ... x_n]) (forall (x_1 ... x_n) p[x_1 ... x_n]))

It is used to justify the elimination of unused variables. This proof object has no antecedents.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1575 of file Expr.java.

◆ isProofGoal()

boolean isProofGoal ( )
inline

Indicates whether the term is a proof for a fact (tagged as goal) asserted by the user.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1356 of file Expr.java.

◆ isProofHypothesis()

boolean isProofHypothesis ( )
inline

Indicates whether the term is a hypothesis marker. Remarks: Mark a hypothesis in a natural deduction style proof.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1615 of file Expr.java.

◆ isProofIFFFalse()

boolean isProofIFFFalse ( )
inline

Indicates whether the term is a proof by iff-false Remarks: T1: (not p) [iff-false T1]: (iff p false)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1666 of file Expr.java.

◆ isProofIFFOEQ()

boolean isProofIFFOEQ ( )
inline

Indicates whether the term is a proof iff-oeq Remarks: T1: (iff p q) [iff~ T1]: (~ p q)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1756 of file Expr.java.

◆ isProofIFFTrue()

boolean isProofIFFTrue ( )
inline

Indicates whether the term is a proof by iff-true Remarks: T1: p [iff-true T1]: (iff p true)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1654 of file Expr.java.

◆ isProofLemma()

boolean isProofLemma ( )
inline

Indicates whether the term is a proof by lemma Remarks: T1: false [lemma T1]: (or (not l_1) ... (not l_n))

This proof object has one antecedent: a hypothetical proof for false. It converts the proof in a proof for (or (not l_1) ... (not l_n)), when T1 contains the hypotheses: l_1, ..., l_n.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1631 of file Expr.java.

◆ isProofModusPonens()

boolean isProofModusPonens ( )
inline

Indicates whether the term is proof via modus ponens Remarks: Given a proof for p and a proof for (implies p q), produces a proof for q. T1: p T2: (implies p q) [mp T1 T2]: q The second antecedents may also be a proof for (iff p q).

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1370 of file Expr.java.

◆ isProofModusPonensOEQ()

boolean isProofModusPonensOEQ ( )
inline

Indicates whether the term is a proof by modus ponens for equi-satisfiability. Remarks: Modus ponens style rule for equi-satisfiability. T1: p T2: (~ p q) [mp~ T1 T2]: q

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1834 of file Expr.java.

◆ isProofMonotonicity()

boolean isProofMonotonicity ( )
inline

Indicates whether the term is a monotonicity proof object. Remarks: T1: (R t_1 s_1) ... Tn: (R t_n s_n) [monotonicity T1 ... Tn]: (R (f t_1 ... t_n) (f s_1 ... s_n)) Remark: if t_i == s_i, then the antecedent Ti is suppressed. That is, reflexivity proofs are suppressed to save space.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1444 of file Expr.java.

◆ isProofNNFNeg()

boolean isProofNNFNeg ( )
inline

Indicates whether the term is a proof for a negative NNF step Remarks: Proof for a (negative) NNF step. Examples:

T1: (not s_1) ~ r_1 ... Tn: (not s_n) ~ r_n [nnf-neg T1 ... Tn]: (not (and s_1 ... s_n)) ~ (or r_1 ... r_n) and T1: (not s_1) ~ r_1 ... Tn: (not s_n) ~ r_n [nnf-neg T1 ... Tn]: (not (or s_1 ... s_n)) ~ (and r_1 ... r_n) and T1: (not s_1) ~ r_1 T2: (not s_2) ~ r_2 T3: s_1 ~ r_1' T4: s_2 ~ r_2' [nnf-neg T1 T2 T3 T4]: (~ (not (iff s_1 s_2)) (and (or r_1 r_2) (or r_1' r_2')))

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1803 of file Expr.java.

◆ isProofNNFPos()

boolean isProofNNFPos ( )
inline

Indicates whether the term is a proof for a positive NNF step Remarks: Proof for a (positive) NNF step. Example:

T1: (not s_1) ~ r_1 T2: (not s_2) ~ r_2 T3: s_1 ~ r_1' T4: s_2 ~ r_2'

r_2)))

The negation normal form steps NNF_POS and NNF_NEG are used in the following cases: (a) When creating the NNF of a positive force quantifier. The quantifier is retained (unless the bound variables are eliminated). Example T1: q ~ q_new [nnf-pos T1]: (~ (forall (x T) q) (forall (x T) q_new))

(b) When recursively creating NNF over Boolean formulas, where the top-level connective is changed during NNF conversion. The relevant Boolean connectives for NNF_POS are 'implies', 'iff', 'xor', 'ite'. NNF_NEG furthermore handles the case where negation is pushed over Boolean connectives 'and' and 'or'.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1784 of file Expr.java.

◆ isProofOrElimination()

boolean isProofOrElimination ( )
inline

Indicates whether the term is a proof by elimination of not-or Remarks: * Given a proof for (not (or l_1 ... l_n)), produces a proof for (not l_i). * T1: (not (or l_1 ... l_n)) [not-or-elim T1]: (not l_i)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1496 of file Expr.java.

◆ isProofPullQuant()

boolean isProofPullQuant ( )
inline

Indicates whether the term is a proof for pulling quantifiers out. Remarks: A proof for (iff (f (forall (x) q(x)) r) (forall (x) (f (q x) r))). This proof object has no antecedents.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1544 of file Expr.java.

◆ isProofPushQuant()

boolean isProofPushQuant ( )
inline

Indicates whether the term is a proof for pushing quantifiers in. Remarks: A proof for: (iff (forall (x_1 ... x_m) (and p_1[x_1 ... x_m] ... p_n[x_1 ... x_m])) (and (forall (x_1 ... x_m) p_1[x_1 ... x_m]) ... (forall (x_1 ... x_m) p_n[x_1 ... x_m]))) This proof object has no antecedents

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1559 of file Expr.java.

◆ isProofQuantInst()

boolean isProofQuantInst ( )
inline

Indicates whether the term is a proof for quantifier instantiation

Remarks: A proof of (or (not (forall (x) (P x))) (P a))

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1603 of file Expr.java.

◆ isProofQuantIntro()

boolean isProofQuantIntro ( )
inline

Indicates whether the term is a quant-intro proof Remarks: Given a proof * for (~ p q), produces a proof for (~ (forall (x) p) (forall (x) q)). T1: * (~ p q) [quant-intro T1]: (~ (forall (x) p) (forall (x) q))

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1455 of file Expr.java.

◆ isProofReflexivity()

boolean isProofReflexivity ( )
inline

Indicates whether the term is a proof for (R t t), where R is a reflexive relation. Remarks: This proof object has no antecedents. The only reflexive relations that are used are equivalence modulo namings, equality and equivalence. That is, R is either '~', '=' or 'iff'.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1385 of file Expr.java.

◆ isProofRewrite()

boolean isProofRewrite ( )
inline

Indicates whether the term is a proof by rewriting Remarks: A proof for a local rewriting step (= t s). The head function symbol of t is interpreted.

This proof object has no antecedents. The conclusion of a rewrite rule is either an equality (= t s), an equivalence (iff t s), or equi-satisfiability (~ t s). Remark: if f is bool, then = is iff.

Examples: (= (+ x 0) x) (= (+ x 1 2) (+ 3 x)) (iff (or x false) x)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1516 of file Expr.java.

◆ isProofRewriteStar()

boolean isProofRewriteStar ( )
inline

Indicates whether the term is a proof by rewriting Remarks: A proof for rewriting an expression t into an expression s. This proof object can have n antecedents. The antecedents are proofs for equalities used as substitution rules. The object is used in a few cases . The cases are: - When applying contextual simplification (CONTEXT_SIMPLIFIER=true) - When converting bit-vectors to Booleans (BIT2BOOL=true)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1532 of file Expr.java.

◆ isProofSkolemize()

boolean isProofSkolemize ( )
inline

Indicates whether the term is a proof for a Skolemization step Remarks: Proof for:

(p x y)) (p (sk y) y))

This proof object has no antecedents.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1821 of file Expr.java.

◆ isProofSymmetry()

boolean isProofSymmetry ( )
inline

Indicates whether the term is proof by symmetricity of a relation

Remarks: Given an symmetric relation R and a proof for (R t s), produces * a proof for (R s t). T1: (R t s) [symmetry T1]: (R s t) T1 is the * antecedent of this proof object.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1397 of file Expr.java.

◆ isProofTheoryLemma()

boolean isProofTheoryLemma ( )
inline

Indicates whether the term is a proof for theory lemma Remarks: Generic proof for theory lemmas.

The theory lemma function comes with one or more parameters. The first parameter indicates the name of the theory. For the theory of arithmetic, additional parameters provide hints for checking the theory lemma. The hints for arithmetic are: - farkas - followed by rational coefficients. Multiply the coefficients to the inequalities in the lemma, add the (negated) inequalities and obtain a contradiction. - triangle-eq - Indicates a lemma related to the equivalence: (iff (= t1 t2) (and (<= t1 t2) (<= t2 t1))) - gcd-test - Indicates an integer linear arithmetic lemma that uses a gcd test.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1856 of file Expr.java.

◆ isProofTransitivity()

boolean isProofTransitivity ( )
inline

Indicates whether the term is a proof by transitivity of a relation

Remarks: Given a transitive relation R, and proofs for (R t s) and (R s * u), produces a proof for (R t u). T1: (R t s) T2: (R s u) [trans T1 T2]: * (R t u)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1409 of file Expr.java.

◆ isProofTransitivityStar()

boolean isProofTransitivityStar ( )
inline

Indicates whether the term is a proof by condensed transitivity of a relation Remarks: Condensed transitivity proof. It combines several symmetry and transitivity proofs. Example: T1: (R a b) T2: (R c b) T3: (R c d) [trans* T1 T2 T3]: (R a d) R must be a symmetric and transitive relation.

Assuming that this proof object is a proof for (R s t), then a proof checker must check if it is possible to prove (R s t) using the antecedents, symmetry and transitivity. That is, if there is a path from s to t, if we view every antecedent (R a b) as an edge between a and b.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1429 of file Expr.java.

◆ isProofTrue()

boolean isProofTrue ( )
inline

Indicates whether the term is a Proof for the expression 'true'.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1335 of file Expr.java.

◆ isProofUnitResolution()

boolean isProofUnitResolution ( )
inline

Indicates whether the term is a proof by unit resolution Remarks: T1: * (or l_1 ... l_n l_1' ... l_m') T2: (not l_1) ... T(n+1): (not l_n) * [unit-resolution T1 ... T(n+1)]: (or l_1' ... l_m')

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1642 of file Expr.java.

◆ isRatNum()

boolean isRatNum ( )
inline

Indicates whether the term is a real numeral.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 266 of file Expr.java.

267 {
268 return isNumeral() && isReal();
269 }
boolean isReal()
Definition: Expr.java:420

◆ isReal()

boolean isReal ( )
inline

Indicates whether the term is of sort real.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 420 of file Expr.java.

421 {
422 return Native.getSortKind(getContext().nCtx(), Native.getSort(getContext().nCtx(), getNativeObject())) == Z3_sort_kind.Z3_REAL_SORT.toInt();
423 }

Referenced by Expr.isRatNum().

◆ isRealIsInt()

boolean isRealIsInt ( )
inline

Indicates whether the term is a check that tests whether a real is integral (unary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 581 of file Expr.java.

◆ isRealToInt()

boolean isRealToInt ( )
inline

Indicates whether the term is a coercion of real to integer (unary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 570 of file Expr.java.

◆ isRelation()

boolean isRelation ( )
inline

Indicates whether the term is of an array sort.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1866 of file Expr.java.

1867 {
1868 return (Native.isApp(getContext().nCtx(), getNativeObject()) && Native
1869 .getSortKind(getContext().nCtx(),
1870 Native.getSort(getContext().nCtx(), getNativeObject())) == Z3_sort_kind.Z3_RELATION_SORT
1871 .toInt());
1872 }

◆ isRelationalJoin()

boolean isRelationalJoin ( )
inline

Indicates whether the term is a relational join

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1913 of file Expr.java.

◆ isRelationClone()

boolean isRelationClone ( )
inline

Indicates whether the term is a relational clone (copy) Remarks: Create a fresh copy (clone) of a relation. The function is logically the identity, but in the context of a register machine allows for terms of kind isRelationUnion to perform destructive updates to the first argument.

See also
isRelationUnion
Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 2037 of file Expr.java.

◆ isRelationComplement()

boolean isRelationComplement ( )
inline

Indicates whether the term is the complement of a relation

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 2007 of file Expr.java.

◆ isRelationFilter()

boolean isRelationFilter ( )
inline

Indicates whether the term is a relation filter Remarks: Filter (restrict) a relation with respect to a predicate. The first argument is a relation. The second argument is a predicate with free de-Bruijn indices corresponding to the columns of the relation. So the first column in the relation has index 0.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1965 of file Expr.java.

◆ isRelationNegationFilter()

boolean isRelationNegationFilter ( )
inline

Indicates whether the term is an intersection of a relation with the negation of another. Remarks: Intersect the first relation with respect to negation of the second relation (the function takes two arguments). Logically, the specification can be described by a function

target = filter_by_negation(pos, neg, columns)

where columns are pairs c1, d1, .., cN, dN of columns from pos and neg, such that target are elements in x in pos, such that there is no y in neg that agrees with x on the columns c1, d1, .., cN, dN.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1985 of file Expr.java.

◆ isRelationProject()

boolean isRelationProject ( )
inline

Indicates whether the term is a projection of columns (provided as numbers in the parameters). Remarks: The function takes one argument.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1950 of file Expr.java.

◆ isRelationRename()

boolean isRelationRename ( )
inline

Indicates whether the term is the renaming of a column in a relation Remarks: The function takes one argument. The parameters contain the renaming as a cycle.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1997 of file Expr.java.

◆ isRelationSelect()

boolean isRelationSelect ( )
inline

Indicates whether the term is a relational select Remarks: Check if a record is an element of the relation. The function takes n+1 arguments, where the first argument is a relation, and the remaining n arguments correspond to a record.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 2021 of file Expr.java.

◆ isRelationStore()

boolean isRelationStore ( )
inline

Indicates whether the term is an relation store Remarks: Insert a record into a relation. The function takes n+1 arguments, where the first argument is the relation and the remaining n elements correspond to the n columns of the relation.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1883 of file Expr.java.

◆ isRelationUnion()

boolean isRelationUnion ( )
inline

Indicates whether the term is the union or convex hull of two relations.

Remarks: The function takes two arguments.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1925 of file Expr.java.

◆ isRelationWiden()

boolean isRelationWiden ( )
inline

Indicates whether the term is the widening of two relations Remarks: The function takes two arguments.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 1937 of file Expr.java.

◆ isRemainder()

boolean isRemainder ( )
inline

Indicates whether the term is remainder (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 540 of file Expr.java.

◆ isSelect()

boolean isSelect ( )
inline

Indicates whether the term is an array select.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 614 of file Expr.java.

◆ isSetComplement()

boolean isSetComplement ( )
inline

Indicates whether the term is set complement

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 699 of file Expr.java.

◆ isSetDifference()

boolean isSetDifference ( )
inline

Indicates whether the term is set difference

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 689 of file Expr.java.

◆ isSetIntersect()

boolean isSetIntersect ( )
inline

Indicates whether the term is set intersection

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 679 of file Expr.java.

◆ isSetSubset()

boolean isSetSubset ( )
inline

Indicates whether the term is set subset

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 709 of file Expr.java.

◆ isSetUnion()

boolean isSetUnion ( )
inline

Indicates whether the term is set union

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 669 of file Expr.java.

◆ isStore()

boolean isStore ( )
inline

Indicates whether the term is an array store. Remarks: It satisfies * select(store(a,i,v),j) = if i = j then v else select(a,j). Array store * takes at least 3 arguments.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 604 of file Expr.java.

◆ isString()

boolean isString ( )
inline

Check whether expression is a string constant.

Returns
a boolean

Definition at line 1277 of file Expr.java.

1278 {
1279 return isApp() && Native.isString(getContext().nCtx(), getNativeObject());
1280 }

◆ isSub()

boolean isSub ( )
inline

Indicates whether the term is subtraction (binary)

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 490 of file Expr.java.

◆ isTrue()

boolean isTrue ( )
inline

Indicates whether the term is the constant true.

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 298 of file Expr.java.

◆ isUMinus()

boolean isUMinus ( )
inline

Indicates whether the term is a unary minus

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 500 of file Expr.java.

◆ isWellSorted()

boolean isWellSorted ( )
inline

Indicates whether the term is well-sorted.

Exceptions
Z3Exceptionon error
Returns
True if the term is well-sorted, false otherwise.

Definition at line 225 of file Expr.java.

226 {
227 return Native.isWellSorted(getContext().nCtx(), getNativeObject());
228 }

◆ isXor()

boolean isXor ( )
inline

Indicates whether the term is an exclusive or

Exceptions
Z3Exceptionon error
Returns
a boolean

Definition at line 380 of file Expr.java.

◆ simplify() [1/2]

Expr simplify ( )
inline

Returns a simplified version of the expression

Returns
Expr
Exceptions
Z3Exceptionon error

Definition at line 37 of file Expr.java.

38 {
39 return simplify(null);
40 }

Referenced by Expr.simplify().

◆ simplify() [2/2]

Expr simplify ( Params  p)
inline

Returns a simplified version of the expression A set of parameters

Parameters
pa Params object to configure the simplifier
See also
Context::SimplifyHelp
Returns
an Expr
Exceptions
Z3Exceptionon error

Definition at line 51 of file Expr.java.

52 {
53
54 if (p == null) {
55 return Expr.create(getContext(),
56 Native.simplify(getContext().nCtx(), getNativeObject()));
57 }
58 else {
59 return Expr.create(
60 getContext(),
61 Native.simplifyEx(getContext().nCtx(), getNativeObject(),
62 p.getNativeObject()));
63 }
64 }

◆ substitute() [1/2]

Expr substitute ( Expr  from,
Expr  to 
)
inline

Substitute every occurrence of from in the expression with to.

See also
Expr::substitute(Expr[],Expr[])
Exceptions
Z3Exceptionon error
Returns
an Expr

Definition at line 164 of file Expr.java.

165 {
166 return substitute(new Expr[] { from }, new Expr[] { to });
167 }
Expr substitute(Expr[] from, Expr[] to)
Definition: Expr.java:145

◆ substitute() [2/2]

Expr substitute ( Expr[]  from,
Expr[]  to 
)
inline

Substitute every occurrence of from[i] in the expression with to[i], for i smaller than num_exprs. Remarks: The result is the new expression. The arrays from and to must have size num_exprs. For every i smaller than num_exprs, we must have that sort of from[i] must be equal to sort of to[i].

Exceptions
Z3Exceptionon error
Returns
an Expr

Definition at line 145 of file Expr.java.

146 {
147 getContext().checkContextMatch(from);
148 getContext().checkContextMatch(to);
149 if (from.length != to.length) {
150 throw new Z3Exception("Argument sizes do not match");
151 }
152 return Expr.create(getContext(), Native.substitute(getContext().nCtx(),
153 getNativeObject(), from.length, Expr.arrayToNative(from),
154 Expr.arrayToNative(to)));
155 }

Referenced by Expr.substitute().

◆ substituteVars()

Expr substituteVars ( Expr[]  to)
inline

Substitute the free variables in the expression with the expressions in to Remarks: For every i smaller than * num_exprs, the variable with de-Bruijn index i * is replaced with term to[i].

Exceptions
Z3Exceptionon error
Z3Exceptionon error
Returns
an Expr

Definition at line 179 of file Expr.java.

180 {
181
182 getContext().checkContextMatch(to);
183 return Expr.create(getContext(), Native.substituteVars(getContext().nCtx(),
184 getNativeObject(), to.length, Expr.arrayToNative(to)));
185 }

◆ toString()

String toString ( )
inline

Returns a string representation of the expression.

Reimplemented from AST.

Reimplemented in BitVecNum, FiniteDomainNum, FPNum, IntNum, and RatNum.

Definition at line 204 of file Expr.java.

205 {
206 return super.toString();
207 }

◆ translate()

Expr translate ( Context  ctx)
inline

Translates (copies) the term to the Context ctx.

Parameters
ctxA context
Returns
A copy of the term which is associated with ctx
Exceptions
Z3Exceptionon error

Reimplemented from AST.

Reimplemented in Lambda, and Quantifier.

Definition at line 195 of file Expr.java.

196 {
197 return (Expr) super.translate(ctx);
198 }

Referenced by AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Solver.__deepcopy__(), and Expr.translate().

◆ update()

Expr update ( Expr[]  args)
inline

Update the arguments of the expression using the arguments args The number of new arguments should coincide with the current number of arguments.

Parameters
argsarguments
Exceptions
Z3Exceptionon error

Definition at line 123 of file Expr.java.

124 {
125 getContext().checkContextMatch(args);
126 if (isApp() && args.length != getNumArgs()) {
127 throw new Z3Exception("Number of arguments does not match");
128 }
129 return Expr.create(getContext(), Native.updateTerm(getContext().nCtx(), getNativeObject(),
130 args.length, Expr.arrayToNative(args)));
131 }