org.metacsp.framework.multi

Class MultiConstraintSolver

java.lang.Object

org.metacsp.framework.ConstraintSolver

org.metacsp.framework.multi.MultiConstraintSolver

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActivityNetworkSolver, AllenIntervalNetworkSolver, BlockConstraintSolver, DistanceConstraintSolver, FuzzyActivityNetworkSolver, FuzzySetActivityNetworkSolver, MetaConstraintSolver, MultiSolverDebug, RectangleConstraintSolver, SpatialFluentSolver, SpatialFluentSolver2, SpatioTemporalVariableSolver, SymbolicVariableConstraintSolver, TrajectoryEnvelopeSolver

public abstract class MultiConstraintSolver
extends ConstraintSolver

This class extends the ConstraintSolver class providing functionality to deal with MultiVariables and MultiConstraints. It should be extended to create new MultiConstraintSolvers. In doing so, the designer should define how variables are created (methods createVariableSub() and createVariablesSub()), how to create internal constraint solvers underlying this MultiConstraintSolver (method createConstraintSolvers()) and how propagation should occur (method propagate()). Note that if propagation occurs by means of the underlying constraint solvers, the propagate() method can left empty (return true).

Author:

Federico Pecora

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiConstraintSolver.OPTIONS These are options used by the ConstraintSolver class to determine whether inconsistencies should be allowed in the constraitn networks of the underlying constraint solvers.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConstraintSolver[]	constraintSolvers
protected int[]	ingredients

Fields inherited from class org.metacsp.framework.ConstraintSolver

autoprop, components, constraintTypes, IDs, logger, name, nesting, noPropOnVarCreation, numcalls, skipPropagation, spacing, theNetwork, variableType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiConstraintSolver(java.lang.Class<?>[] constraintTypes, java.lang.Class<?> variableType, ConstraintSolver[] internalSolvers, int[] ingredients) The constructor of a extending class must call this constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	addConstraintsSub(Constraint[] c) This method must be implemented by the developer of the specific ConstraintSolver class.
protected Variable[]	createVariablesSub(int num) This method must be implemented by the developer of the specific ConstraintSolver class.
protected Variable[]	createVariablesSub(int[] ingredients, int num, java.lang.String component) This method creates num MultiVariables.
protected Variable[]	createVariablesSub(int num, java.lang.String component) This method must be implemented by the developer of the specific ConstraintSolver class.
static void	drawConstraintNetworkHierarchy(edu.uci.ics.jung.graph.DelegateTree<ConstraintNetwork,java.lang.String> tree) Draw a hierarchy of ConstraintNetworks.
static void	drawConstraintSolverHierarchy(edu.uci.ics.jung.graph.DelegateTree<ConstraintSolver,java.lang.String> tree) Draw a hierarchy of ConstraintSolvers.
void	failurePruning(int failure_time)
edu.uci.ics.jung.graph.DelegateTree<ConstraintNetwork,java.lang.String>	getConstraintNetworkHierarchy() Get a tree whose nodes are the constraint networks managed by the hierarchy of ConstraintSolvers underlying this MultiConstraintSolver.
ConstraintNetwork[]	getConstraintNetworksFromSolverHierarchy(java.lang.Class<?> cl) Get all ConstraintNetworks underlying ConstraintSolvers of a given type in this MultiConstraintSolver's hierarchy of solvers.
static ConstraintSolver	getConstraintSolver(ConstraintSolver cs, java.lang.Class<?> constraintSolverClass)
edu.uci.ics.jung.graph.DelegateTree<ConstraintSolver,java.lang.String>	getConstraintSolverHierarchy() Get the hierarchy of ConstraintSolvers rooted in this MultiConstraintSolver.
ConstraintSolver[]	getConstraintSolvers() Get the ConstraintSolvers underlying this MultiConstraintSolver.
ConstraintSolver[]	getConstraintSolversFromConstraintSolverHierarchy(java.lang.Class<?> cl) Get the ConstraintSolvers of a given type from this MultiConstraintSolver's hierarchy of ConstraintSolvers.
java.lang.String	getDescription() Gets a description of this ConstraintSolver stating which variable and constraint types it supports.
boolean	getOption(MultiConstraintSolver.OPTIONS op) Method to get options of this MultiConstraintSolver (see MultiConstraintSolver.OPTIONS).
abstract boolean	propagate() Propagate the constraint network.
void	registerValueChoiceFunctions()
protected void	removeConstraintsSub(Constraint[] c) This method must be implemented by the developer of the specific ConstraintSolver class.
protected void	removeVariablesSub(Variable[] v) This method must be implemented by the developer of the specific ConstraintSolver class.
void	setConstraintSolver(int i, ConstraintSolver cSolver)
void	setIngredients(int[] ingredients) Set the number of internal variables of different types that are to be created when calling the method createVariables().
void	setOptions(MultiConstraintSolver.OPTIONS... ops) Method to set the options for this MultiConstraintSolver (see MultiConstraintSolver.OPTIONS).

