org.chocosolver.solver.constraints.binary

Class PropDistanceXYC

java.lang.Object

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

org.chocosolver.solver.constraints.binary.PropDistanceXYC

All Implemented Interfaces:

Serializable, Comparable<Propagator>, ICause, Identity

public class PropDistanceXYC
extends Propagator<IntVar>

| X - Y | op C
op = {"==", "<", ">", "=/="}

Since:

21/03/12

Author:

Charles Prud'homme

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cste
protected IIntDeltaMonitor[]	idms
protected Operator	operator
protected org.chocosolver.solver.constraints.binary.PropDistanceXYC.RemProc	remproc

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
PropDistanceXYC(IntVar[] vars, Operator operator, int cste)

Method Summary

Methods

Modifier and Type	Method and Description
void	duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap) Duplicate the current propagator.
void	filterFromVarToVar(IntVar var1, IntVar var2) Initial propagation in case of EQ and enumerated domains
void	filterGT() In case of a GT
void	filterGTonVar(IntVar v0, IntVar v1) In case of a GT, due to a modification on v0 domain
void	filterLT() In case of a LT
void	filterLTonVar(IntVar v0, IntVar v1) In case of a LT, due to a modification on v0 domain
void	filterNeq()
void	filterOnInf(IntVar v0, IntVar v1) In case of a EQ, due to a modification of the lower bound of v0
void	filterOnInst(IntVar v, int val) In case of a EQ, due to the instantion to one variable to val
void	filterOnSup(IntVar v0, IntVar v1) In case of a EQ, due to a modification of the upper bound of v0
int	getPropagationConditions(int idx) Return the specific mask indicating the variable events on which this Propagator object can react.
ESat	isEntailed() Check wether this is entailed according to the current state of its internal structure.
void	propagate(int evtmask) Call the main filtering algorithm to apply to the Domain of the Variable objects.
void	propagate(int varIdx, int mask) Incremental filtering algorithm defined within the Propagator, called whenever the variable of index idxVarInProp has changed.
String	toString()
boolean	why(RuleStore ruleStore, IntVar var, IEventType evt, int value) Add new rules to the rule store

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

addVariable, advise, arity, compareTo, contradiction, decNbPendingEvt, defineIn, 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

Methods inherited from class java.lang.Object

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

Field Detail

operator

protected final Operator operator

cste

protected final int cste

remproc

protected final org.chocosolver.solver.constraints.binary.PropDistanceXYC.RemProc remproc

idms

protected final IIntDeltaMonitor[] idms

Constructor Detail

PropDistanceXYC

public PropDistanceXYC(IntVar[] vars,
               Operator operator,
               int cste)

Method Detail

getPropagationConditions

public int getPropagationConditions(int idx)

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<IntVar>

Parameters:

idx - 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<IntVar>

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 varIdx,
             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<IntVar>

Parameters:

varIdx - 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<IntVar>

Returns:

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

toString

public String toString()

Overrides:

toString in class Propagator<IntVar>

why

public boolean why(RuleStore ruleStore,
          IntVar var,
          IEventType evt,
          int value)

Description copied from interface: ICause

Add new rules to the rule store

Specified by:

why in interface ICause

Overrides:

why in class Propagator<IntVar>

Parameters:

ruleStore - the rule store

var - the modified variable

evt - the undergoing event

value - the value (for REMOVE only)

Returns:

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

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

duplicate

public void duplicate(Solver solver,
             gnu.trove.map.hash.THashMap<Object,Object> identitymap)

Description copied from class: Propagator

Duplicate the current propagator. A restriction is that the resolution process should have not begun yet. That's why state of the propagator may not be duplicated.

Overrides:

duplicate in class Propagator<IntVar>

Parameters:

solver - the target solver

identitymap - a map to ensure uniqueness of objects