Module org.maxicp

Package org.maxicp.cp.engine.constraints.seqvar

Class Require

java.lang.Object

org.maxicp.cp.engine.core.AbstractCPConstraint

org.maxicp.cp.engine.constraints.seqvar.Require

All Implemented Interfaces:

CPConstraint, ConcreteConstraint<ConcreteCPModel>

public class Require
extends AbstractCPConstraint

Requires a node in a sequence, forcing the node to be visited

Constructor Summary

Constructors

Constructor	Description
Require(CPSeqVar seqVar, int node)

Method Summary

Modifier and Type	Method	Description
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	registerDelta(Delta delta)
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.
void	updateDeltas()

Methods inherited from class org.maxicp.cp.engine.core.AbstractCPConstraint

getSolver, priority

Methods inherited from class java.lang.Object

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

Constructor Details

Require

public Require(CPSeqVar seqVar,
 int node)

Method Details

post

public void post()

Description copied from interface: CPConstraint

Initializes the constraint when it is posted to the solver.

Specified by:

post in interface CPConstraint

Overrides:

post in class AbstractCPConstraint

propagate

public void propagate()

Description copied from interface: CPConstraint

Propagates the constraint.

Specified by:

propagate in interface CPConstraint

Overrides:

propagate in class AbstractCPConstraint

setScheduled

public void setScheduled(boolean scheduled)

Description copied from interface: CPConstraint

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 CPConstraint

Overrides:

setScheduled in class AbstractCPConstraint

Parameters:

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

See Also:

• CPSolver.fixPoint()

isScheduled

public boolean isScheduled()

Description copied from interface: CPConstraint

Returns the schedule status in the fix-point.

Specified by:

isScheduled in interface CPConstraint

Overrides:

isScheduled in class AbstractCPConstraint

Returns:

the last CPConstraint.setScheduled(boolean) given to setScheduled

setActive

public void setActive(boolean active)

Description copied from interface: CPConstraint

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 CPConstraint

Overrides:

setActive in class AbstractCPConstraint

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: CPConstraint

Returns the active status of the constraint.

Specified by:

isActive in interface CPConstraint

Overrides:

isActive in class AbstractCPConstraint

Returns:

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

registerDelta

public void registerDelta(Delta delta)

Specified by:

registerDelta in interface CPConstraint

Overrides:

registerDelta in class AbstractCPConstraint

updateDeltas

public void updateDeltas()

Specified by:

updateDeltas in interface CPConstraint

Overrides:

updateDeltas in class AbstractCPConstraint