Class PropSum
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<IntVar>
-
- org.chocosolver.solver.constraints.nary.sum.PropSum
-
- All Implemented Interfaces:
Comparable<Propagator>,ICause,Identity
- Direct Known Subclasses:
PropScalar,PropSumBool,PropSumFullBool
public class PropSum extends Propagator<IntVar>
A propagator for SUM(x_i) o b
Based on "Bounds Consistency Techniques for Long Linear Constraint" W. Harvey and J. Schimpf- Since:
- 18/03/11
- Author:
- Charles Prud'homme
-
-
Field Summary
Fields Modifier and Type Field Description protected intbBound to respectprotected int[]IVariability of each variable (ie domain amplitude)protected intlNumber of variablesprotected intmaxIStores the maximal variabilityprotected OperatoroThe operator among EQ, LE, GE and NEprotected intposThe position of the last positive coefficientprotected intsumLBSUm of lower boundsprotected intsumUBSum of upper bounds-
Fields inherited from class org.chocosolver.solver.constraints.Propagator
constraint, model, priority, reactToFineEvt, vars
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ESatcheck(int sumLB, int sumUB)Whether the current state of the scalar product is entailedprotected static PropagatorPrioritycomputePriority(int nbvars)Compute the priority of the propagator wrt the number of involved variablesprotected voidfilter()Execute filtering wrt the operatorprotected voidfilterOnEq()Apply filtering when operator is EQprotected voidfilterOnGeq()Apply filtering when operator is GEprotected voidfilterOnLeq()Apply filtering when operator is LEprotected voidfilterOnNeq()Apply filtering when operator is NEintgetPropagationConditions(int vIdx)Returns the specific mask indicating the variable events on which thisPropagatorobject can react.
A mask is a bitwise OR operations overIEventTypethis can react on.ESatisEntailed()Check wetherthisis entailed according to the current state of its internal structure.static intnb(Operator co)static Operatornop(Operator co)protected PropSumopposite()protected voidprepare()Prepare the propagation: compute sumLB, sumUB and Ivoidpropagate(int evtmask)Call the main filtering algorithm to apply to theDomainof theVariableobjects.StringtoString()booleanwhy(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, arity, compareTo, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, fails, forcePropagate, forcePropagationOnBacktrack, getConstraint, getId, getModel, getNbVars, getPosition, getPriority, getVar, getVars, getVIndice, getVIndices, hashCode, isActive, isCompletelyInstantiated, isPassive, isReifiedAndSilent, isStateLess, linkVariables, propagate, reactToFineEvent, setActive, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, unlinkVariables, unschedule
-
-
-
-
Field Detail
-
pos
protected final int pos
The position of the last positive coefficient
-
l
protected final int l
Number of variables
-
b
protected final int b
Bound to respect
-
I
protected final int[] I
Variability of each variable (ie domain amplitude)
-
maxI
protected int maxI
Stores the maximal variability
-
sumLB
protected int sumLB
SUm of lower bounds
-
sumUB
protected int sumUB
Sum of upper bounds
-
o
protected final Operator o
The operator among EQ, LE, GE and NE
-
-
Constructor Detail
-
PropSum
public PropSum(IntVar[] variables, int pos, Operator o, int b)
Creates a sum propagator: SUM(x_i) o b Coefficients are induced bypos: those beforepos(included) are equal to 1, the other ones are equal to -1.- Parameters:
variables- list of integer variablespos- position of the last positive coefficiento- operator amng EQ, LE, GE and NEb- bound to respect
-
-
Method Detail
-
computePriority
protected static PropagatorPriority computePriority(int nbvars)
Compute the priority of the propagator wrt the number of involved variables- Parameters:
nbvars- number of variables- Returns:
- the priority
-
getPropagationConditions
public int getPropagationConditions(int vIdx)
Description copied from class:PropagatorReturns the specific mask indicating the variable events on which thisPropagatorobject can react.
A mask is a bitwise OR operations overIEventTypethis 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.VOIDwhich states that this propagator should not be aware of modifications applied to the variable in position vIdx.- Overrides:
getPropagationConditionsin classPropagator<IntVar>- Parameters:
vIdx- index of the variable within the propagator- Returns:
- an int composed of
REMOVEand/orINSTANTIATEand/orDECUPPand/orINCLOW
-
prepare
protected void prepare()
Prepare the propagation: compute sumLB, sumUB and I
-
propagate
public void propagate(int evtmask) throws ContradictionExceptionDescription copied from class:PropagatorCall the main filtering algorithm to apply to theDomainof theVariableobjects. 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:
propagatein classPropagator<IntVar>- Parameters:
evtmask- type of propagation eventthismust consider.- Throws:
ContradictionException- when a contradiction occurs, like domain wipe out or other incoherencies.
-
filter
protected void filter() throws ContradictionExceptionExecute filtering wrt the operator- Throws:
ContradictionException- if contradiction is detected
-
filterOnEq
protected void filterOnEq() throws ContradictionExceptionApply filtering when operator is EQ- Throws:
ContradictionException- if contradiction is detected
-
filterOnLeq
protected void filterOnLeq() throws ContradictionExceptionApply filtering when operator is LE- Throws:
ContradictionException- if contradiction is detected
-
filterOnGeq
protected void filterOnGeq() throws ContradictionExceptionApply filtering when operator is GE- Throws:
ContradictionException- if contradiction is detected
-
filterOnNeq
protected void filterOnNeq() throws ContradictionExceptionApply filtering when operator is NE- Throws:
ContradictionException- if contradiction is detected
-
isEntailed
public ESat isEntailed()
Description copied from class:PropagatorCheck wetherthisis entailed according to the current state of its internal structure. At least, should check the satisfaction ofthis(when all is instantiated).- Specified by:
isEntailedin classPropagator<IntVar>- Returns:
- ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown
-
check
public ESat check(int sumLB, int sumUB)
Whether the current state of the scalar product is entailed- Parameters:
sumLB- sum of lower boundssumUB- sum of upper bounds- Returns:
- the entailment check
-
toString
public String toString()
- Overrides:
toStringin classPropagator<IntVar>
-
why
public boolean why(RuleStore ruleStore, IntVar var, IEventType evt, int value)
Description copied from interface:ICauseAdd new rules to the rule store- Specified by:
whyin interfaceICause- Overrides:
whyin classPropagator<IntVar>- Parameters:
ruleStore- the rule storevar- the modified variableevt- the undergoing eventvalue- the value (for REMOVE only)- Returns:
- true if at least one rule has been added to the rule store
-
nb
public static int nb(Operator co)
-
opposite
protected PropSum opposite()
-
-