org.sosy_lab.solver.basicimpl

Class AbstractFormulaManager<TFormulaInfo,TType,TEnv>

java.lang.Object

org.sosy_lab.solver.basicimpl.AbstractFormulaManager<TFormulaInfo,TType,TEnv>

Type Parameters:

TFormulaInfo - The solver specific type.

All Implemented Interfaces:

FormulaManager

public abstract class AbstractFormulaManager<TFormulaInfo,TType,TEnv>
extends Object
implements FormulaManager

Simplifies building a solver from the specific theories.

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AbstractFormulaManager(FormulaCreator<TFormulaInfo,TType,TEnv> pFormulaCreator, AbstractFunctionFormulaManager<TFormulaInfo,?,TType,TEnv> functionManager, AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv> booleanManager, IntegerFormulaManager pIntegerManager, RationalFormulaManager pRationalManager, AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv> bitvectorManager, AbstractFloatingPointFormulaManager<TFormulaInfo,TType,TEnv> floatingPointManager, AbstractQuantifiedFormulaManager<TFormulaInfo,TType,TEnv> quantifiedManager, AbstractArrayFormulaManager<TFormulaInfo,TType,TEnv> arrayManager) Builds a solver from the given theory implementations

Method Summary

Methods

Modifier and Type	Method and Description
BooleanFormula	applyTactic(BooleanFormula f, Tactic tactic) Apply a tactic which performs formula transformation.
protected TFormulaInfo	applyTacticImpl(TFormulaInfo f, Tactic tactic)
Appender	dumpFormula(BooleanFormula t) Serialize an input formula to an SMT-LIB format.
abstract Appender	dumpFormula(TFormulaInfo t)
TFormulaInfo	extractInfo(Formula f)
Map<String,Formula>	extractVariables(Formula f) Extract names of all free variables in a formula.
Map<String,Formula>	extractVariablesAndUFs(Formula f) Extract the names of all free variables and UFs in a formula.
ArrayFormulaManager	getArrayFormulaManager() Returns the Array-Theory.
AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv>	getBitvectorFormulaManager() Returns the Bitvector-Theory.
AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv>	getBooleanFormulaManager() Returns the Boolean-Theory.
TEnv	getEnvironment()
FloatingPointFormulaManager	getFloatingPointFormulaManager() Returns the Floating-Point-Theory.
FormulaCreator<TFormulaInfo,TType,TEnv>	getFormulaCreator()
<T extends Formula> FormulaType<T>	getFormulaType(T formula) Returns the type of the given Formula.
AbstractFunctionFormulaManager<TFormulaInfo,?,TType,TEnv>	getFunctionFormulaManager() Returns the Function-Theory.
IntegerFormulaManager	getIntegerFormulaManager() Returns the Integer-Theory.
AbstractQuantifiedFormulaManager<TFormulaInfo,TType,TEnv>	getQuantifiedFormulaManager() Returns the interface for handling quantifiers.
RationalFormulaManager	getRationalFormulaManager() Returns the Rational-Theory.
<T extends Formula> BooleanFormula	makeEqual(T pLhs, T pRhs) Create a formula representing equality between two formulas of the same type.
<T extends Formula> T	makeVariable(FormulaType<T> formulaType, String name) Create variable of the type equal to formulaType.
<T extends Formula> T	simplify(T f) Simplify an input formula, while ensuring equivalence.
protected TFormulaInfo	simplify(TFormulaInfo f)
<T extends Formula> List<T>	splitNumeralEqualityIfPossible(T pF) For a numeral (i.e., non-boolean) equality "x = y", return a list x<=y, x>=y.
protected abstract List<? extends TFormulaInfo>	splitNumeralEqualityIfPossible(TFormulaInfo pF)
<T extends Formula> T	substitute(T pF, Map<? extends Formula,? extends Formula> pFromToMapping) Substitute every occurrence of any item from changeFrom in formula f to the corresponding occurrence from changeTo.
protected <T1 extends Formula> T1	substituteUsingLists(T1 pF, Map<? extends Formula,? extends Formula> pFromToMapping) Default implementation for substitute(Formula, Map) for solvers that provide an internal substitute operation that takes two lists instead of a map.
protected TFormulaInfo	substituteUsingListsImpl(TFormulaInfo pF, List<TFormulaInfo> substituteFrom, List<TFormulaInfo> substituteTo) Backend for substituteUsingLists(Formula, Map).
protected <T1 extends Formula,T2 extends Formula> T1	substituteUsingMap(T1 pF, Map<? extends Formula,? extends Formula> pFromToMapping) Default implementation for substitute(Formula, Map).
protected TFormulaInfo	substituteUsingMapImpl(TFormulaInfo expr, Map<TFormulaInfo,TFormulaInfo> memoization, Formula f, Map<? extends Formula,? extends Formula> fromToMapping)
<T extends Formula> T	transformRecursively(FormulaTransformationVisitor pFormulaVisitor, T f) Visit the formula recursively with a given FormulaVisitor.
BooleanFormula	translate(BooleanFormula other, SolverContext otherContext) Translates the formula from another context into the context represented by this.
<R> R	visit(FormulaVisitor<R> visitor, Formula input) Visit the formula with a given visitor.
void	visitRecursively(FormulaVisitor<TraversalProcess> pFormulaVisitor, Formula pF) Visit the formula recursively with a given FormulaVisitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sosy_lab.solver.api.FormulaManager

