Class PropDistanceXYC
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<IntVar>
-
- org.chocosolver.solver.constraints.binary.PropDistanceXYC
-
- All Implemented Interfaces:
Comparable<Propagator>
,ICause
,Identity
public class PropDistanceXYC extends Propagator<IntVar>
| X - Y | op C
op = {"==", "<", ">", "=/="}- Since:
- 21/03/12
- Author:
- Charles Prud'homme
-
-
Field Summary
-
Fields inherited from class org.chocosolver.solver.constraints.Propagator
ACTIVE, constraint, DEFAULT_EXPL, model, operations, OUTPUT_DEFAULT_EXPL, priority, reactToFineEvt, state, vars
-
-
Constructor Summary
Constructors Constructor Description PropDistanceXYC(IntVar[] vars, Operator operator, int cste)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
filterFromVarToVar(IntVar var1, IntVar var2)
Initial propagation in case of EQ and enumerated domainsvoid
filterGT()
In case of a GTvoid
filterGTonVar(IntVar v0, IntVar v1)
In case of a GT, due to a modification on v0 domainvoid
filterLT()
In case of a LTvoid
filterLTonVar(IntVar v0, IntVar v1)
In case of a LT, due to a modification on v0 domainvoid
filterNeq()
void
filterOnInf(IntVar v0, IntVar v1)
In case of a EQ, due to a modification of the lower bound of v0void
filterOnInst(IntVar v, int val)
In case of a EQ, due to the instantion to one variable to valvoid
filterOnSup(IntVar v0, IntVar v1)
In case of a EQ, due to a modification of the upper bound of v0int
getPropagationConditions(int idx)
Returns the specific mask indicating the variable events on which thisPropagator
object can react.
A mask is a bitwise OR operations overIEventType
this can react on.ESat
isEntailed()
Check wetherthis
is entailed according to the current state of its internal structure.void
propagate(int evtmask)
Call the main filtering algorithm to apply to theDomain
of theVariable
objects.void
propagate(int varIdx, int mask)
Incremental filtering algorithm defined within thePropagator
, called whenever the variable of index idxVarInProp has changed.String
toString()
-
Methods inherited from class org.chocosolver.solver.constraints.Propagator
addVariable, arity, compareTo, defaultExplain, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, explain, fails, forcePropagate, forcePropagationOnBacktrack, forEachIntVar, getConstraint, getId, getModel, getNbVars, getPosition, getPriority, getVar, getVars, getVIndice, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReified, isReifiedAndSilent, isScheduled, isStateLess, linkVariables, reactToFineEvent, reifiedWith, setActive, setActive0, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, unlinkVariables, unschedule
-
-
-
-
Method Detail
-
getPropagationConditions
public int getPropagationConditions(int idx)
Description copied from class:Propagator
Returns the specific mask indicating the variable events on which thisPropagator
object can react.
A mask is a bitwise OR operations overIEventType
this can react on. For example, consider a propagator that can deduce filtering based on the lower bound of the integer variable X. Then, for this variable, the mask should be equal to :int mask = IntEventType.INCLOW.getMask() | IntEventType.INSTANTIATE.getMask();
or, in a more convenient way:int mask = IntEvtType.combine(IntEventType.INCLOW,IntEventType.INSTANTIATE);
That indicates the following behavior:- if X is instantiated, this propagator will be executed,
- if the lower bound of X is modified, this propagator will be executed,
- if the lower bound of X is removed, the event is promoted from REMOVE to INCLOW and this propagator will NOT be executed,
- otherwise, this propagator will NOT be executed
IntEventType.VOID
which states that this propagator should not be aware of modifications applied to the variable in position vIdx.- Overrides:
getPropagationConditions
in classPropagator<IntVar>
- Parameters:
idx
- index of the variable within the propagator- Returns:
- an int composed of
REMOVE
and/orINSTANTIATE
and/orDECUPP
and/orINCLOW
-
propagate
public void propagate(int evtmask) throws ContradictionException
Description copied from class:Propagator
Call the main filtering algorithm to apply to theDomain
of theVariable
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 classPropagator<IntVar>
- Parameters:
evtmask
- type of propagation eventthis
must consider.- Throws:
ContradictionException
- when a contradiction occurs, like domain wipe out or other incoherencies.
-
propagate
public void propagate(int varIdx, int mask) throws ContradictionException
Description copied from class:Propagator
Incremental filtering algorithm defined within thePropagator
, 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 totrue
in the constructor. Otherwise, it executespropagate(PropagatorEventType.CUSTOM_PROPAGATION.getStrengthenedMask());
- Overrides:
propagate
in classPropagator<IntVar>
- Parameters:
varIdx
- index of the variablevar
inthis
mask
- type of event- Throws:
ContradictionException
- if a contradiction occurs
-
isEntailed
public ESat isEntailed()
Description copied from class:Propagator
Check wetherthis
is entailed according to the current state of its internal structure. At least, should check the satisfaction ofthis
(when all is instantiated).- Specified by:
isEntailed
in classPropagator<IntVar>
- Returns:
- ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown
-
toString
public String toString()
- Overrides:
toString
in classPropagator<IntVar>
-
filterFromVarToVar
public void filterFromVarToVar(IntVar var1, IntVar var2) throws ContradictionException
Initial propagation in case of EQ and enumerated domains- Throws:
ContradictionException
-
filterGT
public void filterGT() throws ContradictionException
In case of a GT- Throws:
ContradictionException
-
filterGTonVar
public void filterGTonVar(IntVar v0, IntVar v1) throws ContradictionException
In case of a GT, due to a modification on v0 domain- Throws:
ContradictionException
-
filterLT
public void filterLT() throws ContradictionException
In case of a LT- Throws:
ContradictionException
-
filterLTonVar
public void filterLTonVar(IntVar v0, IntVar v1) throws ContradictionException
In case of a LT, due to a modification on v0 domain- Throws:
ContradictionException
-
filterOnInf
public void filterOnInf(IntVar v0, IntVar v1) throws ContradictionException
In case of a EQ, due to a modification of the lower bound of v0- Throws:
ContradictionException
-
filterOnSup
public void filterOnSup(IntVar v0, IntVar v1) throws ContradictionException
In case of a EQ, due to a modification of the upper bound of v0- Throws:
ContradictionException
-
filterOnInst
public void filterOnInst(IntVar v, int val) throws ContradictionException
In case of a EQ, due to the instantion to one variable to val- Throws:
ContradictionException
-
filterNeq
public void filterNeq() throws ContradictionException
- Throws:
ContradictionException
-
-