Methods inherited from class org.metacsp.framework.ConstraintSolver

addConstraint, addConstraintNoPropagation, addConstraints, addConstraintsDebug, addConstraintsNoPropagation, containsVariable, createVariable, createVariable, createVariables, createVariables, deplenish, getComponent, getComponents, getConstraintNetwork, getConstraints, getConstraints, getID, getOption, getVariable, getVariables, getVariables, getVariables, isCompatible, maskConstraints, removeConstraint, removeConstraints, removeVariable, removeVariables, setComponent, setComponents, setConstraintNetwork, setName, setOptions, toString, unmaskConstraints

Methods inherited from class java.lang.Object

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

Field Detail

constraintSolvers

protected ConstraintSolver[] constraintSolvers

ingredients

protected int[] ingredients

Constructor Detail

MultiConstraintSolver

protected MultiConstraintSolver(java.lang.Class<?>[] constraintTypes,
                                java.lang.Class<?> variableType,
                                ConstraintSolver[] internalSolvers,
                                int[] ingredients)

The constructor of a extending class must call this constructor.

Parameters:

constraintTypes -

internalSolvers -

Method Detail

getConstraintSolver

public static ConstraintSolver getConstraintSolver(ConstraintSolver cs,
                                                   java.lang.Class<?> constraintSolverClass)

setOptions

public void setOptions(MultiConstraintSolver.OPTIONS... ops)

Method to set the options for this MultiConstraintSolver (see MultiConstraintSolver.OPTIONS).

Parameters:

ops - Options to set (see MultiConstraintSolver.OPTIONS).

getOption

public boolean getOption(MultiConstraintSolver.OPTIONS op)

Method to get options of this MultiConstraintSolver (see MultiConstraintSolver.OPTIONS).

Parameters:

op - The option that should be checked

Returns:

true iff the given option was set

setIngredients

public void setIngredients(int[] ingredients)

Set the number of internal variables of different types that are to be created when calling the method createVariables().

Parameters:

ingredients - The number of internal variables, oen number for each type, that are to be created.

addConstraintsSub

protected final boolean addConstraintsSub(Constraint[] c)

Description copied from class: ConstraintSolver

This method must be implemented by the developer of the specific ConstraintSolver class. It should implement all operations necessary to add multiple constraints, and should return true upon success, false otherwise.

Specified by:

addConstraintsSub in class ConstraintSolver

Parameters:

c - The constraints to add.

Returns:

true iff the constraints were added to the ConstraintNetwork.

removeVariablesSub

protected final void removeVariablesSub(Variable[] v)

Description copied from class: ConstraintSolver

This method must be implemented by the developer of the specific ConstraintSolver class. It should implement all operations necessary to remove a batch of variables for the specific type of ConstraintSolver.

Specified by:

removeVariablesSub in class ConstraintSolver

Parameters:

v - The Variables to remove.

createVariablesSub

protected Variable[] createVariablesSub(int[] ingredients,
                                        int num,
                                        java.lang.String component)

This method creates num MultiVariables. The creation of internal variables is taken care of automatically, given a specification of the number of internal variables to create for each internal solver.

Parameters:

ingredients - The number of internal variables to create for each internal solver.

num - The number of MultiVariables for which internal variables are to be created.

component - The label (component) the created variables should be associated with.

Returns:

The Variables for num MultiVariables.

createVariablesSub

protected final Variable[] createVariablesSub(int num)

Description copied from class: ConstraintSolver

This method must be implemented by the developer of the specific ConstraintSolver class. It should implement all operations necessary to create a batch of variable for the specific type of ConstraintSolver.

Specified by:

createVariablesSub in class ConstraintSolver

Parameters:

num - The number of variables to create.

Returns:

