choco.cp.solver.constraints.integer
Class DistanceXYZ

java.lang.Object
  extended by choco.kernel.solver.propagation.Propagator
      extended by choco.kernel.solver.constraints.AbstractSConstraint<IntDomainVar>
          extended by choco.kernel.solver.constraints.integer.AbstractIntSConstraint
              extended by choco.kernel.solver.constraints.integer.AbstractTernIntSConstraint
                  extended by choco.cp.solver.constraints.integer.DistanceXYZ
All Implemented Interfaces:
IExtensionnable, IPretty, SConstraint<IntDomainVar>, IntPropagator, Cloneable, EventListener

public final class DistanceXYZ
extends AbstractTernIntSConstraint

A constraint to state |x0 - x1| operator x2 + c where operator can be =, <=, >= and x1, x2, x3 are variables Warning: only achieves BoundConsistency for the moment !


Field Summary
protected  int cste
           
static int EQ
           
static int GT
           
static int LT
           
protected  int operator
           
 
Fields inherited from class choco.kernel.solver.constraints.integer.AbstractTernIntSConstraint
v0, v1, v2
 
Fields inherited from class choco.kernel.solver.constraints.AbstractSConstraint
cIndices, constraintType, extensions, vars
 
Fields inherited from class choco.kernel.solver.propagation.Propagator
active, constAwakeEvent, priority, propagationEngine
 
Fields inherited from interface choco.kernel.solver.constraints.SConstraint
LOGGER
 
Constructor Summary
DistanceXYZ(IntDomainVar x0, IntDomainVar x1, IntDomainVar x2, int c, int op)
          Enforces |x0 - x1| op x2 + c where op can be =, <, >
 
Method Summary
 void awakeOnBounds(int varIndex)
           
 void awakeOnInf(int idx)
          Default propagation on improved lower bound: propagation on domain revision.
 void awakeOnInst(int idx)
          Default propagation on instantiation: full constraint re-propagation.
 void awakeOnRemovals(int idx, DisposableIntIterator deltaDomain)
          The default implementation of propagation when a variable has been modified consists in iterating all values that have been removed (the delta domain) and propagate them one after another, incrementally.
 void awakeOnSup(int idx)
          Default propagation on improved upper bound: propagation on domain revision.
 boolean filterEQFromXZToY()
           
 boolean filterEQFromYZToX()
           
 void filterFixPoint()
           
 boolean filterFromXYtoLBZ()
           
 boolean filterFromXYtoUBZ()
           
 boolean filterGTFromXZtoY()
           
 boolean filterGTFromYZtoX()
           
 boolean filterLTFromXZtoY()
           
 boolean filterLTFromYZtoX()
           
 int getFilteredEventMask(int idx)
           
 Boolean isEntailed()
          Indicates if the constraint is entailed, from now on will be always satisfied
 boolean isSatisfied(int[] tuple)
          TEMPORARY: if not overriden by the constraint, throws an error to avoid bug using reified constraints in constraints that have not been changed to fulfill this api yet !
 String pretty()
          pretty printing of the object.
 void propagate()
          Propagation: Propagating the constraint until local consistency is reached.
 String toString()
           
 
Methods inherited from class choco.kernel.solver.constraints.integer.AbstractIntSConstraint
awakeOnRem, getConstraintType, isConsistent, isSatisfied
 
Methods inherited from class choco.kernel.solver.constraints.AbstractSConstraint
addExtension, addListener, clone, getAbstractSConstraintExtensionNumber, getConstraintIdx, getExtension, getFineDegree, getNbVarNotInst, getNbVars, getVar, getVarQuick, isCompletelyInstantiated, opposite, setConstraintIndex, setExtension, setVar
 
Methods inherited from class choco.kernel.solver.propagation.Propagator
activate, awake, constAwake, fail, getEvent, getPriority, isActive, setActive, setActiveSilently, setEntailed, setPassive, setPropagationEngine
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

operator

protected int operator

cste

protected final int cste

EQ

public static final int EQ
See Also:
Constant Field Values

LT

public static final int LT
See Also:
Constant Field Values

GT

public static final int GT
See Also:
Constant Field Values
Constructor Detail

DistanceXYZ

public DistanceXYZ(IntDomainVar x0,
                   IntDomainVar x1,
                   IntDomainVar x2,
                   int c,
                   int op)
Enforces |x0 - x1| op x2 + c where op can be =, <, >

Parameters:
x0 -
x1 -
x2 -
c - the constant
op - the operator to be chosen among {0,1,2} standing for (eq,lt,gt)
Method Detail

getFilteredEventMask

public int getFilteredEventMask(int idx)
Overrides:
getFilteredEventMask in class Propagator

filterFromXYtoLBZ

public boolean filterFromXYtoLBZ()
                          throws ContradictionException
Throws:
ContradictionException

filterFromXYtoUBZ

public boolean filterFromXYtoUBZ()
                          throws ContradictionException
Throws:
ContradictionException

filterEQFromYZToX

public boolean filterEQFromYZToX()
                          throws ContradictionException
Throws:
ContradictionException

filterEQFromXZToY

public boolean filterEQFromXZToY()
                          throws ContradictionException
Throws:
ContradictionException

filterLTFromYZtoX

public boolean filterLTFromYZtoX()
                          throws ContradictionException
Throws:
ContradictionException

filterLTFromXZtoY

public boolean filterLTFromXZtoY()
                          throws ContradictionException
Throws:
ContradictionException

filterGTFromYZtoX

public boolean filterGTFromYZtoX()
                          throws ContradictionException
Throws:
ContradictionException

filterGTFromXZtoY

public boolean filterGTFromXZtoY()
                          throws ContradictionException
Throws:
ContradictionException

filterFixPoint

public void filterFixPoint()
                    throws ContradictionException
Throws:
ContradictionException

awakeOnInf

public void awakeOnInf(int idx)
                throws ContradictionException
Description copied from class: AbstractIntSConstraint
Default propagation on improved lower bound: propagation on domain revision.

Specified by:
awakeOnInf in interface IntPropagator
Overrides:
awakeOnInf in class AbstractIntSConstraint
Throws:
ContradictionException

awakeOnSup

public void awakeOnSup(int idx)
                throws ContradictionException
Description copied from class: AbstractIntSConstraint
Default propagation on improved upper bound: propagation on domain revision.

Specified by:
awakeOnSup in interface IntPropagator
Overrides:
awakeOnSup in class AbstractIntSConstraint
Throws:
ContradictionException

awakeOnInst

public void awakeOnInst(int idx)
                 throws ContradictionException
Description copied from class: AbstractIntSConstraint
Default propagation on instantiation: full constraint re-propagation.

Specified by:
awakeOnInst in interface IntPropagator
Overrides:
awakeOnInst in class AbstractIntSConstraint
Throws:
ContradictionException

awakeOnBounds

public void awakeOnBounds(int varIndex)
                   throws ContradictionException
Specified by:
awakeOnBounds in interface IntPropagator
Overrides:
awakeOnBounds in class AbstractIntSConstraint
Throws:
ContradictionException

awakeOnRemovals

public void awakeOnRemovals(int idx,
                            DisposableIntIterator deltaDomain)
                     throws ContradictionException
Description copied from class: AbstractIntSConstraint
The default implementation of propagation when a variable has been modified consists in iterating all values that have been removed (the delta domain) and propagate them one after another, incrementally.

Specified by:
awakeOnRemovals in interface IntPropagator
Overrides:
awakeOnRemovals in class AbstractIntSConstraint
Throws:
ContradictionException

propagate

public void propagate()
               throws ContradictionException
Description copied from class: Propagator
Propagation: Propagating the constraint until local consistency is reached.

Specified by:
propagate in class Propagator
Throws:
ContradictionException - contradiction exception

toString

public String toString()
Overrides:
toString in class AbstractSConstraint<IntDomainVar>

pretty

public String pretty()
Description copied from interface: IPretty
pretty printing of the object. This String is not constant and may depend on the context.

Specified by:
pretty in interface IPretty
Overrides:
pretty in class AbstractSConstraint<IntDomainVar>
Returns:
a readable string representation of the object

isEntailed

public Boolean isEntailed()
Description copied from class: AbstractSConstraint
Indicates if the constraint is entailed, from now on will be always satisfied

Overrides:
isEntailed in class AbstractSConstraint<IntDomainVar>
Returns:
wether the constraint is entailed

isSatisfied

public boolean isSatisfied(int[] tuple)
Description copied from class: AbstractIntSConstraint
TEMPORARY: if not overriden by the constraint, throws an error to avoid bug using reified constraints in constraints that have not been changed to fulfill this api yet !

Specified by:
isSatisfied in interface IntPropagator
Overrides:
isSatisfied in class AbstractIntSConstraint


Copyright © 2012. All Rights Reserved.