org.chocosolver.solver.constraints.Constraint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of choco-solver Show documentation
Show all versions of choco-solver Show documentation
Open-source constraint solver.
/*
* This file is part of choco-solver, http://choco-solver.org/
*
* Copyright (c) 2022, IMT Atlantique. All rights reserved.
*
* Licensed under the BSD 4-clause license.
*
* See LICENSE file in the project root for full license information.
*/
package org.chocosolver.solver.constraints;
import org.chocosolver.solver.Model;
import org.chocosolver.solver.constraints.reification.Opposite;
import org.chocosolver.solver.exception.SolverException;
import org.chocosolver.solver.search.SearchState;
import org.chocosolver.solver.variables.BoolVar;
import org.chocosolver.util.ESat;
import java.util.*;
/**
* A Constraint is basically a set of Propagator.
* It can either be posted or reified
*
* @author Jean-Guillaume Fages
* @author Xavier Lorca
* @author Charles Prud'homme
* @version major revision 13/01/2014
* @see org.chocosolver.solver.variables.Variable
* @see Propagator
* @see org.chocosolver.solver.propagation.PropagationEngine
* @since 0.01
*/
public class Constraint {
//***********************************************************************************
// VARIABLES
//***********************************************************************************
/**
* Status of this constraint wrt the model
*/
public enum Status {
/**
* Indicate that this constraint is posted in the model
*/
POSTED,
/**
* Indicate that this constraint is reified in the model
*/
REIFIED,
/**
* Indicate that this constraint is not posted or reified yet
*/
FREE
}
/**
* Propagators of the constraint (they will filter domains and eventually check solutions)
*/
final protected Propagator[] propagators;
/**
* BoolVar that reifies this constraint, unique.
*/
protected BoolVar boolReif;
/**
* Opposite constraint of this constraint, unique.
*/
private Constraint opposite;
/**
* Status of this constraint in the model
*/
private Status mStatus;
/**
* Index of this constraint in the model data structure
*/
private int cidx;
/**
* Name of this constraint
*/
private String name;
/**
* If a constraint is enabled to the propagation engine.
*/
private boolean enabled = true;
//***********************************************************************************
// CONSTRUCTOR
//***********************************************************************************
/**
* Make a new constraint defined as a set of given propagators
*
* @param name name of the constraint
* @param propagators set of propagators defining the constraint
*/
public Constraint(String name, Propagator... propagators) {
if (propagators == null || propagators.length == 0) {
throw new UnsupportedOperationException("cannot create a constraint without propagators ");
}
this.name = name;
this.propagators = propagators;
this.mStatus = Status.FREE;
this.cidx = -1;
for (Propagator propagator : propagators) {
propagator.defineIn(this);
}
Model model = propagators[0].getModel();
if (model.getSettings().checkDeclaredConstraints()) {
@SuppressWarnings("unchecked")
Set instances = (Set) model.getHook("cinstances");
if (instances == null) {
instances = new HashSet<>();
model.addHook("cinstances", instances);
}
instances.add(this);
}
}
//***********************************************************************************
// METHODS
//***********************************************************************************
/**
* Return an array which contains the propagators declared in this.
*
* @return an array of {@link Propagator}.
*/
@SuppressWarnings("rawtypes")
public Propagator[] getPropagators() {
return propagators;
}
public Propagator getPropagator(int i) {
return propagators[i];
}
/**
* Test if this Constraint object is satisfied,
* regarding its Propagators and its Variable current domains.
*
* This method is called on each solution as a checker when assertions are enabled (-ea in VM parameters)
* It is also called for constraint reification (to state whether or not a constraint is satisfied)
*
* The method calls entailment checks of this propagators
*
* @return ESat.FALSE if the constraint cannot be satisfied (from domain consideration),
* ESat.TRUE if whatever future decisions are, the constraint will be satisfied for sure (without propagating domain modifications)
* ESat.UNDIFINED otherwise (more decisions/filtering must be made before concluding about constraint satisfaction)
*/
public ESat isSatisfied() {
int sat = 0;
for (Propagator propagator : propagators) {
ESat entail = propagator.isEntailed();
if (entail.equals(ESat.FALSE)) {
return entail;
} else if (entail.equals(ESat.TRUE)) {
sat++;
}
}
if (sat == propagators.length) {
return ESat.TRUE;
} else {// No need to check if FALSE, must have been returned before
return ESat.UNDEFINED;
}
}
public String toString() {
return name + " (" + Arrays.toString(propagators) + ")";
}
/**
* @return true iff this constraint has been reified
*/
public final boolean isReified() {
return boolReif != null;
}
/**
* Reifies the constraint with a boolean variable
* If the reified boolean variable already exists, an additional (equality) constraint is automatically posted.
*
* @param bool the variable to reify with
*/
public void reifyWith(BoolVar bool) {
if (boolReif != null) {
if (opposite == null) {
throw new SolverException("try to reify an implied constraint");
}
if (bool != boolReif) {
bool.eq(boolReif).post();
}
} else {
getOpposite();
if (boolReif == null) {
boolReif = bool;
assert opposite.boolReif == null;
opposite.boolReif = this.boolReif.not();
if (boolReif.isInstantiated()
&& bool.getModel().getSolver().getSearchState() == SearchState.NEW) {
if (boolReif.getValue() == 1) {
this.post();
} else{
this.opposite.post();
}
return;
}
new ReificationConstraint(boolReif, this, opposite).post();
}
}
}
/**
* Get/make the boolean variable indicating whether the constraint is satisfied or not
* This should not be posted.
*
* @return the boolean reifying the constraint
*/
public final BoolVar reify() {
if (boolReif == null) {
Model model = propagators[0].getModel();
reifyWith(model.boolVar(model.generateName("REIF_")));
} else if (opposite == null) {
throw new SolverException("try to reify an implied constraint");
}
return boolReif;
}
/**
* Encapsulate this constraint in an implication relationship:
*
* c ⇒ r
*
* where 'c' is this constraint and 'r' is a boolean variable.
*
* After a call to this method, this constraint 'c' can be posted,
* but a better option would be to set 'r' to true.
* 'c' can also be reified, but a better option would be to link the reifying boolean to 'r' directly.
*
*
* @param r a boolean variable
*/
public final void implies(BoolVar r) {
this.reify().imp(r).post();
}
/**
* Encapsulate this constraint in an implication relationship:
*
* r ⇒ c
*
* where 'r' is a boolean variable and 'c' is this constraint.
*
*
* After a call to this method, this constraint 'c' can be posted,
* but then 'r' can take any value.
* 'c' can also be reified, but a better option would be to link the reifying boolean to 'r' directly.
*
*
* @param r a boolean variable
*/
public final void impliedBy(BoolVar r) {
if (boolReif == null) {
boolReif = r;
if (boolReif.isInstantiatedTo(1)
&& r.getModel().getSolver().getSearchState() == SearchState.NEW) {
this.post();
} else {
new ImpliedConstraint(boolReif, this).post();
}
} else if (r != boolReif && opposite != null) {
throw new SolverException("try to imply a reified constraint");
}
}
/**
* Posts the constraint to its model so that the constraint must be satisfied.
* This should not be reified.
*/
public final void post() {
propagators[0].getModel().post(this);
}
/**
* When a constraint has been declared but neither posted or reified,
* a call to {@code ignore()} ensures this constraint will be ignored
* when declared constraints are checked.
*/
public final void ignore() {
assert mStatus == Status.FREE : "Cannot ignore a posted or reified constraint";
Model model = propagators[0].getModel();
if (model.getSettings().checkDeclaredConstraints()) {
@SuppressWarnings("unchecked")
Set instances = (Set) model.getHook("cinstances");
if (instances == null) {
instances = new HashSet<>();
model.addHook("cinstances", instances);
}
instances.remove(this);
}
}
/**
* For internal usage only, declare the status of this constraint in the model
* and, if need be, its position in the constraint list.
*
* @param aStatus status of this constraint in the model
* @param idx position of this constraint in the constraint list.
* @throws SolverException if the constraint a incoherent status is declared
*/
public final void declareAs(Status aStatus, int idx) throws SolverException {
checkNewStatus(aStatus);
mStatus = aStatus;
cidx = idx;
Model model = propagators[0].getModel();
if (model.getSettings().checkDeclaredConstraints()) {
@SuppressWarnings("unchecked")
Set instances = (Set) model.getHook("cinstances");
if (instances == null) {
instances = new HashSet<>();
model.addHook("cinstances", instances);
}
if (mStatus != Status.FREE) {
instances.remove(this);
} else {
instances.add(this);
}
}
}
/**
* Check if the new status is not in conflict with the current one
*
* @param aStatus new status of the constraint
* @throws SolverException if the constraint a incoherent status is declared
*/
public final void checkNewStatus(Status aStatus) throws SolverException {
switch (mStatus) {
default:
case FREE:
if (aStatus == Status.FREE) {
throw new SolverException("Try to remove a constraint which is not known from the model.");
}
break;
case POSTED:
switch (aStatus) {
case POSTED:
throw new SolverException("Try to post a constraint which is already posted in the model.");
case REIFIED:
throw new SolverException("Try to post a constraint which is already reified in the model.");
default:
break;
}
break;
case REIFIED:
switch (aStatus) {
case POSTED:
throw new SolverException("Try to reify a constraint which is already posted in the model.");
case REIFIED:
throw new SolverException("Try to reify a constraint which is already reified in the model.");
default:
break;
}
break;
}
}
/**
* @return the {@link Status} of this constraint
* @implNote The constraint's status takes into account the state of the opposite constraint if it exists
*/
public final Status getStatus() {
return (mStatus == Status.FREE && opposite != null) ? opposite.mStatus : mStatus;
}
/**
* @return the position of this constraint in the model
*/
public int getCidxInModel() {
return cidx;
}
/**
* Get the opposite constraint of this constraint.
* At first call, it creates the opposite constraint,
* links them together (the opposite constraint of this opposite constraint is this constraint)
* and returns the opposite.
* Next calls will return the previously created opposite constraint.
* In other words, there can be only one opposite per instance of constraint.
* The default opposite constraint does not filter domains but fails if this constraint is satisfied.
*
* @return the opposite constraint of this
*/
public Constraint getOpposite() {
if (opposite == null) {
setOpposite(makeOpposite());
}
return opposite;
}
protected void setOpposite(Constraint opp) {
opposite = opp;
opposite.opposite = this;
}
/**
* Make the opposite constraint of this.
* BEWARE: this method should never be called by the user
* but it can be overridden to provide better constraint negations
*/
protected Constraint makeOpposite() {
return new Opposite(this);
}
/**
* Changes the name of this constraint
*
* @param newName the name of the constraint
*/
public void setName(String newName) {
name = newName;
}
/**
* @return the name of this constraint
*/
public String getName() {
return name;
}
/**
* @return the maximum priority of a propagator of this constraint
*/
public PropagatorPriority computeMaxPriority() {
int priority = 1;
for (Propagator p : propagators) {
priority = Math.max(priority, p.getPriority().getValue());
}
return PropagatorPriority.get(priority);
}
/**
* Creates a new constraint with all propagators of toMerge
*
* @param name name of the new constraint
* @param toMerge a set of constraints to merge in this
* @return a new constraint with all propagators of toMerge
*/
public static Constraint merge(String name, Constraint... toMerge) {
ArrayList props = new ArrayList<>();
for (Constraint c : toMerge) {
c.ignore();
Collections.addAll(props, c.getPropagators());
}
return new Constraint(name, props.toArray(new Propagator[0]));
}
/**
* A constraint, when disabled, is prevented from execute propagation during search
* and from participate in the solution feasibility check. It's handy to disable
* constraints for algorithms like ({@link org.chocosolver.solver.QuickXPlain}, that
* execute massive search to find a minimum conflicting set of constraints, and to do
* this needs to alternate constraints execution by enabling and disabling it.
*
* @return enabled if the constraint is available to the solver
*/
public boolean isEnabled() {
return enabled;
}
/**
* Disable a constraint from being propagated during search and from feasibility
* check ({@link org.chocosolver.solver.Solver#isSatisfied()}). A constraint
* shouldn't swap between enabled/disabled during solver execution (branching,
* filtering, etc...) because there is not control of the side effects it can
* cause (e.g.: when at node n, if a constraint becomes disabled, it doesn't
* undo filtering it has done at n-1).
* It means that, constraint should be disabled only before any interaction with
* the ({@link org.chocosolver.solver.Solver}) class to prevent side-effects.
*
* @param enabled a boolean
* @throws SolverException when setEnabled is called during solving
*/
public void setEnabled(boolean enabled) {
if (propagators[0].getModel().getSolver().isSolving()) {
throw new SolverException("A constraint enabling state can't be changed during search");
}
if (this.enabled != enabled) {
this.enabled = enabled;
for (Propagator p : propagators) {
if (p != null) {
p.setEnabled(enabled);
}
}
}
}
}