A batch of new Variable for this ConstraintSolver.

createVariablesSub

protected final Variable[] createVariablesSub(int num,
                                              java.lang.String component)

Description copied from class: ConstraintSolver

This method must be implemented by the developer of the specific ConstraintSolver class. It should implement all operations necessary to create a batch of variable for the specific type of ConstraintSolver.

Overrides:

createVariablesSub in class ConstraintSolver

Parameters:

num - The number of Variables to create.

component - The component label to associate to the new Variables.

Returns:

A batch of new Variable for this ConstraintSolver.

propagate

public abstract boolean propagate()

Description copied from class: ConstraintSolver

Propagate the constraint network.

Specified by:

propagate in class ConstraintSolver

Returns:

A boolean value indicating whether propagation was successful.

removeConstraintsSub

protected final void removeConstraintsSub(Constraint[] c)

Description copied from class: ConstraintSolver

This method must be implemented by the developer of the specific ConstraintSolver class. Should implement all operations necessary to remove a batch of constraints.

Specified by:

removeConstraintsSub in class ConstraintSolver

Parameters:

c - The constraints to remove.

getConstraintSolvers

public ConstraintSolver[] getConstraintSolvers()

Get the ConstraintSolvers underlying this MultiConstraintSolver.

Returns:

The ConstraintSolvers underlying this MultiConstraintSolver.

setConstraintSolver

public void setConstraintSolver(int i,
                                ConstraintSolver cSolver)

getDescription

public java.lang.String getDescription()

Description copied from class: ConstraintSolver

Gets a description of this ConstraintSolver stating which variable and constraint types it supports.

Overrides:

getDescription in class ConstraintSolver

Returns:

A description of this ConstraintSolver stating which variable and constraint types it supports.

getConstraintSolverHierarchy

public edu.uci.ics.jung.graph.DelegateTree<ConstraintSolver,java.lang.String> getConstraintSolverHierarchy()

Get the hierarchy of ConstraintSolvers rooted in this MultiConstraintSolver.

Returns:

The hierarchy of ConstraintSolvers rooted in this MultiConstraintSolver.

getConstraintSolversFromConstraintSolverHierarchy

public ConstraintSolver[] getConstraintSolversFromConstraintSolverHierarchy(java.lang.Class<?> cl)

Get the ConstraintSolvers of a given type from this MultiConstraintSolver's hierarchy of ConstraintSolvers.

Parameters:

cl - The type of ConstraintSolvers to get.

Returns:

All ConstraintSolvers of the given type in this MultiConstraintSolver's hierarchy of ConstraintSolvers.

getConstraintNetworksFromSolverHierarchy

public ConstraintNetwork[] getConstraintNetworksFromSolverHierarchy(java.lang.Class<?> cl)

Get all ConstraintNetworks underlying ConstraintSolvers of a given type in this MultiConstraintSolver's hierarchy of solvers.

Parameters:

cl - The type of ConstraintNetwork to get.

Returns:

All ConstraintNetworks underlying ConstraintSolvers of a given type in this MultiConstraintSolver's hierarchy of solvers.

getConstraintNetworkHierarchy

public edu.uci.ics.jung.graph.DelegateTree<ConstraintNetwork,java.lang.String> getConstraintNetworkHierarchy()

Get a tree whose nodes are the constraint networks managed by the hierarchy of ConstraintSolvers underlying this MultiConstraintSolver.

Returns:

A tree whose nodes are the constraint networks managed by the hierarchy of ConstraintSolvers underlying this MultiConstraintSolver.

failurePruning

public void failurePruning(int failure_time)

registerValueChoiceFunctions

public void registerValueChoiceFunctions()

Specified by:

registerValueChoiceFunctions in class ConstraintSolver

drawConstraintNetworkHierarchy

public static void drawConstraintNetworkHierarchy(edu.uci.ics.jung.graph.DelegateTree<ConstraintNetwork,java.lang.String> tree)

Draw a hierarchy of ConstraintNetworks.

Parameters:

tree - The hierarchy of ConstraintNetworks to draw.

drawConstraintSolverHierarchy

public static void drawConstraintSolverHierarchy(edu.uci.ics.jung.graph.DelegateTree<ConstraintSolver,java.lang.String> tree)

Draw a hierarchy of ConstraintSolvers.

Parameters:

tree - The hierarchy of ConstraintSolvers to draw.