org.metacsp.multi.allenInterval

Class AllenIntervalConstraint

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.multi.MultiConstraint

org.metacsp.framework.multi.MultiBinaryConstraint

org.metacsp.multi.allenInterval.AllenIntervalConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AllenIntervalConstraint
extends MultiBinaryConstraint

This class provides an implementation of Allen's Interval Algebra (see Allen, 1984). It includes the 13 basic qualitative relations, as well as several tractable disjunctions. Relations can also be provided with metric bounds - see AllenIntervalConstraint.Type enum for details.

Author:

Federico Pecora

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllenIntervalConstraint.Type The 13 basic qualitative relations in Allen's Interval Algebra, plus several tractable disjunctions.

Field Summary

Fields

Modifier and Type	Field and Description
protected Bounds[]	bounds
protected AllenIntervalConstraint.Type[]	types

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
AllenIntervalConstraint(AllenIntervalConstraint.Type... types) Creates an AllenIntervalConstraint of a given (disjunctive) type with default bounds.
AllenIntervalConstraint(AllenIntervalConstraint.Type type, Bounds bounds) Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).
AllenIntervalConstraint(AllenIntervalConstraint.Type type, Bounds[] bounds) Creates an elementary AllenIntervalConstraint of a given type with given bounds.
AllenIntervalConstraint(AllenIntervalConstraint.Type type, Bounds bounds1, Bounds bounds2) Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).
AllenIntervalConstraint(AllenIntervalConstraint.Type type, Bounds bounds1, Bounds bounds2, Bounds bounds3) Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).
AllenIntervalConstraint(AllenIntervalConstraint.Type type, Bounds bounds1, Bounds bounds2, Bounds bounds3, Bounds bounds4) Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() A MultiConstraint must be cloneable.
protected Constraint[]	createInternalConstraints(Variable f, Variable t) This method must be defined to create the internal constraints underlying this MultiBinaryConstraint.
Bounds[]	getBounds() Get the bounds for this AllenIntervalConstraint.
java.lang.String	getEdgeLabel() Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.
static AllenIntervalConstraint.Type	getRelation(AllenInterval i1, AllenInterval i2) Get the qualitative relation that exists between two AllenIntervals, under the earliest time assumption.
AllenIntervalConstraint.Type	getType() Deprecated.
AllenIntervalConstraint.Type[]	getTypes() Get the type of this AllenIntervalConstraint.
boolean	isEquivalent(Constraint c) Method for assessing the "equivalence" between two constraints.

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

createInternalConstraints, getFrom, getTo, setFrom, setTo, toString

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

getDescription, getInternalConstraints, propagateImmediately, setPropagateImmediately, setPropagateLater

Methods inherited from class org.metacsp.framework.Constraint

getAnnotation, getColor, getID, getScope, isAutoRemovable, 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

Field Detail

bounds

protected Bounds[] bounds

types

protected AllenIntervalConstraint.Type[] types

Constructor Detail

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type type,
                               Bounds bounds)

Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).

Parameters:

type - The type of the constraint.

bounds - The one and only upper-lower bound pair for the constraint.

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type type,
                               Bounds bounds1,
                               Bounds bounds2)

Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).

Parameters:

type - The type of the constraint.

bounds1 - The first upper-lower bound pair for the constraint.

bounds2 - The second upper-lower bound pair for the constraint.

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type type,
                               Bounds bounds1,
                               Bounds bounds2,
                               Bounds bounds3)

Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).

Parameters:

type - The type of the constraint.

bounds1 - The first upper-lower bound pair for the constraint.

bounds2 - The second upper-lower bound pair for the constraint.

bounds3 - The third upper-lower bound pair for the constraint.

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type type,
                               Bounds bounds1,
                               Bounds bounds2,
                               Bounds bounds3,
                               Bounds bounds4)

Convenience constructor for not casting bounds into an array (see AllenIntervalConstraint(Type, Bounds[]) constructor).

Parameters:

type - The type of the constraint.

bounds1 - The first upper-lower bound pair for the constraint.

bounds2 - The second upper-lower bound pair for the constraint.

bounds3 - The third upper-lower bound pair for the constraint.

bounds4 - The fourth upper-lower bound pair for the constraint.

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type type,
                               Bounds[] bounds)

Creates an elementary AllenIntervalConstraint of a given type with given bounds.

Parameters:

type - The type of the constraint.

bounds - The bounds of the constraint.

AllenIntervalConstraint

public AllenIntervalConstraint(AllenIntervalConstraint.Type... types)

Creates an AllenIntervalConstraint of a given (disjunctive) type with default bounds.

Parameters:

types - The elementary Allen relations that constitute this constraint.

Method Detail

getType

@Deprecated
public AllenIntervalConstraint.Type getType()

Deprecated.

Get the type of this AllenIntervalConstraint.

Returns:

The type of this AllenIntervalConstraint.

getTypes

public AllenIntervalConstraint.Type[] getTypes()

Get the type of this AllenIntervalConstraint.

Returns:

The type of this AllenIntervalConstraint.

getBounds

public Bounds[] getBounds()

Get the bounds for this AllenIntervalConstraint.

Returns:

The bounds for this AllenIntervalConstraint.

createInternalConstraints

protected Constraint[] createInternalConstraints(Variable f,
                                                 Variable t)

Description copied from class: MultiBinaryConstraint

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

Specified by:

createInternalConstraints in class MultiBinaryConstraint

Parameters:

f - The source Variable of the MultiConstraint.

t - The destination Variable of the MultiConstraint.

Returns:

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

getEdgeLabel

public java.lang.String getEdgeLabel()

Description copied from class: Constraint

Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.

Specified by:

getEdgeLabel in class Constraint

Returns:

a String representation of the constraint to be used for ConstraintNetwork rendering.

clone

public java.lang.Object clone()

Description copied from class: MultiConstraint

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 MultiConstraint

isEquivalent

public boolean isEquivalent(Constraint c)

Description copied from class: Constraint

Method for assessing the "equivalence" between two constraints. This is not used for lookups nor comparisons (hence, it is not the equals method).

Specified by:

isEquivalent in class Constraint

Parameters:

c - The Constraint to compare against.

Returns:

true iff the two constraints are considered to be equivalent.

getRelation

public static AllenIntervalConstraint.Type getRelation(AllenInterval i1,
                                                       AllenInterval i2)

Get the qualitative relation that exists between two AllenIntervals, under the earliest time assumption.

Parameters:

i1 - The first AllenInterval in the sought relation.

i2 - The second AllenInterval in the sought relation.

Returns:

The qualitative relation in AllenIntervalConstraint.Type that exists between the two given AllenIntervals (under the earliest time assumption).