parse

Constructor Detail

AbstractFormulaManager

protected AbstractFormulaManager(FormulaCreator<TFormulaInfo,TType,TEnv> pFormulaCreator,
                      AbstractFunctionFormulaManager<TFormulaInfo,?,TType,TEnv> functionManager,
                      AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv> booleanManager,
                      @Nullable
                      IntegerFormulaManager pIntegerManager,
                      @Nullable
                      RationalFormulaManager pRationalManager,
                      @Nullable
                      AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv> bitvectorManager,
                      @Nullable
                      AbstractFloatingPointFormulaManager<TFormulaInfo,TType,TEnv> floatingPointManager,
                      @Nullable
                      AbstractQuantifiedFormulaManager<TFormulaInfo,TType,TEnv> quantifiedManager,
                      @Nullable
                      AbstractArrayFormulaManager<TFormulaInfo,TType,TEnv> arrayManager)

Builds a solver from the given theory implementations

Method Detail

getFormulaCreator

public final FormulaCreator<TFormulaInfo,TType,TEnv> getFormulaCreator()

getIntegerFormulaManager

public IntegerFormulaManager getIntegerFormulaManager()

Description copied from interface: FormulaManager

Returns the Integer-Theory. Because most SAT-solvers support automatic casting between Integer- and Rational-Theory, the Integer- and the RationalFormulaManager both return the same Formulas for numeric operations like ADD, SUBTRACT, TIMES, LESSTHAN, EQUAL and others.

Specified by:

getIntegerFormulaManager in interface FormulaManager

getRationalFormulaManager

public RationalFormulaManager getRationalFormulaManager()

Description copied from interface: FormulaManager

Returns the Rational-Theory. Because most SAT-solvers support automatic casting between Integer- and Rational-Theory, the Integer- and the RationalFormulaManager both return the same Formulas for numeric operations like ADD, SUBTRACT, TIMES, LESSTHAN, EQUAL, etc.

Specified by:

getRationalFormulaManager in interface FormulaManager

getBooleanFormulaManager

public AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv> getBooleanFormulaManager()

Description copied from interface: FormulaManager

Returns the Boolean-Theory.

Specified by:

getBooleanFormulaManager in interface FormulaManager

getBitvectorFormulaManager

public AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv> getBitvectorFormulaManager()

Description copied from interface: FormulaManager

Returns the Bitvector-Theory.

Specified by:

getBitvectorFormulaManager in interface FormulaManager

getFloatingPointFormulaManager

public FloatingPointFormulaManager getFloatingPointFormulaManager()

Description copied from interface: FormulaManager

Returns the Floating-Point-Theory.

Specified by:

getFloatingPointFormulaManager in interface FormulaManager

