org.metacsp.framework.multi

Class MultiConstraint

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.multi.MultiConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MultiBinaryConstraint, SymbolicValueConstraint

public abstract class MultiConstraint
extends Constraint

A MultiConstraint is a constraint among Variables that could be MultiVariables. Every MultiConstraint is "implemented" one or more lower-level constraints - see, e.g., the AllenIntervalConstraint.

Author:

Federico Pecora

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Constraint[]	constraints

Fields inherited from class org.metacsp.framework.Constraint

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

Constructor Summary

Constructors

Constructor and Description
MultiConstraint() Instantiates a MultiConstraint.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	clone() A MultiConstraint must be cloneable.
protected abstract Constraint[]	createInternalConstraints(Variable[] variables) This method must be implemented by the implementing class, and should instantiate the internal constraints underlying this MultiConstraint.
java.lang.String	getDescription() Get the description of this Constraint's type.
Constraint[]	getInternalConstraints() Get the lower-level constraints underlying of this MultiConstraint.
boolean	propagateImmediately() A MultiConstraint can be scheduled for propagation immediately (as soon as it is added) or later.
void	setPropagateImmediately() Schedules this MultiConstraint for immediate propagation.
void	setPropagateLater() Delays the propagation of this MultiConstraint.

Methods inherited from class org.metacsp.framework.Constraint

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

Methods inherited from class java.lang.Object

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

Field Detail

constraints

protected Constraint[] constraints

Constructor Detail

MultiConstraint

public MultiConstraint()

Instantiates a MultiConstraint. This constructor must be called by the constructor of the implementing class.

Method Detail

createInternalConstraints

protected abstract Constraint[] createInternalConstraints(Variable[] variables)

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

Parameters:

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

Returns:

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

getInternalConstraints

public Constraint[] getInternalConstraints()

Get the lower-level constraints underlying of this MultiConstraint.

Returns:

An array of lower-level constraints underlying of this MultiConstraint.

clone

public abstract java.lang.Object clone()

A MultiConstraint must be cloneable. This is used by the MultiConstraintSolver class to instantiate proper constraints to delegate its underlying ConstraintSolvers.

Specified by:

clone in class Constraint

setPropagateLater

public void setPropagateLater()

Delays the propagation of this MultiConstraint.

setPropagateImmediately

public void setPropagateImmediately()

Schedules this MultiConstraint for immediate propagation.

propagateImmediately

public boolean propagateImmediately()

A MultiConstraint can be scheduled for propagation immediately (as soon as it is added) or later. This is used internally by the ConstraintSolver to delay propagation of a MultiConstraint in cases where the underlying constraints should be propagated first. By default, MultiConstraints are propagated immediately.

Returns:

true iff this constraint should be propagated as soon as possible.

getDescription

public java.lang.String getDescription()

Description copied from class: Constraint

Get the description of this Constraint's type.

Overrides:

getDescription in class Constraint

Returns:

The description of this Constraint's type.