Package org.sosy_lab.java_smt.api

Interface Model

All Superinterfaces:

AutoCloseable, Iterable<Model.ValueAssignment>

All Known Implementing Classes:

AbstractModel, AbstractModel.CachingAbstractModel

public interface Model
extends Iterable<Model.ValueAssignment>, AutoCloseable

A model returned from the satisfiable solver environment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Model.ValueAssignment

Method Summary

Modifier and Type	Method	Description
ImmutableList<Model.ValueAssignment>	asList()	Build a list of assignments that stays valid after closing the model.
void	close()	Free resources associated with this model (existing Model.ValueAssignment instances stay valid, but evaluate(Formula) etc.
<T extends Formula> @Nullable T	eval(T formula)	Evaluate a given formula substituting the values from the model and return it as formula.
@Nullable BigInteger	evaluate(BitvectorFormula f)	Type-safe evaluation for bitvector formulas.
@Nullable Boolean	evaluate(BooleanFormula f)	Type-safe evaluation for boolean formulas.
@Nullable Object	evaluate(Formula f)	Evaluate a given formula substituting the values from the model.
@Nullable BigInteger	evaluate(NumeralFormula.IntegerFormula f)	Type-safe evaluation for integer formulas.
@Nullable Rational	evaluate(NumeralFormula.RationalFormula f)	Type-safe evaluation for rational formulas.
@Nullable String	evaluate(StringFormula f)	Type-safe evaluation for string formulas.
default Iterator<Model.ValueAssignment>	iterator()	Iterate over all values present in the model.
String	toString()	Pretty-printing of the model values.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

eval

<T extends Formula> @Nullable T eval(T formula)

Evaluate a given formula substituting the values from the model and return it as formula.

If a value is not relevant to the satisfiability result, the solver can choose either to insert an arbitrary value (e.g., the value 0 for the matching type) or just return null.

The formula does not need to be a variable, we also allow complex expression. The solver will replace all symbols from the formula with their model values and then simplify the formula into a simple formula, e.g., consisting only of a numeral expression.

Parameters:

formula - Input formula to be evaluated.

Returns:

evaluation of the given formula or null if the solver does not provide a better evaluation.

evaluate

@Nullable Object evaluate(Formula f)

Evaluate a given formula substituting the values from the model.

If a value is not relevant to the satisfiability result, the model can choose either an arbitrary value (e.g., the value 0 for the matching type) or just return null.

The formula does not need to be a variable, we also allow complex expression.

Parameters:

f - Input formula

Returns:

Either of: - Number (Rational/Double/BigInteger/Long/Integer) - Boolean

Throws:

IllegalArgumentException - if a formula has unexpected type, e.g. Array.

evaluate

@Nullable BigInteger evaluate(NumeralFormula.IntegerFormula f)

Type-safe evaluation for integer formulas.

The formula does not need to be a variable, we also allow complex expression.

evaluate

@Nullable Rational evaluate(NumeralFormula.RationalFormula f)

Type-safe evaluation for rational formulas.

The formula does not need to be a variable, we also allow complex expression.

evaluate

@Nullable Boolean evaluate(BooleanFormula f)

Type-safe evaluation for boolean formulas.

The formula does not need to be a variable, we also allow complex expression.

evaluate

@Nullable BigInteger evaluate(BitvectorFormula f)

Type-safe evaluation for bitvector formulas.

The formula does not need to be a variable, we also allow complex expression.

evaluate

@Nullable String evaluate(StringFormula f)

Type-safe evaluation for string formulas.

The formula does not need to be a variable, we also allow complex expression.

iterator

default Iterator<Model.ValueAssignment> iterator()

Iterate over all values present in the model. Note that iterating multiple times may be inefficient for some solvers, it is recommended to use BasicProverEnvironment.getModelAssignments() instead in this case.

The iteration includes value assignments for...

• all relevant free variables of simple type. If a variable is irrelevant for satisfiability, it can be null or missing in the iteration.
• (nested) arrays with all accesses. If an array access is applied within a quantified context, some value assignments can be missing in the iteration. Please use a direct evaluation query to get the evaluation in such a case.
• uninterpreted functions with all applications. If an uninterpreted function is applied within a quantified context, some value assignments can be missing in the iteration. Please use a direct evaluation query to get the evaluation in such a case.

Specified by:

iterator in interface Iterable<Model.ValueAssignment>

asList

ImmutableList<Model.ValueAssignment> asList()

Build a list of assignments that stays valid after closing the model.

toString

String toString()

Pretty-printing of the model values.

Please only use this method for debugging and not for retrieving relevant information about the model. The returned model representation is not intended for further usage like parsing, because we do not guarantee any specific format, e.g., for arrays and uninterpreted functions, and we allow the SMT solver to include arbitrary additional information about the current solver state, e.g., any available symbol in the solver, even from other provers, and temporary internal symbols.

Overrides:

toString in class Object

close

void close()

Free resources associated with this model (existing Model.ValueAssignment instances stay valid, but evaluate(Formula) etc. and iterator() must not be called again).

Specified by:

close in interface AutoCloseable