getFunctionFormulaManager

public AbstractFunctionFormulaManager<TFormulaInfo,?,TType,TEnv> getFunctionFormulaManager()

Description copied from interface: FormulaManager

Returns the Function-Theory.

Specified by:

getFunctionFormulaManager in interface FormulaManager

getQuantifiedFormulaManager

public AbstractQuantifiedFormulaManager<TFormulaInfo,TType,TEnv> getQuantifiedFormulaManager()

Description copied from interface: FormulaManager

Returns the interface for handling quantifiers.

Specified by:

getQuantifiedFormulaManager in interface FormulaManager

getArrayFormulaManager

public ArrayFormulaManager getArrayFormulaManager()

Description copied from interface: FormulaManager

Returns the Array-Theory.

Specified by:

getArrayFormulaManager in interface FormulaManager

dumpFormula

public abstract Appender dumpFormula(TFormulaInfo t)

dumpFormula

public Appender dumpFormula(BooleanFormula t)

Description copied from interface: FormulaManager

Serialize an input formula to an SMT-LIB format. Very useful when passing formulas between different solvers.

To get a String, simply call Object.toString() on the returned object. This method is lazy and does not create an output string until the returned object is actually used.

Specified by:

dumpFormula in interface FormulaManager

Returns:

SMT-LIB formula serialization.

getFormulaType

public final <T extends Formula> FormulaType<T> getFormulaType(T formula)

Description copied from interface: FormulaManager

Returns the type of the given Formula.

Specified by:

getFormulaType in interface FormulaManager

getEnvironment

public final TEnv getEnvironment()

extractInfo

public final TFormulaInfo extractInfo(Formula f)

applyTactic

public BooleanFormula applyTactic(BooleanFormula f,
                         Tactic tactic)
                           throws InterruptedException

Description copied from interface: FormulaManager

Apply a tactic which performs formula transformation. The available tactics depend on the used solver.

Specified by:

applyTactic in interface FormulaManager

Throws:

InterruptedException

applyTacticImpl

protected TFormulaInfo applyTacticImpl(TFormulaInfo f,
                           Tactic tactic)
                                throws InterruptedException

Throws:

InterruptedException

simplify

public <T extends Formula> T simplify(T f)

Description copied from interface: FormulaManager

Simplify an input formula, while ensuring equivalence.

For solvers that do not provide a simplification API, an original formula is returned.

Specified by:

simplify in interface FormulaManager

Parameters:

f - The input formula

Returns:

Simplified version of the formula

simplify

protected TFormulaInfo simplify(TFormulaInfo f)

visit

public <R> R visit(FormulaVisitor<R> visitor,
          Formula input)

Description copied from interface: FormulaManager

Visit the formula with a given visitor.

Specified by:

visit in interface FormulaManager

visitRecursively

public void visitRecursively(FormulaVisitor<TraversalProcess> pFormulaVisitor,
                    Formula pF)

Description copied from interface: FormulaManager

Visit the formula recursively with a given FormulaVisitor.

This method guarantees that the traversal is done iteratively, without using Java recursion, and thus is not prone to StackOverflowErrors.

Furthermore, this method also guarantees that every equal part of the formula is visited only once. Thus it can be used to traverse DAG-like formulas efficiently.

Specified by:

visitRecursively in interface FormulaManager

transformRecursively

public <T extends Formula> T transformRecursively(FormulaTransformationVisitor pFormulaVisitor,
                                         T f)

Description copied from interface: FormulaManager

Visit the formula recursively with a given FormulaVisitor.

This method guarantees that the traversal is done iteratively, without using Java recursion, and thus is not prone to StackOverflowErrors.

Furthermore, this method also guarantees that every equal part of the formula is visited only once. Thus it can be used to traverse DAG-like formulas efficiently.

Specified by:

transformRecursively in interface FormulaManager

Parameters:

pFormulaVisitor - Transformation described by the user.

extractVariables

public Map<String,Formula> extractVariables(Formula f)

Extract names of all free variables in a formula.

Specified by:

extractVariables in interface FormulaManager

