org.metacsp.framework.multi

Class MultiBinaryConstraint

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.multi.MultiConstraint

org.metacsp.framework.multi.MultiBinaryConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AllenIntervalConstraint, BlockAlgebraConstraint, DistanceConstraint, RectangleConstraint, UnaryBlockConstraint, UnaryRectangleConstraint

public abstract class MultiBinaryConstraint
extends MultiConstraint

This class is used to represent binay constraints among MultiVariables.

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields inherited from class org.metacsp.framework.multi.MultiConstraint

constraints

Fields inherited from class org.metacsp.framework.Constraint

annotation, autoRemovable, color, id, logger, masked, numIDs, scope

Constructor Summary

Constructors

Constructor and Description
MultiBinaryConstraint() Instantiates a new MultiBinaryConstraint, sets its scope to have size 2.

Method Summary

Modifier and Type	Method and Description
protected Constraint[]	createInternalConstraints(Variable[] variables) This method must be implemented by the implementing class, and should instantiate the internal constraints underlying this MultiConstraint.
protected abstract Constraint[]	createInternalConstraints(Variable from, Variable to) This method must be defined to create the internal constraints underlying this MultiBinaryConstraint.
Variable	getFrom() Get the source Variable of this MultiBinaryConstraint.
Variable	getTo() Get the destination Variable of this MultiBinaryConstraint.
void	setFrom(Variable mv) Set the source Variable of this MultiBinaryConstraint.
void	setTo(Variable mv) Set the destination Variable of this MultiBinaryConstraint.
java.lang.String	toString() Every Constraint should implement a toString method (used by the ConstraintNetwork rendering methods).

Methods inherited from class org.metacsp.framework.multi.MultiConstraint

clone, getDescription, getInternalConstraints, propagateImmediately, setPropagateImmediately, setPropagateLater

Methods inherited from class org.metacsp.framework.Constraint

getAnnotation, getColor, getEdgeLabel, getID, getScope, isAutoRemovable, isEquivalent, isMasked, isSkippableSolver, isUnary, mask, setAnnotation, setAutoRemovable, setColor, setScope, skipSolver, unmask

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiBinaryConstraint

public MultiBinaryConstraint()

Instantiates a new MultiBinaryConstraint, sets its scope to have size 2.

Method Detail

createInternalConstraints

protected Constraint[] createInternalConstraints(Variable[] variables)

Description copied from class: MultiConstraint

This method must be implemented by the implementing class, and should instantiate the internal constraints underlying this MultiConstraint.

Specified by:

createInternalConstraints in class MultiConstraint

Parameters:

variables - The Variables that are in the scope of this MultiConstraint.

Returns:

An array of lower-level constraints which "implement" this MultiConstraint.

createInternalConstraints

protected abstract Constraint[] createInternalConstraints(Variable from,
                                                          Variable to)

This method must be defined to create the internal constraints underlying this MultiBinaryConstraint.

Parameters:

from - The source Variable of the MultiConstraint.

to - The destination Variable of the MultiConstraint.

Returns:

An array of lower-level constraints which "implement" this MultiBinaryConstraint.

getFrom

public Variable getFrom()

Get the source Variable of this MultiBinaryConstraint.

Returns:

The source Variable of this MultiBinaryConstraint.

getTo

public Variable getTo()

Get the destination Variable of this MultiBinaryConstraint.

Returns:

The destination Variable of this MultiBinaryConstraint.

setFrom

public void setFrom(Variable mv)

Set the source Variable of this MultiBinaryConstraint.

Parameters:

mv - The source Variable of this MultiBinaryConstraint.

setTo

public void setTo(Variable mv)

Set the destination Variable of this MultiBinaryConstraint.

Parameters:

mv - The destination Variable of this MultiBinaryConstraint.

toString

public java.lang.String toString()

Description copied from class: Constraint

Every Constraint should implement a toString method (used by the ConstraintNetwork rendering methods).

Specified by:

toString in class Constraint

Returns:

the String representation of this Constraint.