Class PropSumOfElements
 java.lang.Object

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

 org.chocosolver.solver.constraints.set.PropSumOfElements

 All Implemented Interfaces:
Comparable<Propagator>
,ICause
,Identity
public class PropSumOfElements extends Propagator<Variable>
Sums elements given by a set variable Author:
 JeanGuillaume Fages


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 PropSumOfElements(SetVar setVar, int[] weights, int offset, IntVar sum)
Sums elements given by a set variable: if(weights !

Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getPropagationConditions(int vIdx)
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.
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, propagate, reactToFineEvent, reifiedWith, setActive, setActive0, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, toString, unlinkVariables, unschedule




Constructor Detail

PropSumOfElements
public PropSumOfElements(SetVar setVar, int[] weights, int offset, IntVar sum)
Sums elements given by a set variable: if(weights !=null){ SUM(weights[ioffset]  i in setVar) = sum (also ensures indexes is a subset of [offset, offset+weights.length1]) }else{ SUM(i  i in setVar) = sum } Parameters:
setVar
 a set variableweights
 array of int (can be null to sum the indexes)offset
 offset to access array cells (0 in Java, 1 in MiniZinc)sum
 integer variable representing the sum over the set


Method Detail

getPropagationConditions
public int getPropagationConditions(int vIdx)
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<Variable>
 Parameters:
vIdx
 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<Variable>
 Parameters:
evtmask
 type of propagation eventthis
must consider. Throws:
ContradictionException
 when a contradiction occurs, like domain wipe out or other incoherencies.

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<Variable>
 Returns:
 ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown

