Module org.chocosolver

Package org.chocosolver.solver.constraints.nary.sum

Class PropScalar

java.lang.Object

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

org.chocosolver.solver.constraints.nary.sum.PropSum

org.chocosolver.solver.constraints.nary.sum.PropScalar

All Implemented Interfaces:

Comparable<Propagator>, ICause, Identity

public class PropScalar
extends PropSum

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 inherited from class org.chocosolver.solver.constraints.nary.sum.PropSum

b, I, l, maxI, o, pos, sumLB, sumUB

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
PropScalar(IntVar[] variables, int[] coeffs, int pos, Operator o, int b)	Create a scalar product: SUM(x_i*c_i) o b Variables and coefficients are excepted to be ordered wrt to coefficients: first positive ones then negative ones.

Method Summary

Modifier and Type	Method	Description
protected void	explainGlobal(ExplanationForSignedClause explanation, ValueSortedMap<IntVar> front, Implications ig, int F, int E)
protected void	filterOnEq()	Apply filtering when operator is EQ
protected void	filterOnGeq()	Apply filtering when operator is GE
protected void	filterOnLeq()	Apply filtering when operator is LE
protected void	filterOnNeq()	Apply filtering when operator is NE
ESat	isEntailed()	Check wether this is entailed according to the current state of its internal structure.
protected PropSum	opposite()
protected void	prepare()	Prepare the propagation: compute sumLB, sumUB and I
String	toString()

Methods inherited from class org.chocosolver.solver.constraints.nary.sum.PropSum

check, computePriority, explain, filter, getPropagationConditions, nb, nop, propagate

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

addVariable, arity, compareTo, defaultExplain, doFinePropagation, doFlush, doSchedule, doScheduleEvent, dynPriority, equals, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropScalar

public PropScalar(IntVar[] variables,
                  int[] coeffs,
                  int pos,
                  Operator o,
                  int b)

Create a scalar product: SUM(x_i*c_i) o b Variables and coefficients are excepted to be ordered wrt to coefficients: first positive ones then negative ones.

Parameters:

variables - list of integer variables

coeffs - list of coefficients

pos - position of the last positive coefficient

o - operator

b - bound to respect.

Method Detail

prepare

protected void prepare()

Description copied from class: PropSum

Prepare the propagation: compute sumLB, sumUB and I

Overrides:

prepare in class PropSum

filterOnEq

protected void filterOnEq()
                   throws ContradictionException

Description copied from class: PropSum

Apply filtering when operator is EQ

Overrides:

filterOnEq in class PropSum

Throws:

ContradictionException - if contradiction is detected

filterOnLeq

protected void filterOnLeq()
                    throws ContradictionException

Description copied from class: PropSum

Apply filtering when operator is LE

Overrides:

filterOnLeq in class PropSum

Throws:

ContradictionException - if contradiction is detected

filterOnGeq

protected void filterOnGeq()
                    throws ContradictionException

Description copied from class: PropSum

Apply filtering when operator is GE

Overrides:

filterOnGeq in class PropSum

Throws:

ContradictionException - if contradiction is detected

filterOnNeq

protected void filterOnNeq()
                    throws ContradictionException

Description copied from class: PropSum

Apply filtering when operator is NE

Overrides:

filterOnNeq in class PropSum

Throws:

ContradictionException - if contradiction is detected

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).

Overrides:

isEntailed in class PropSum

Returns:

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

explainGlobal

protected void explainGlobal(ExplanationForSignedClause explanation,
                             ValueSortedMap<IntVar> front,
                             Implications ig,
                             int F,
                             int E)

Overrides:

explainGlobal in class PropSum

toString

public String toString()

Overrides:

toString in class PropSum

opposite

protected PropSum opposite()

Overrides:

opposite in class PropSum