org.chocosolver.solver.constraints.unary.PropMember 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
There is a newer version: 4.10.17
/*
 * 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.unary;

import org.chocosolver.solver.constraints.Propagator;
import org.chocosolver.solver.constraints.PropagatorPriority;
import org.chocosolver.solver.constraints.UpdatablePropagator;
import org.chocosolver.solver.exception.ContradictionException;
import org.chocosolver.solver.learn.ExplanationForSignedClause;
import org.chocosolver.solver.variables.IntVar;
import org.chocosolver.solver.variables.events.IntEventType;
import org.chocosolver.util.ESat;
import org.chocosolver.util.objects.setDataStructures.iterable.IntIterableRangeSet;
import org.chocosolver.util.objects.setDataStructures.iterable.IntIterableSetUtils;

/**
 * This propagator manages a singleton nogood.
 * 
 * 

 * Project: choco-solver.
 *
 * @author Charles Prud'homme
 * @since 12/10/2016.
 */
public class PropMember extends Propagator implements UpdatablePropagator {

    /**
     * List of possible values.
     */
    private final IntIterableRangeSet range;

    /**
     * Maintain : var∈range
     *
     * @param var a variable
     * @param range  list of possible values
     */
    public PropMember(IntVar var, IntIterableRangeSet range, boolean isObjectiveFunction) {
        super(new IntVar[]{var}, PropagatorPriority.UNARY, false, !isObjectiveFunction);
        this.range = range.duplicate();
    }

    @Override
    public int getPropagationConditions(int vIdx) {
        return IntEventType.all();
    }

    @Override
    public void propagate(int evtmask) throws ContradictionException {
        if(enforce(vars[0], range, this)){
            setPassive();
        }
    }

    private static boolean enforce(IntVar var, IntIterableRangeSet fset, Propagator prop) throws ContradictionException {
        return var.removeAllValuesBut(fset, prop)
                && (var.hasEnumeratedDomain() || IntIterableSetUtils.includedIn(var, fset));
    }

    @Override
    public ESat isEntailed() {
        if(IntIterableSetUtils.includedIn(vars[0], range)){
            return ESat.TRUE;
        }else if(range.intersect(vars[0])){
            return ESat.UNDEFINED;
        }
        return ESat.FALSE;
    }

    /**
     * @implSpec
     * 

     *     Consider that v1 has been modified by propagation of this.
     *     Before the propagation, the domains were like:
     * 
     *         (v1 ∈ D1)
     *     
     * Then this propagates v1 ∈ S, then:
     *      *         (v1 ∈ D1) → v1 ∈ S
     *     
     * Converting to DNF:
     *      *         (v1 ∈ (U \ D1) ∪ S)
     *     
     * 
     */
    @Override
    public void explain(int p, ExplanationForSignedClause explanation) {
        vars[0].intersectLit(explanation.empty().copyFrom(range), explanation);
    }

    @Override
    public String toString() {
        return vars[0].getName() + " \u2208 " + range;
    }

    @Override
    public void update(IntIterableRangeSet values, boolean thenForcePropagate) {
        this.range.clear();
        this.range.addAll(values);
        if(thenForcePropagate)forcePropagationOnBacktrack();
    }

    @Override
    public IntIterableRangeSet getUpdatedValue() {
        return this.range.duplicate();
    }
}