org.metacsp.time

Class SimpleDistanceConstraint

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.BinaryConstraint

org.metacsp.time.SimpleDistanceConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SimpleDistanceConstraint
extends BinaryConstraint

This class provides the fundamental building block for building STPs, namely the simple distance constraint type used by the APSPSolver STP solve.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.metacsp.framework.Constraint

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

Constructor Summary

Constructors

Constructor and Description
SimpleDistanceConstraint()

Method Summary

Modifier and Type	Method and Description
boolean	addInterval(Bounds i) Add an [lb,ub] interval between the two TimePoints of this constraint.
SimpleDistanceConstraint	clone()
boolean	draw() Draw a graphical representation of this constraint.
int	getCounter() Get the current constraint counter, expressing the number of [lb,ub] intervals added between the two TimePoints (including the active constraint).
java.lang.String	getEdgeLabel() Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.
long	getMaximum() Get the maximum time lag between the two TimePoints involved in this constraint.
long	getMinimum() Get the minimum time lag between the two TimePoints involved in this constraint.
SimpleDistanceConstraint	invert() Inverts the from and to reference of this constraints and updates the minimum and maximum bounds accordingly.
boolean	isEquivalent(Constraint c) Method for assessing the "equivalence" between two constraints.
SimpleDistanceConstraint	normalize() Inverts the constraint if its lower bound is negative.
boolean	removeInterval(Bounds i) Remove an [lb,ub] interval between the two TimePoints of this constraint.
void	setMaximum(long newVal) Set the minimum time lag between the two TimePoints involved in this constraint.
void	setMinimum(long newVal) Set the minimum time lag between the two TimePoints involved in this constraint.
java.lang.String	toString() Get a String representation of this constraint.

Methods inherited from class org.metacsp.framework.BinaryConstraint

getFrom, getTo, setFrom, setTo

Methods inherited from class org.metacsp.framework.Constraint

getAnnotation, getColor, getDescription, 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

Constructor Detail

SimpleDistanceConstraint

public SimpleDistanceConstraint()

Method Detail

toString

public java.lang.String toString()

Get a String representation of this constraint.

Overrides:

toString in class BinaryConstraint

Returns:

A String describing this constraint.

draw

public boolean draw()

Draw a graphical representation of this constraint. This method is NOT implemented.

Returns:

True iff the constraint was be drawn successfully.

getMinimum

public long getMinimum()

Get the minimum time lag between the two TimePoints involved in this constraint.

Returns:

The minimum time lag between the two TimePoints involved in this constraint.

setMinimum

public void setMinimum(long newVal)

Set the minimum time lag between the two TimePoints involved in this constraint.

Parameters:

newVal - The minimum time lag between the two TimePoints involved in this constraint.

getMaximum

public long getMaximum()

Get the maximum time lag between the two TimePoints involved in this constraint.

Returns:

The minimum time lag between the two TimePoints involved in this constraint.

setMaximum

public void setMaximum(long newVal)

Set the minimum time lag between the two TimePoints involved in this constraint.

Parameters:

newVal - The minimum time lag between the two TimePoints involved in this constraint.

getCounter

public int getCounter()

Get the current constraint counter, expressing the number of [lb,ub] intervals added between the two TimePoints (including the active constraint).

Returns:

The number of [lb,ub] intervals added between the two TimePoints (including the active constraint).

addInterval

public boolean addInterval(Bounds i)

Add an [lb,ub] interval between the two TimePoints of this constraint.

Parameters:

i - The interval to add.

Returns:

true if the interval was added, false if it is malformed.

removeInterval

public boolean removeInterval(Bounds i)

Remove an [lb,ub] interval between the two TimePoints of this constraint.

Parameters:

i - The interval to remove.

Returns:

true if the interval was removed, false if this was an attempt to remove the active constraint.

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 SimpleDistanceConstraint clone()

Specified by:

clone in class Constraint

normalize

public final SimpleDistanceConstraint normalize()

Inverts the constraint if its lower bound is negative. At the time of writing negative constraints could not be used, e.g. constraints whose minimum and maximum values are negative. If this becomes possible in the future, this function will have little use. (Since all constraint can't necessarily be expressed with positive bounds then.)

Returns:

A normalized copy the original constraint.

invert

public final SimpleDistanceConstraint invert()

Inverts the from and to reference of this constraints and updates the minimum and maximum bounds accordingly.

Returns:

an inverted copy of this constraint.

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.