choco.integer.constraints
Class AbstractBinIntConstraint

java.lang.Object
  choco.AbstractEntity
      choco.AbstractConstraint
          choco.integer.constraints.AbstractIntConstraint
              choco.integer.constraints.AbstractBinIntConstraint

All Implemented Interfaces:

Constraint, Entity, IntConstraint, IntVarEventListener, VarEventListener, Propagator, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

AbstractPalmBinIntConstraint, BooleanChanneling, CspBinConstraint, Element, EqualXYC, GreaterOrEqualXYC, NotEqualXYC

public abstract class AbstractBinIntConstraint
extends AbstractIntConstraint

An abstract class for all implementations of (binary) constraints over two search variable.

Field Summary

int	cIdx0 The index of the constraint among all listeners of its first variable.
int	cIdx1 The index of the constraint among all listeners of its second variable.
IntDomainVar	v0 The first variable of the constraint.
IntDomainVar	v1 The second variable of the constraint.

Fields inherited from class choco.integer.constraints.AbstractIntConstraint

logger

Fields inherited from class choco.AbstractConstraint

active, constAwakeEvent, hook, priority

Fields inherited from class choco.AbstractEntity

problem

Constructor Summary

AbstractBinIntConstraint(IntDomainVar x0, IntDomainVar x1)

Method Summary

int	assignIndices(AbstractCompositeConstraint root, int i, boolean dynamicAddition) performs the global numbering (wrt root) of the variables contained in the subtree this, starting from i
int	getConstraintIdx(int idx) Returns the index of this constraint for the specified variables.
IntDomainVar	getIntVar(int i) Gets the ith search valued variable.
int	getNbVars() Returns the number of varibles.
Var	getVar(int i) Returns the specified variable.
boolean	isCompletelyInstantiated() Checks if all the variables are instantiated.
void	propagate() Propagates on the constraint awake events.
void	setConstraintIndex(int i, int val) Let v be the i-th var of c, records that c is the n-th constraint involving v.
void	setVar(int i, Var v) Network management: Setting (or overwriting) the ith variable of a constraint.

Methods inherited from class choco.integer.constraints.AbstractIntConstraint

awakeOnBounds, awakeOnInf, awakeOnInst, awakeOnRem, awakeOnRemovals, awakeOnSup, getSelfIndex, isConsistent

Methods inherited from class choco.AbstractConstraint

addListener, awake, awakeOnVar, clone, connectVar, constAwake, delete, fail, getEvent, getPlugIn, getPriority, getProblem, getVarIdxInOpposite, isActive, isEntailed, isEquivalentTo, opposite, setActive, setEntailed, setPassive, setPlugIn, substituteVar

Methods inherited from class choco.AbstractEntity

pretty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface choco.Propagator

awake, awakeOnVar, constAwake, delete, getEvent, getPlugIn, getPriority, isEntailed

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Methods inherited from interface choco.prop.VarEventListener

addListener, isActive, setActive, setPassive

Field Detail

v0

public IntDomainVar v0

The first variable of the constraint.

v1

public IntDomainVar v1

The second variable of the constraint.

cIdx0

public int cIdx0

The index of the constraint among all listeners of its first variable.

cIdx1

public int cIdx1

The index of the constraint among all listeners of its second variable.

Constructor Detail

AbstractBinIntConstraint

public AbstractBinIntConstraint(IntDomainVar x0,
                                IntDomainVar x1)

Method Detail

setConstraintIndex

public void setConstraintIndex(int i,
                               int val)

Let v be the i-th var of c, records that c is the n-th constraint involving v.

Parameters:

i - index of the variable in the constraint

val - index of the constraint in the among all listeners linked to that variable

getConstraintIdx

public int getConstraintIdx(int idx)

Returns the index of this constraint for the specified variables.

Parameters:

idx - index of the variable in the constraint

isCompletelyInstantiated

public boolean isCompletelyInstantiated()

Checks if all the variables are instantiated.

Specified by:

isCompletelyInstantiated in interface Propagator

Overrides:

isCompletelyInstantiated in class AbstractIntConstraint

getNbVars

public int getNbVars()

Returns the number of varibles.

getVar

public Var getVar(int i)

Returns the specified variable.

Parameters:

i - index of the variable in the constraint

setVar

public void setVar(int i,
                   Var v)

Description copied from interface: Constraint

Network management: Setting (or overwriting) the ith variable of a constraint.

Parameters:

i - index of the variable in the constraint

v - the variable (may be an IntDomainVar, SetVar, RealVar, ...

propagate

public void propagate()
               throws ContradictionException

Propagates on the constraint awake events.

Throws:

ContradictionException

getIntVar

public IntDomainVar getIntVar(int i)

Gets the ith search valued variable.

Parameters:

i - index of the variable among all search variables in the constraint. Numbering start from 0 on.

Returns:

the variable, or null when no such variable is found

assignIndices

public int assignIndices(AbstractCompositeConstraint root,
                         int i,
                         boolean dynamicAddition)

Description copied from interface: Propagator

performs the global numbering (wrt root) of the variables contained in the subtree this, starting from i

Parameters:

root - the overall root constraint, for which the variables are numbered

i - the index that will assigned to the first variable in the subtree this (originally 0)

dynamicAddition - whether the addition is undone automatically on backtracking

Returns:

the index of the last variable in the subtree