org.sosy_lab.solver.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 and Description
static class	Model.ValueAssignment

Method Summary

Modifier and Type	Method and Description
void	close() Free resources associated with this model (existing Model.ValueAssignment instances stay valid, but evaluate(Formula) etc.
BigInteger	evaluate(BitvectorFormula f) Type-safe evaluation for bitvector formulas.
Boolean	evaluate(BooleanFormula f) Type-safe evaluation for boolean formulas.
Object	evaluate(Formula f) Evaluate a given formula substituting the values from the model.
BigInteger	evaluate(NumeralFormula.IntegerFormula f) Type-safe evaluation for integer formulas.
Rational	evaluate(NumeralFormula.RationalFormula f) Type-safe evaluation for rational formulas.
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

evaluate

@Nullable
Object evaluate(Formula f)

Evaluate a given formula substituting the values from the model. Can be absent if the value is not relevant to the satisfiability result.

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.

evaluate

@Nullable
Rational evaluate(NumeralFormula.RationalFormula f)

Type-safe evaluation for rational formulas.

evaluate

@Nullable
Boolean evaluate(BooleanFormula f)

Type-safe evaluation for boolean formulas.

evaluate

@Nullable
BigInteger evaluate(BitvectorFormula f)

Type-safe evaluation for bitvector formulas.

iterator

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.

Specified by:

iterator in interface Iterable<Model.ValueAssignment>

toString

String toString()

Pretty-printing of the model values.

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