org.sat4j.pb.core

Class ObjectiveReducerPBSolverDecorator

java.lang.Object

org.sat4j.pb.core.ObjectiveReducerPBSolverDecorator

All Implemented Interfaces:

Serializable, IPBSolver, IProblem, ISolver, RandomAccessModel

public class ObjectiveReducerPBSolverDecorator
extends Object
implements IPBSolver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectiveReducerPBSolverDecorator(IPBSolver decorated)

Method Summary

Modifier and Type	Method and Description
void	addAllClauses(IVec<IVecInt> clauses)
IConstr	addAtLeast(IVecInt literals, int degree)
IConstr	addAtLeast(IVecInt literals, IVec<BigInteger> coeffs, BigInteger degree) Create a pseudo-boolean constraint of the type "at least".
IConstr	addAtLeast(IVecInt literals, IVecInt coeffs, int degree) Create a pseudo-boolean constraint of the type "at least".
IConstr	addAtMost(IVecInt literals, int degree)
IConstr	addAtMost(IVecInt literals, IVec<BigInteger> coeffs, BigInteger degree) Create a pseudo boolean constraint of the type "at most".
IConstr	addAtMost(IVecInt literals, IVecInt coeffs, int degree) Create a pseudo boolean constraint of the type "at most".
IConstr	addBlockingClause(IVecInt literals)
IConstr	addClause(IVecInt literals)
IConstr	addConstr(Constr constr)
IConstr	addExactly(IVecInt literals, int n)
IConstr	addExactly(IVecInt literals, IVec<BigInteger> coeffs, BigInteger weight) Create a pseudo-boolean constraint of the type "subset sum".
IConstr	addExactly(IVecInt literals, IVecInt coeffs, int weight) Create a pseudo-boolean constraint of the type "subset sum".
IConstr	addParity(IVecInt literals, boolean even)
IConstr	addPseudoBoolean(IVecInt lits, IVec<BigInteger> coeffs, boolean moreThan, BigInteger d) Create a Pseudo-Boolean constraint of the type "at least n or at most n of those literals must be satisfied"
void	clearLearntClauses()
IVecInt	createBlockingClauseForCurrentModel()
IConstr	discardCurrentModel()
void	expireTimeout()
int[]	findModel()
int[]	findModel(IVecInt assumps)
String	getLogPrefix()
ObjectiveFunction	getObjectiveFunction() Retrieve the objective function from the solver.
AssignmentOrigin	getOriginInModel(int p)
<S extends ISolverService> SearchListener<S>	getSearchListener()
ISolver	getSolvingEngine()
Map<String,Number>	getStat()
int	getTimeout()
long	getTimeoutMs()
boolean	isDBSimplificationAllowed()
boolean	isSatisfiable()
boolean	isSatisfiable(boolean globalTimeout)
boolean	isSatisfiable(IVecInt assumps)
boolean	isSatisfiable(IVecInt assumps, boolean globalTimeout)
boolean	isSolverKeptHot()
boolean	isVerbose()
int[]	model()
boolean	model(int var)
int[]	modelWithInternalVariables()
int	nConstraints()
int	newVar()
int	newVar(int howmany)
int	nextFreeVarId(boolean reserve)
int	nVars()
int[]	primeImplicant()
boolean	primeImplicant(int p)
void	printInfos(PrintWriter out)
void	printInfos(PrintWriter out, String prefix)
void	printStat(PrintStream out, String prefix)
void	printStat(PrintWriter out)
void	printStat(PrintWriter out, String prefix)
int	realNumberOfVariables()
void	registerLiteral(int p)
boolean	removeConstr(IConstr c)
boolean	removeSubsumedConstr(IConstr c)
void	reset()
void	setDBSimplificationAllowed(boolean status)
void	setExpectedNumberOfClauses(int nb)
void	setKeepSolverHot(boolean keepHot)
void	setLogPrefix(String prefix)
void	setObjectiveFunction(ObjectiveFunction obj) Provide an objective function to the solver.
<S extends ISolverService> void	setSearchListener(SearchListener<S> sl)
void	setTimeout(int t)
void	setTimeoutMs(long t)
void	setTimeoutOnConflicts(int count)
void	setUnitClauseConsumer(UnitClauseConsumer ucc)
void	setUnitClauseProvider(UnitClauseProvider ucp)
void	setVerbose(boolean value)
String	toString(String prefix)
IVecInt	unsatExplanation()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectiveReducerPBSolverDecorator

public ObjectiveReducerPBSolverDecorator(IPBSolver decorated)

Method Detail

model

public int[] model()

Specified by:

model in interface IProblem

newVar

public int newVar()

Specified by:

newVar in interface ISolver

addPseudoBoolean

public IConstr addPseudoBoolean(IVecInt lits,
                                IVec<BigInteger> coeffs,
                                boolean moreThan,
                                BigInteger d)
                         throws ContradictionException

Description copied from interface: IPBSolver

Create a Pseudo-Boolean constraint of the type "at least n or at most n of those literals must be satisfied"

Specified by:

addPseudoBoolean in interface IPBSolver

Parameters:

lits - a set of literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

moreThan - true if it is a constraint >= degree, false if it is a constraint <= degree

d - the degree of the cardinality constraint

Returns:

a reference to the constraint added in the solver, to use in removeConstr().

Throws:

ContradictionException - iff the vector of literals is empty or if the constraint is falsified after unit propagation

See Also:

ISolver.removeConstr(IConstr)

model

public boolean model(int var)

Specified by:

model in interface RandomAccessModel

nextFreeVarId

public int nextFreeVarId(boolean reserve)

Specified by:

nextFreeVarId in interface ISolver

primeImplicant

public int[] primeImplicant()

Specified by:

primeImplicant in interface IProblem

primeImplicant

public boolean primeImplicant(int p)

Specified by:

primeImplicant in interface IProblem

addAtMost

public IConstr addAtMost(IVecInt literals,
                         IVecInt coeffs,
                         int degree)
                  throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo boolean constraint of the type "at most".

Specified by:

addAtMost in interface IPBSolver

Parameters:

literals - a set of literals The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

degree - the degree of the pseudo-boolean constraint

Returns:

a reference to the constraint added in the solver, to use in removeConstr().

Throws:

ContradictionException - iff the constraint is found trivially unsat.

See Also:

ISolver.removeConstr(IConstr)

isSatisfiable

public boolean isSatisfiable()
                      throws TimeoutException

Specified by:

isSatisfiable in interface IProblem

Throws:

TimeoutException

isSatisfiable

public boolean isSatisfiable(IVecInt assumps,
                             boolean globalTimeout)
                      throws TimeoutException

Specified by:

isSatisfiable in interface IProblem

Throws:

TimeoutException

registerLiteral

public void registerLiteral(int p)

Specified by:

registerLiteral in interface ISolver

setExpectedNumberOfClauses

public void setExpectedNumberOfClauses(int nb)

Specified by:

setExpectedNumberOfClauses in interface ISolver

addAtMost

public IConstr addAtMost(IVecInt literals,
                         IVec<BigInteger> coeffs,
                         BigInteger degree)
                  throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo boolean constraint of the type "at most".

Specified by:

addAtMost in interface IPBSolver

Parameters:

literals - a set of literals The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

degree - the degree of the pseudo-boolean constraint

Returns:

a reference to the constraint added in the solver, to use in removeConstr().

Throws:

ContradictionException - iff the constraint is found trivially unsat.

See Also:

ISolver.removeConstr(IConstr)

isSatisfiable

public boolean isSatisfiable(boolean globalTimeout)
                      throws TimeoutException

Specified by:

isSatisfiable in interface IProblem

Throws:

TimeoutException

addClause

public IConstr addClause(IVecInt literals)
                  throws ContradictionException

Specified by:

addClause in interface ISolver

Throws:

ContradictionException

isSatisfiable

public boolean isSatisfiable(IVecInt assumps)
                      throws TimeoutException

Specified by:

isSatisfiable in interface IProblem

Throws:

TimeoutException

addAtLeast

public IConstr addAtLeast(IVecInt literals,
                          IVecInt coeffs,
                          int degree)
                   throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo-boolean constraint of the type "at least".

Specified by:

addAtLeast in interface IPBSolver

Parameters:

literals - a set of literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

degree - the degree of the pseudo-boolean constraint

Returns:

a reference to the constraint added in the solver, to use in removeConstr().

Throws:

ContradictionException - iff the constraint is found trivially unsat.

See Also:

ISolver.removeConstr(IConstr)

findModel

public int[] findModel()
                throws TimeoutException

Specified by:

findModel in interface IProblem

Throws:

TimeoutException

addBlockingClause

public IConstr addBlockingClause(IVecInt literals)
                          throws ContradictionException

Specified by:

addBlockingClause in interface ISolver

Throws:

ContradictionException

discardCurrentModel

public IConstr discardCurrentModel()
                            throws ContradictionException

Specified by:

discardCurrentModel in interface ISolver

Throws:

ContradictionException

createBlockingClauseForCurrentModel

public IVecInt createBlockingClauseForCurrentModel()

Specified by:

createBlockingClauseForCurrentModel in interface ISolver

removeConstr

public boolean removeConstr(IConstr c)

Specified by:

removeConstr in interface ISolver

findModel

public int[] findModel(IVecInt assumps)
                throws TimeoutException

Specified by:

findModel in interface IProblem

Throws:

TimeoutException

addAtLeast

public IConstr addAtLeast(IVecInt literals,
                          IVec<BigInteger> coeffs,
                          BigInteger degree)
                   throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo-boolean constraint of the type "at least".

Specified by:

addAtLeast in interface IPBSolver

Parameters:

literals - a set of literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

degree - the degree of the pseudo-boolean constraint

Returns:

a reference to the constraint added in the solver, to use in removeConstr().

Throws:

ContradictionException - iff the constraint is found trivially unsat.

See Also:

ISolver.removeConstr(IConstr)

removeSubsumedConstr

public boolean removeSubsumedConstr(IConstr c)

Specified by:

removeSubsumedConstr in interface ISolver

nConstraints

public int nConstraints()

Specified by:

nConstraints in interface IProblem

newVar

public int newVar(int howmany)

Specified by:

newVar in interface IProblem

addAllClauses

public void addAllClauses(IVec<IVecInt> clauses)
                   throws ContradictionException

Specified by:

addAllClauses in interface ISolver

Throws:

ContradictionException

addExactly

public IConstr addExactly(IVecInt literals,
                          IVecInt coeffs,
                          int weight)
                   throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo-boolean constraint of the type "subset sum".

Specified by:

addExactly in interface IPBSolver

Parameters:

literals - a set of literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

weight - the number of literals that must be satisfied

Returns:

a reference to the constraint added to the solver. It might return an object representing a group of constraints.

Throws:

ContradictionException - iff the constraint is trivially unsatisfiable.

nVars

public int nVars()

Specified by:

nVars in interface IProblem

printInfos

public void printInfos(PrintWriter out,
                       String prefix)

Specified by:

printInfos in interface IProblem

addAtMost

public IConstr addAtMost(IVecInt literals,
                         int degree)
                  throws ContradictionException

Specified by:

addAtMost in interface ISolver

Throws:

ContradictionException

addExactly

public IConstr addExactly(IVecInt literals,
                          IVec<BigInteger> coeffs,
                          BigInteger weight)
                   throws ContradictionException

Description copied from interface: IPBSolver

Create a pseudo-boolean constraint of the type "subset sum".

Specified by:

addExactly in interface IPBSolver

Parameters:

literals - a set of literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

coeffs - the coefficients of the literals. The vector can be reused since the solver is not supposed to keep a reference to that vector.

weight - the number of literals that must be satisfied

Returns:

a reference to the constraint added to the solver. It might return an object representing a group of constraints.

Throws:

ContradictionException - iff the constraint is trivially unsatisfiable.

printInfos

public void printInfos(PrintWriter out)

Specified by:

printInfos in interface IProblem

addAtLeast

public IConstr addAtLeast(IVecInt literals,
                          int degree)
                   throws ContradictionException

Specified by:

addAtLeast in interface ISolver

Throws:

ContradictionException

setObjectiveFunction