Parameters:

f - The input formula

Returns:

Map from variable names to the corresponding formulas.

extractVariablesAndUFs

public Map<String,Formula> extractVariablesAndUFs(Formula f)

Extract the names of all free variables and UFs in a formula.

Specified by:

extractVariablesAndUFs in interface FormulaManager

Parameters:

f - The input formula

Returns:

Map from variable names to the corresponding formulas.

splitNumeralEqualityIfPossible

public <T extends Formula> List<T> splitNumeralEqualityIfPossible(T pF)

Description copied from interface: FormulaManager

For a numeral (i.e., non-boolean) equality "x = y", return a list x<=y, x>=y.

Otherwise, return the list consisting of the input formula. Note: 1) Returned list always has one or two elements. 2) Conjunction over the returned list is equivalent to the input formula.

Specified by:

splitNumeralEqualityIfPossible in interface FormulaManager

splitNumeralEqualityIfPossible

protected abstract List<? extends TFormulaInfo> splitNumeralEqualityIfPossible(TFormulaInfo pF)

substituteUsingMap

protected final <T1 extends Formula,T2 extends Formula> T1 substituteUsingMap(T1 pF,
                                                            Map<? extends Formula,? extends Formula> pFromToMapping)

Default implementation for substitute(Formula, Map).

substituteUsingMapImpl

protected TFormulaInfo substituteUsingMapImpl(TFormulaInfo expr,
                                  Map<TFormulaInfo,TFormulaInfo> memoization,
                                  Formula f,
                                  Map<? extends Formula,? extends Formula> fromToMapping)

substituteUsingLists

protected final <T1 extends Formula> T1 substituteUsingLists(T1 pF,
                                           Map<? extends Formula,? extends Formula> pFromToMapping)

Default implementation for substitute(Formula, Map) for solvers that provide an internal substitute operation that takes two lists instead of a map.

If this is called, one needs to overwrite substitute(Formula, Map).

substituteUsingListsImpl

protected TFormulaInfo substituteUsingListsImpl(TFormulaInfo pF,
                                    List<TFormulaInfo> substituteFrom,
                                    List<TFormulaInfo> substituteTo)

Backend for substituteUsingLists(Formula, Map).

Parameters:

pF - The formula to change.

substituteFrom - The list of parts that should be replaced.

substituteTo - The list of replacement parts, in same order.

Returns:

The formula with th replacements applied.

translate

public BooleanFormula translate(BooleanFormula other,
                       SolverContext otherContext)

Description copied from interface: FormulaManager

Translates the formula from another context into the context represented by this. Default implementation relies on string serialization (FormulaManager.dumpFormula(BooleanFormula) and FormulaManager.parse(String)), but each solver may implement more efficient translation between its own contexts.

Specified by:

translate in interface FormulaManager

Parameters:

other - Formula belonging to otherContext.

otherContext - A different context

Returns:

Formula belonging to this context.

makeEqual

public <T extends Formula> BooleanFormula makeEqual(T pLhs,
                                           T pRhs)

Description copied from interface: FormulaManager

Create a formula representing equality between two formulas of the same type.

Specified by:

makeEqual in interface FormulaManager

makeVariable

public <T extends Formula> T makeVariable(FormulaType<T> formulaType,
                                 String name)

Description copied from interface: FormulaManager

Create variable of the type equal to formulaType.

Specified by:

makeVariable in interface FormulaManager

Parameters:

formulaType - the type of the variable.

name - the name of the variable.

Returns:

the created variable.

substitute

public <T extends Formula> T substitute(T pF,
                               Map<? extends Formula,? extends Formula> pFromToMapping)

Description copied from interface: FormulaManager

Substitute every occurrence of any item from changeFrom in formula f to the corresponding occurrence from changeTo.

E.g. if changeFrom contains a variable a and changeTo contains a variable b all occurrences of a will be changed to b in the returned formula.

Specified by:

substitute in interface FormulaManager

Parameters:

pF - Formula to change.

pFromToMapping - Mapping of old and new formula parts.

Returns:

Formula with parts replaced.