org.chocosolver.solver.constraints.nary.cnf

Class PropSat

java.lang.Object

org.chocosolver.solver.constraints.Propagator<BoolVar>

org.chocosolver.solver.constraints.nary.cnf.PropSat

All Implemented Interfaces:

Serializable, Comparable<Propagator>, ICause, Identity

public class PropSat
extends Propagator<BoolVar>

Since:

12/07/13

Author:

Charles Prud'homme

See Also:

Serialized Form

Field Summary

Fields inherited from class org.chocosolver.solver.constraints.Propagator

aCause, ACTIVE, constraint, LOGGER, NEW, PASSIVE, priority, reactToFineEvt, REIFIED, solver, vars

Constructor Summary

Constructors

Constructor and Description
PropSat(Solver solver)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addClause(int p)
boolean	addClause(int p, int q)
boolean	addClause(int p, int q, int r)
boolean	addClause(gnu.trove.list.TIntList lits)
boolean	addEmptyClause()
void	addLearnt(int... lits)
static void	declareVariable(PropSat sat, BoolVar var)
int	getPropagationConditions(int vIdx) Return the specific mask indicating the variable events on which this Propagator object can react.
SatSolver	getSatSolver()
ESat	isEntailed() Check wether this is entailed according to the current state of its internal structure.
int	Literal(BoolVar expr)
void	propagate(int evtmask) Call the main filtering algorithm to apply to the Domain of the Variable objects.
void	propagate(int idxVarInProp, int mask) Incremental filtering algorithm defined within the Propagator, called whenever the variable of index idxVarInProp has changed.
boolean	why(RuleStore ruleStore, IntVar bvar, IEventType evt, int bvalue) Add new rules to the rule store

Methods inherited from class org.chocosolver.solver.constraints.Propagator

addVariable, advise, arity, compareTo, contradiction, decNbPendingEvt, defineIn, duplicate, dynPriority, flushPendingEvt, forcePropagate, getConstraint, getId, getNbPendingEvt, getNbVars, getPriority, getSolver, getVar, getVars, getVIndices, hashCode, incNbPendingEvt, isActive, isCompletelyInstantiated, isPassive, isReifiedAndSilent, isStateLess, reactToFineEvent, setActive, setPassive, setReifiedSilent, setReifiedTrue, setVIndices, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PropSat

public PropSat(Solver solver)

Method Detail

getPropagationConditions

public int getPropagationConditions(int vIdx)

Description copied from class: Propagator

Return the specific mask indicating the variable events on which this Propagator object can react.
Checks are made applying bitwise AND between the mask and the event. Reacts to any kind of event by default.

Overrides:

getPropagationConditions in class Propagator<BoolVar>

Parameters:

vIdx - index of the variable within the propagator

Returns:

int composed of REMOVE and/or INSTANTIATE and/or DECUPP and/or INCLOW

propagate

public void propagate(int evtmask)
               throws ContradictionException

Description copied from class: Propagator

Call the main filtering algorithm to apply to the Domain of the Variable objects. It considers the current state of this objects to remove some values from domains and/or instantiate some variables. Calling this method is done from 2 (and only 2) steps:
- at the initial propagation step,
- when involved in a reified constraint.
It should initialized the internal data structure and apply filtering algorithm from scratch.

Specified by:

propagate in class Propagator<BoolVar>

Parameters:

evtmask - type of propagation event this must consider.

Throws:

ContradictionException - when a contradiction occurs, like domain wipe out or other incoherencies.

propagate

public void propagate(int idxVarInProp,
             int mask)
               throws ContradictionException

Description copied from class: Propagator

Incremental filtering algorithm defined within the Propagator, called whenever the variable of index idxVarInProp has changed. This method calls a CUSTOM_PROPAGATION (coarse-grained) by default.

This method should be overridden if the argument reactToFineEvt is set to true in the constructor. Otherwise, it executes propagate(PropagatorEventType.CUSTOM_PROPAGATION.getStrengthenedMask());

Overrides:

propagate in class Propagator<BoolVar>

Parameters:

idxVarInProp - index of the variable var in this

mask - type of event

Throws:

ContradictionException - if a contradiction occurs

isEntailed

public ESat isEntailed()

Description copied from class: Propagator

Check wether this is entailed according to the current state of its internal structure. At least, should check the satisfaction of this (when all is instantiated).

Specified by:

isEntailed in class Propagator<BoolVar>

Returns:

ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown

getSatSolver

public SatSolver getSatSolver()

Literal

public int Literal(BoolVar expr)

addClause

public boolean addClause(gnu.trove.list.TIntList lits)

addEmptyClause

public boolean addEmptyClause()

addClause

public boolean addClause(int p)

addClause

public boolean addClause(int p,
                int q)

addClause

public boolean addClause(int p,
                int q,
                int r)

addLearnt

public void addLearnt(int... lits)

declareVariable

public static void declareVariable(PropSat sat,
                   BoolVar var)

why

public boolean why(RuleStore ruleStore,
          IntVar bvar,
          IEventType evt,
          int bvalue)

Description copied from interface: ICause

Add new rules to the rule store

Specified by:

why in interface ICause

Overrides:

why in class Propagator<BoolVar>

Parameters:

ruleStore - the rule store

bvar - the modified variable

evt - the undergoing event

bvalue - the value (for REMOVE only)

Returns:

true if at least one rule has been added to the rule store