public void setObjectiveFunction(ObjectiveFunction obj)

Description copied from interface: IPBSolver

Provide an objective function to the solver.

Specified by:

setObjectiveFunction in interface IPBSolver

Parameters:

obj - the objective function

getObjectiveFunction

public ObjectiveFunction getObjectiveFunction()

Description copied from interface: IPBSolver

Retrieve the objective function from the solver.

Specified by:

getObjectiveFunction in interface IPBSolver

Returns:

the objective function

addExactly

public IConstr addExactly(IVecInt literals,
                          int n)
                   throws ContradictionException

Specified by:

addExactly in interface ISolver

Throws:

ContradictionException

setTimeout

public void setTimeout(int t)

Specified by:

setTimeout in interface ISolver

setTimeoutOnConflicts

public void setTimeoutOnConflicts(int count)

Specified by:

setTimeoutOnConflicts in interface ISolver

setTimeoutMs

public void setTimeoutMs(long t)

Specified by:

setTimeoutMs in interface ISolver

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ISolver

getTimeoutMs

public long getTimeoutMs()

Specified by:

getTimeoutMs in interface ISolver

expireTimeout

public void expireTimeout()

Specified by:

expireTimeout in interface ISolver

reset

public void reset()

Specified by:

reset in interface ISolver

printStat

public void printStat(PrintStream out,
                      String prefix)

Specified by:

printStat in interface ISolver

printStat

public void printStat(PrintWriter out,
                      String prefix)

Specified by:

printStat in interface ISolver

printStat

public void printStat(PrintWriter out)

Specified by:

printStat in interface ISolver

getStat

public Map<String,Number> getStat()

Specified by:

getStat in interface ISolver

toString

public String toString(String prefix)

Specified by:

toString in interface ISolver

clearLearntClauses

public void clearLearntClauses()

Specified by:

clearLearntClauses in interface ISolver

setDBSimplificationAllowed

public void setDBSimplificationAllowed(boolean status)

Specified by:

setDBSimplificationAllowed in interface ISolver

isDBSimplificationAllowed

public boolean isDBSimplificationAllowed()

Specified by:

isDBSimplificationAllowed in interface ISolver

setSearchListener

public <S extends ISolverService> void setSearchListener(SearchListener<S> sl)

Specified by:

setSearchListener in interface ISolver

getSearchListener

public <S extends ISolverService> SearchListener<S> getSearchListener()

Specified by:

getSearchListener in interface ISolver

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface ISolver

setVerbose

public void setVerbose(boolean value)

Specified by:

setVerbose in interface ISolver

setLogPrefix

public void setLogPrefix(String prefix)

Specified by:

setLogPrefix in interface ISolver

getLogPrefix

public String getLogPrefix()

Specified by:

getLogPrefix in interface ISolver

unsatExplanation

public IVecInt unsatExplanation()

Specified by:

unsatExplanation in interface ISolver

modelWithInternalVariables

public int[] modelWithInternalVariables()

Specified by:

modelWithInternalVariables in interface ISolver

realNumberOfVariables

public int realNumberOfVariables()

Specified by:

realNumberOfVariables in interface ISolver

isSolverKeptHot

public boolean isSolverKeptHot()

Specified by:

isSolverKeptHot in interface ISolver

setKeepSolverHot

public void setKeepSolverHot(boolean keepHot)

Specified by:

setKeepSolverHot in interface ISolver

getSolvingEngine

public ISolver getSolvingEngine()

Specified by:

getSolvingEngine in interface ISolver

setUnitClauseProvider

public void setUnitClauseProvider(UnitClauseProvider ucp)

Specified by:

setUnitClauseProvider in interface ISolver

addConstr

public IConstr addConstr(Constr constr)

Specified by:

addConstr in interface ISolver

addParity

public IConstr addParity(IVecInt literals,
                         boolean even)

Specified by:

addParity in interface ISolver

getOriginInModel

public AssignmentOrigin getOriginInModel(int p)

Specified by:

getOriginInModel in interface ISolver

setUnitClauseConsumer

public void setUnitClauseConsumer(UnitClauseConsumer ucc)

Specified by:

setUnitClauseConsumer in interface ISolver