|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sat4j.tools.SolverDecorator<T>
public abstract class SolverDecorator<T extends ISolver>
The aim of that class is to allow adding dynamic responsibilities to SAT solvers using the Decorator design pattern. The class is abstract because it does not makes sense to use it "as is".
Constructor Summary | |
---|---|
SolverDecorator(T solver)
|
Method Summary | ||
---|---|---|
void |
addAllClauses(IVec<IVecInt> clauses)
Create clauses from a set of set of literals. |
|
IConstr |
addAtLeast(IVecInt literals,
int degree)
Create a cardinality constraint of the type "at least n of those literals must be satisfied" |
|
IConstr |
addAtMost(IVecInt literals,
int degree)
Create a cardinality constraint of the type "at most n of those literals must be satisfied" |
|
IConstr |
addBlockingClause(IVecInt literals)
Add a clause in order to prevent an assignment to occur. |
|
IConstr |
addClause(IVecInt literals)
Create a clause from a set of literals The literals are represented by non null integers such that opposite literals a represented by opposite values. |
|
IConstr |
addExactly(IVecInt literals,
int n)
Create a cardinality constraint of the type "exactly n of those literals must be satisfied". |
|
T |
clearDecorated()
Method to be called to clear the decorator from its decorated solver. |
|
void |
clearLearntClauses()
Remove clauses learned during the solving process. |
|
T |
decorated()
|
|
void |
expireTimeout()
Expire the timeout of the solver. |
|
int[] |
findModel()
Look for a model satisfying all the clauses available in the problem. |
|
int[] |
findModel(IVecInt assumps)
Look for a model satisfying all the clauses available in the problem. |
|
String |
getLogPrefix()
|
|
|
getSearchListener()
Get the current SearchListener. |
|
Map<String,Number> |
getStat()
To obtain a map of the available statistics from the solver. |
|
int |
getTimeout()
Useful to check the internal timeout of the solver. |
|
long |
getTimeoutMs()
Useful to check the internal timeout of the solver. |
|
boolean |
isDBSimplificationAllowed()
Indicate whether the solver is allowed to simplify the formula by propagating the truth value of top level satisfied variables. |
|
boolean |
isSatisfiable()
Check the satisfiability of the set of constraints contained inside the solver. |
|
boolean |
isSatisfiable(boolean global)
Check the satisfiability of the set of constraints contained inside the solver. |
|
boolean |
isSatisfiable(IVecInt assumps)
Check the satisfiability of the set of constraints contained inside the solver. |
|
boolean |
isSatisfiable(IVecInt assumps,
boolean global)
Check the satisfiability of the set of constraints contained inside the solver. |
|
boolean |
isSolverKeptHot()
Ask to the solver if it is in "hot" mode, meaning that the heuristics is not reset after call is isSatisfiable(). |
|
boolean |
isVerbose()
To know if the solver is in verbose mode (output allowed) or not. |
|
int[] |
model()
Provide a model (if any) for a satisfiable formula. |
|
boolean |
model(int var)
Provide the truth value of a specific variable in the model. |
|
int[] |
modelWithInternalVariables()
That method is designed to be used to retrieve the real model of the current set of constraints, i.e. to provide the truth value of boolean variables used internally in the solver (for encoding purposes for instance). |
|
int |
nConstraints()
To know the number of constraints currently available in the solver. |
|
int |
newVar()
Deprecated. |
|
int |
newVar(int howmany)
Declare howmany variables in the problem (and thus in the
vocabulary), that will be represented using the Dimacs format by integers
ranging from 1 to howmany. |
|
int |
nextFreeVarId(boolean reserve)
Ask the solver for a free variable identifier, in Dimacs format (i.e. a positive number). |
|
int |
nVars()
To know the number of variables used in the solver as declared by newVar() In case the method newVar() has not been used, the method returns the number of variables used in the solver. |
|
int[] |
primeImplicant()
Provide a prime implicant, i.e. a set of literal that is sufficient to satisfy all constraints of the problem. |
|
boolean |
primeImplicant(int p)
Check if a given literal is part of the prime implicant computed by the IProblem.primeImplicant() method. |
|
void |
printInfos(PrintWriter out,
String prefix)
To print additional informations regarding the problem. |
|
void |
printStat(PrintStream out,
String prefix)
Deprecated. |
|
void |
printStat(PrintWriter out,
String prefix)
Display statistics to the given output writer |
|
int |
realNumberOfVariables()
Retrieve the real number of variables used in the solver. |
|
void |
registerLiteral(int p)
Tell the solver to consider that the literal is in the CNF. |
|
boolean |
removeConstr(IConstr c)
Remove a constraint returned by one of the add method from the solver. |
|
boolean |
removeSubsumedConstr(IConstr c)
Remove a constraint returned by one of the add method from the solver that is subsumed by a constraint already in the solver or to be added to the solver. |
|
void |
reset()
Clean up the internal state of the solver. |
|
void |
setDBSimplificationAllowed(boolean status)
Set whether the solver is allowed to simplify the formula by propagating the truth value of top level satisfied variables. |
|
void |
setExpectedNumberOfClauses(int nb)
To inform the solver of the expected number of clauses to read. |
|
void |
setKeepSolverHot(boolean value)
Changed the behavior of the SAT solver heuristics between successive calls. |
|
void |
setLogPrefix(String prefix)
Set the prefix used to display information. |
|
|
setSearchListener(SearchListener<S> sl)
Allow the user to hook a listener to the solver to be notified of the main steps of the search process. |
|
void |
setTimeout(int t)
To set the internal timeout of the solver. |
|
void |
setTimeoutMs(long t)
To set the internal timeout of the solver. |
|
void |
setTimeoutOnConflicts(int count)
To set the internal timeout of the solver. |
|
void |
setVerbose(boolean value)
Set the verbosity of the solver |
|
String |
toString()
|
|
String |
toString(String prefix)
Display a textual representation of the solver configuration. |
|
IVecInt |
unsatExplanation()
Retrieve an explanation of the inconsistency in terms of assumption literals. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SolverDecorator(T solver)
Method Detail |
---|
public boolean isDBSimplificationAllowed()
ISolver
isDBSimplificationAllowed
in interface ISolver
public void setDBSimplificationAllowed(boolean status)
ISolver
setDBSimplificationAllowed
in interface ISolver
public void setTimeoutOnConflicts(int count)
ISolver
setTimeoutOnConflicts
in interface ISolver
count
- the timeout (in number of counflicts)public void printInfos(PrintWriter out, String prefix)
IProblem
printInfos
in interface IProblem
out
- the place to print the informationprefix
- the prefix to put in front of each linepublic boolean isSatisfiable(boolean global) throws TimeoutException
IProblem
isSatisfiable
in interface IProblem
global
- whether that call is part of a global process (i.e.
optimization) or not. if (global), the timeout will not be
reset between each call.
TimeoutException
public boolean isSatisfiable(IVecInt assumps, boolean global) throws TimeoutException
IProblem
isSatisfiable
in interface IProblem
assumps
- a set of literals (represented by usual non null integers in
Dimacs format).global
- whether that call is part of a global process (i.e.
optimization) or not. if (global), the timeout will not be
reset between each call.
TimeoutException
public void clearLearntClauses()
ISolver
clearLearntClauses
in interface ISolver
public int[] findModel() throws TimeoutException
IProblem
if (isSatisfiable()) {
return model();
}
return null;
findModel
in interface IProblem
null
if no model is found
TimeoutException
- if a model cannot be found within the given timeout.public int[] findModel(IVecInt assumps) throws TimeoutException
IProblem
if (isSatisfiable(assumpt)) {
return model();
}
return null;
findModel
in interface IProblem
null
if no model is found
TimeoutException
- if a model cannot be found within the given timeout.public boolean model(int var)
IProblem
model
in interface IProblem
var
- the variable id in Dimacs format
IProblem.model()
public void setExpectedNumberOfClauses(int nb)
ISolver
p cnf
line is
read in dimacs formatted input file.
Note that this method is supposed to be called AFTER a call to
newVar(int)
setExpectedNumberOfClauses
in interface ISolver
nb
- the expected number of clauses.IProblem.newVar(int)
public int getTimeout()
ISolver
getTimeout
in interface ISolver
public long getTimeoutMs()
ISolver
getTimeoutMs
in interface ISolver
public String toString(String prefix)
ISolver
toString
in interface ISolver
prefix
- the prefix to use on each line.
public String toString()
toString
in class Object
@Deprecated public void printStat(PrintStream out, String prefix)
ISolver
printStat
in interface ISolver
prefix
- the prefix to put in front of each lineISolver.printStat(PrintWriter, String)
public void printStat(PrintWriter out, String prefix)
ISolver
printStat
in interface ISolver
prefix
- the prefix to put in front of each line@Deprecated public int newVar()
ISolver
newVar
in interface ISolver
public int newVar(int howmany)
IProblem
howmany
variables in the problem (and thus in the
vocabulary), that will be represented using the Dimacs format by integers
ranging from 1 to howmany. That feature allows encodings to create
additional variables with identifier starting at howmany+1.
newVar
in interface IProblem
howmany
- number of variables to create
IProblem.nVars()
public IConstr addClause(IVecInt literals) throws ContradictionException
ISolver
addClause
in interface ISolver
literals
- a set of literals
ContradictionException
- iff the vector of literals is empty or if it contains only
falsified literals after unit propagationISolver.removeConstr(IConstr)
public void addAllClauses(IVec<IVecInt> clauses) throws ContradictionException
ISolver
addAllClauses
in interface ISolver
clauses
- a vector of set (VecInt) of literals in the dimacs format. The
vector can be reused since the solver is not supposed to keep
a reference to that vector.
ContradictionException
- iff the vector of literals is empty or if it contains only
falsified literals after unit propagationISolver.addClause(IVecInt)
public IConstr addBlockingClause(IVecInt literals) throws ContradictionException
ISolver
addBlockingClause
in interface ISolver
ContradictionException
public IConstr addAtMost(IVecInt literals, int degree) throws ContradictionException
ISolver
addAtMost
in interface ISolver
literals
- a set of literals The vector can be reused since the solver is
not supposed to keep a reference to that vector.degree
- the degree (n) of the cardinality constraint
ContradictionException
- iff the vector of literals is empty or if it contains more
than degree satisfied literals after unit propagationISolver.removeConstr(IConstr)
public IConstr addAtLeast(IVecInt literals, int degree) throws ContradictionException
ISolver
addAtLeast
in interface ISolver
literals
- a set of literals. The vector can be reused since the solver
is not supposed to keep a reference to that vector.degree
- the degree (n) of the cardinality constraint
ContradictionException
- iff the vector of literals is empty or if degree literals are
not remaining unfalsified after unit propagationISolver.removeConstr(IConstr)
public int[] model()
IProblem
model
in interface IProblem
IProblem.isSatisfiable()
,
IProblem.isSatisfiable(IVecInt)
public boolean isSatisfiable() throws TimeoutException
IProblem
isSatisfiable
in interface IProblem
TimeoutException
public boolean isSatisfiable(IVecInt assumps) throws TimeoutException
IProblem
isSatisfiable
in interface IProblem
assumps
- a set of literals (represented by usual non null integers in
Dimacs format).
TimeoutException
public void setTimeout(int t)
ISolver
setTimeout
in interface ISolver
t
- the timeout (in s)public void setTimeoutMs(long t)
ISolver
setTimeoutMs
in interface ISolver
t
- the timeout (in milliseconds)public void expireTimeout()
ISolver
expireTimeout
in interface ISolver
public int nConstraints()
IProblem
nConstraints
in interface IProblem
public int nVars()
IProblem
nVars
in interface IProblem
IProblem.newVar(int)
public void reset()
ISolver
reset
in interface ISolver
public T decorated()
public T clearDecorated()
public boolean removeConstr(IConstr c)
ISolver
removeConstr
in interface ISolver
c
- a constraint returned by one of the add method.
public Map<String,Number> getStat()
ISolver
getStat
in interface ISolver
public <S extends ISolverService> void setSearchListener(SearchListener<S> sl)
ISolver
setSearchListener
in interface ISolver
sl
- a Search Listener.public int nextFreeVarId(boolean reserve)
ISolver
ISolver.realNumberOfVariables()
method.
nextFreeVarId
in interface ISolver
reserve
- if true, the maxVarId is updated in the solver, i.e.
successive calls to nextFreeVarId(true) will return increasing
variable id while successive calls to nextFreeVarId(false)
will always answer the same.
ISolver.realNumberOfVariables()
public boolean removeSubsumedConstr(IConstr c)
ISolver
removeSubsumedConstr
in interface ISolver
c
- a constraint returned by one of the add method. It must be the
latest constr added to the solver.
public <S extends ISolverService> SearchListener<S> getSearchListener()
ISolver
getSearchListener
in interface ISolver
public boolean isVerbose()
ISolver
isVerbose
in interface ISolver
public void setVerbose(boolean value)
ISolver
setVerbose
in interface ISolver
value
- true to allow the solver to output messages on the console,
false either.public void setLogPrefix(String prefix)
ISolver
setLogPrefix
in interface ISolver
prefix
- the prefix to be in front of each line of textpublic String getLogPrefix()
getLogPrefix
in interface ISolver
public IVecInt unsatExplanation()
ISolver
unsatExplanation
in interface ISolver
IProblem.isSatisfiable(IVecInt)
,
IProblem.isSatisfiable(IVecInt, boolean)
public int[] primeImplicant()
IProblem
primeImplicant
in interface IProblem
public IConstr addExactly(IVecInt literals, int n) throws ContradictionException
ISolver
addExactly
in interface ISolver
literals
- a set of literals. The vector can be reused since the solver
is not supposed to keep a reference to that vector.n
- the number of literals that must be satisfied
ContradictionException
- iff the constraint is trivially unsatisfiable.public int[] modelWithInternalVariables()
ISolver
modelWithInternalVariables
in interface ISolver
IProblem.model()
,
ModelIterator
public int realNumberOfVariables()
ISolver
ISolver.nextFreeVarId(boolean)
method.
realNumberOfVariables
in interface ISolver
ISolver.nextFreeVarId(boolean)
public void registerLiteral(int p)
ISolver
registerLiteral
in interface ISolver
p
- the literal in Dimacs format that should appear in the model.public boolean isSolverKeptHot()
ISolver
isSolverKeptHot
in interface ISolver
public void setKeepSolverHot(boolean value)
ISolver
setKeepSolverHot
in interface ISolver
value
- true to keep the heuristics values across calls, false either.public boolean primeImplicant(int p)
IProblem
IProblem.primeImplicant()
method.
primeImplicant
in interface IProblem
p
- a literal in Dimacs format
IProblem.primeImplicant()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |