org.chocosolver.solver.constraints.set.PropBoolChannel 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.
/**
* Copyright (c) 2016, Ecole des Mines de Nantes
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the .
* 4. Neither the name of the nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* Created by IntelliJ IDEA.
* User: Jean-Guillaume Fages
* Date: 14/01/13
* Time: 16:36
*/
package org.chocosolver.solver.constraints.set;
import org.chocosolver.solver.constraints.Propagator;
import org.chocosolver.solver.constraints.PropagatorPriority;
import org.chocosolver.solver.exception.ContradictionException;
import org.chocosolver.solver.variables.BoolVar;
import org.chocosolver.solver.variables.SetVar;
import org.chocosolver.solver.variables.Variable;
import org.chocosolver.solver.variables.delta.ISetDeltaMonitor;
import org.chocosolver.solver.variables.events.SetEventType;
import org.chocosolver.util.ESat;
import org.chocosolver.util.objects.setDataStructures.ISetIterator;
import org.chocosolver.util.procedure.IntProcedure;
import org.chocosolver.util.tools.ArrayUtils;
/**
* Channeling between a set variable and boolean variables
*
* @author Jean-Guillaume Fages
*/
public class PropBoolChannel extends Propagator {
//***********************************************************************************
// VARIABLES
//***********************************************************************************
private int n;
private int offSet;
private BoolVar[] bools;
private SetVar set;
private ISetDeltaMonitor sdm;
private IntProcedure setForced, setRemoved;
//***********************************************************************************
// CONSTRUCTORS
//***********************************************************************************
/**
* Channeling between a set variable and boolean variables
* i in setVar <=> boolVars[i-offSet] = TRUE
*
* @param setVar a set variable
* @param boolVars an array of boolean variables
*/
public PropBoolChannel(SetVar setVar, BoolVar[] boolVars, final int offSet) {
super(ArrayUtils.append(boolVars, new Variable[]{setVar}), PropagatorPriority.UNARY, true);
this.n = boolVars.length;
this.bools = new BoolVar[n];
for (int i = 0; i < n; i++) {
this.bools[i] = (BoolVar) vars[i];
}
this.set = (SetVar) vars[n];
this.sdm = this.set.monitorDelta(this);
this.offSet = offSet;
// PROCEDURES
setForced = element -> bools[element - offSet].setToTrue(this);
setRemoved = element -> bools[element - offSet].setToFalse(this);
}
//***********************************************************************************
// METHODS
//***********************************************************************************
@Override
public void propagate(int evtmask) throws ContradictionException {
for (int i = 0; i < n; i++) {
if (bools[i].isInstantiated()) {
if (bools[i].getValue() == 0) {
set.remove(i + offSet, this);
} else {
set.force(i + offSet, this);
}
} else if (!set.getUB().contains(i + offSet)) {
bools[i].setToFalse(this);
}
}
ISetIterator iter = set.getUB().iterator();
while (iter.hasNext()){
int j = iter.nextInt();
if (j < offSet || j >= n + offSet) {
set.remove(j, this);
}
}
iter = set.getLB().iterator();
while (iter.hasNext()){
int j = iter.nextInt();
bools[j - offSet].setToTrue(this);
}
sdm.unfreeze();
}
@Override
public void propagate(int i, int mask) throws ContradictionException {
if (i < n) {
if (bools[i].getValue() == 0) {
set.remove(i + offSet, this);
} else {
set.force(i + offSet, this);
}
} else {
sdm.freeze();
sdm.forEach(setForced, SetEventType.ADD_TO_KER);
sdm.forEach(setRemoved, SetEventType.REMOVE_FROM_ENVELOPE);
sdm.unfreeze();
}
}
@Override
public ESat isEntailed() {
ISetIterator iter = set.getLB().iterator();
while (iter.hasNext()){
int i = iter.nextInt() - offSet;
if (i < 0 || i >= bools.length || bools[i].isInstantiatedTo(0)) {
return ESat.FALSE;
}
}
for (int i = 0; i < n; i++) {
if (bools[i].isInstantiatedTo(1)) {
if (!set.getUB().contains(i + offSet)) {
return ESat.FALSE;
}
}
}
if (isCompletelyInstantiated()) {
return ESat.TRUE;
}
return ESat.UNDEFINED;
}
}