Class PropScalarMixed
- java.lang.Object
-
- org.chocosolver.solver.constraints.Propagator<Variable>
-
- org.chocosolver.solver.constraints.real.PropScalarMixed
-
- All Implemented Interfaces:
Comparable<Propagator>
,ICause
,Identity
public class PropScalarMixed extends Propagator<Variable>
A propagator for SUM(x_i*c_i) = 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 double
b
Bound to respectprotected double[]
I
Variability of each variable (ie domain amplitude)protected int
l
Number of variablesprotected double
maxI
Stores the maximal variabilityprotected Operator
o
The operator among EQ, LE, GE and NEprotected double
sumLB
SUm of lower boundsprotected double
sumUB
Sum of upper bounds-
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 PropScalarMixed(Variable[] variables, double[] coeffs, Operator o, double b)
Create a scalar product: SCALAR(x_i*c_i) o b
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ESat
check(double sumLB, double sumUB)
Whether the current state of the scalar product is entailedprotected void
filter()
Execute filtering wrt the operatorprotected void
filterOnEq()
protected void
filterOnGeq()
protected void
filterOnLeq()
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.protected void
prepare()
void
propagate(int evtmask)
Call the main filtering algorithm to apply to theDomain
of theVariable
objects.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, propagate, reactToFineEvent, reifiedWith, setActive, setActive0, setPassive, setPosition, setReifiedSilent, setReifiedTrue, setVIndices, unlinkVariables, unschedule
-
-
-
-
Field Detail
-
l
protected final int l
Number of variables
-
b
protected final double b
Bound to respect
-
I
protected final double[] I
Variability of each variable (ie domain amplitude)
-
maxI
protected double maxI
Stores the maximal variability
-
sumLB
protected double sumLB
SUm of lower bounds
-
sumUB
protected double sumUB
Sum of upper bounds
-
o
protected final Operator o
The operator among EQ, LE, GE and NE
-
-
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.
-
filter
protected void filter() throws ContradictionException
Execute filtering wrt the operator- Throws:
ContradictionException
- if contradiction is detected
-
prepare
protected void prepare()
-
filterOnEq
protected void filterOnEq() throws ContradictionException
- Throws:
ContradictionException
-
filterOnLeq
protected void filterOnLeq() throws ContradictionException
- Throws:
ContradictionException
-
filterOnGeq
protected void filterOnGeq() throws ContradictionException
- Throws:
ContradictionException
-
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
-
check
protected ESat check(double sumLB, double 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:
toString
in classPropagator<Variable>
-
-