minicp.engine.core

Class AbstractConstraint

java.lang.Object

minicp.engine.core.AbstractConstraint

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

Absolute, AllDifferentAC, AllDifferentBinary, Circuit, ConstraintClosure, Cumulative, CumulativeDecomposition, Disjunctive, Element1D, Element1DVar, Element2D, IsEqual, IsLessOrEqual, IsLessOrEqualVar, IsOr, LessOrEqual, Maximum, NegTableCT, NotEqual, Or, ShortTableCT, ShortTableDecomp, Sum, TableCT, TableDecomp

public abstract class AbstractConstraint
extends Object
implements Constraint

Abstract class the most of the constraints should extend.

Constructor Summary

Constructors

Constructor and Description
AbstractConstraint(Solver cp)

Method Summary

Modifier and Type	Method and Description
Solver	getSolver()
boolean	isActive() Returns the active status of the constraint.
boolean	isScheduled() Returns the schedule status in the fix-point.
void	post() Initializes the constraint when it is posted to the solver.
void	propagate() Propagates the constraint.
void	setActive(boolean active) Activates or deactivates the constraint such that it is not scheduled any more.
void	setScheduled(boolean scheduled) Set the status of the constraint as scheduled to be propagated by the fix-point.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConstraint

public AbstractConstraint(Solver cp)

Method Detail

post

public void post()

Description copied from interface: Constraint

Initializes the constraint when it is posted to the solver.

Specified by:

post in interface Constraint

getSolver

public Solver getSolver()

propagate

public void propagate()

Description copied from interface: Constraint

Propagates the constraint.

Specified by:

propagate in interface Constraint

setScheduled

public void setScheduled(boolean scheduled)

Description copied from interface: Constraint

Set the status of the constraint as scheduled to be propagated by the fix-point. This method Called by the solver when the constraint is enqueued in the propagation queue and is not intended to be called by the user.

Specified by:

setScheduled in interface Constraint

Parameters:

scheduled - a value that is true when the constraint is enqueued in the propagation queue, false when dequeued

See Also:

Solver.fixPoint()

isScheduled

public boolean isScheduled()

Description copied from interface: Constraint

Returns the schedule status in the fix-point.

Specified by:

isScheduled in interface Constraint

Returns:

the last Constraint.setScheduled(boolean) given to setScheduled

setActive

public void setActive(boolean active)

Description copied from interface: Constraint

Activates or deactivates the constraint such that it is not scheduled any more.

Typically called by the Constraint to let the solver know it should not be scheduled any more when it is subsumed.

By default the constraint is active.

Specified by:

setActive in interface Constraint

Parameters:

active - the status to be set, this state is reversible and unset on state restoration StateManager.restoreState()

isActive

public boolean isActive()

Description copied from interface: Constraint

Returns the active status of the constraint.

Specified by:

isActive in interface Constraint

Returns:

the last setValue passed to {Constraint.setActive(boolean) in this state frame StateManager.restoreState().