Package org.sosy_lab.java_smt.api

Interface SolverContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractSolverContext, DebuggingSolverContext, LoggingSolverContext, StatisticsSolverContext, SynchronizedSolverContext

public interface SolverContext
extends AutoCloseable

Instances of this interface provide access to an SMT solver. A single SolverContext should be used only from a single thread.

If you wish to use multiple contexts (even for the same solver), create one SolverContext per each. Formulas can be transferred between different contexts using FormulaManager.translateFrom(BooleanFormula, FormulaManager).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SolverContext.ProverOptions	Options for the prover environment.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the solver context.
FormulaManager	getFormulaManager()	Get the formula manager, which is used for formula manipulation.
SolverContextFactory.Solvers	getSolverName()	Get solver name (MATHSAT5/Z3/etc...).
default ImmutableMap<String,String>	getStatistics()	Get statistics for a complete solver context.
String	getVersion()	Get version information out of the solver.
OptimizationProverEnvironment	newOptimizationProverEnvironment(SolverContext.ProverOptions... options)	Create a fresh new OptimizationProverEnvironment which encapsulates an assertion stack and allows solving optimization queries.
ProverEnvironment	newProverEnvironment(SolverContext.ProverOptions... options)	Create a fresh new ProverEnvironment which encapsulates an assertion stack and can be used to check formulas for unsatisfiability.
InterpolatingProverEnvironment<?>	newProverEnvironmentWithInterpolation(SolverContext.ProverOptions... options)	Create a fresh new InterpolatingProverEnvironment which encapsulates an assertion stack and allows generating and retrieve interpolants for unsatisfiable formulas.

Method Detail

getFormulaManager

FormulaManager getFormulaManager()

Get the formula manager, which is used for formula manipulation.

newProverEnvironment

ProverEnvironment newProverEnvironment(SolverContext.ProverOptions... options)

Create a fresh new ProverEnvironment which encapsulates an assertion stack and can be used to check formulas for unsatisfiability.

Parameters:

options - Options specified for the prover environment. All the options specified in SolverContext.ProverOptions are turned off by default.

newProverEnvironmentWithInterpolation

InterpolatingProverEnvironment<?> newProverEnvironmentWithInterpolation(SolverContext.ProverOptions... options)

Create a fresh new InterpolatingProverEnvironment which encapsulates an assertion stack and allows generating and retrieve interpolants for unsatisfiable formulas. If the SMT solver is able to handle satisfiability tests with assumptions please consider implementing the InterpolatingProverEnvironment interface, and return an Object of this type here.

Parameters:

options - Options specified for the prover environment. All the options specified in SolverContext.ProverOptions are turned off by default.

newOptimizationProverEnvironment

OptimizationProverEnvironment newOptimizationProverEnvironment(SolverContext.ProverOptions... options)

Create a fresh new OptimizationProverEnvironment which encapsulates an assertion stack and allows solving optimization queries.

Parameters:

options - Options specified for the prover environment. All the options specified in SolverContext.ProverOptions are turned off by default.

getVersion

String getVersion()

Get version information out of the solver.

In most cases, the version contains the name of the solver followed by some numbers and additional info about the version, e.g., "SMTInterpol 2.5-12-g3d15a15c".

getSolverName

SolverContextFactory.Solvers getSolverName()

Get solver name (MATHSAT5/Z3/etc...).

This is an uppercase String matching the enum identifier from SolverContextFactory.Solvers

getStatistics

default ImmutableMap<String,String> getStatistics()

Get statistics for a complete solver context. The returned mapping is intended to provide the solver-internal statistics. The keys can differ between individual solvers.

Calling the statistics several times for the same context returns accumulated number, i.e., we currently do not provide any possibility to reset the statistics.

We do not guarantee any specific key to be present, as this depends on the used solver. We might even return an empty mapping if the solver does not support calling this method or is in an invalid state.

See Also:

BasicProverEnvironment.getStatistics()

close

void close()

Close the solver context.

After calling this method, further access to any object that had been returned from this context is not wanted, i.e., it depends on the solver. Java-based solvers might wait for the next garbage collection with any cleanup operation. Native solvers might even reference invalid memory and cause segmentation faults.

Necessary for the solvers implemented in native code, frees the associated memory.

Specified by:

close in interface AutoCloseable