org.chocosolver.solver.constraints.binary.PropLessOrEqualXY_C 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.binary;

import org.chocosolver.solver.constraints.Propagator;
import org.chocosolver.solver.constraints.PropagatorPriority;
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.tools.MathUtils;

/**
 * X + Y <= C
 * 

 *
 * @author Charles Prud'homme
 * @since 13/06/12
 */
public final class PropLessOrEqualXY_C extends Propagator {

    private final IntVar x;
    private final IntVar y;
    private final int cste;

    @SuppressWarnings({"unchecked"})
    public PropLessOrEqualXY_C(IntVar[] vars, int c) {
        super(vars, PropagatorPriority.BINARY, true);
        this.x = vars[0];
        this.y = vars[1];
        this.cste = c;
    }

    @Override
    public int getPropagationConditions(int vIdx) {
        return IntEventType.combine(IntEventType.INSTANTIATE, IntEventType.INCLOW);
    }

    @Override
    public void propagate(int evtmask) throws ContradictionException {
        x.updateUpperBound(MathUtils.safeSubstract(this.cste, y.getLB()), this);
        y.updateUpperBound(MathUtils.safeSubstract(this.cste, x.getLB()), this);
        if (x.getUB() + y.getUB() <= this.cste) {
            this.setPassive();
        }
    }

    @Override
    public void propagate(int idxVarInProp, int mask) throws ContradictionException {
        if (idxVarInProp == 0) {
            y.updateUpperBound(this.cste - x.getLB(), this);
        } else {
            x.updateUpperBound(this.cste - y.getLB(), this);
        }
        if (x.getUB() + y.getUB() <= this.cste) {
            this.setPassive();
        }
    }


    @Override
    public ESat isEntailed() {
        if (x.getLB() + y.getLB() > cste)
            return ESat.FALSE;
        else if (x.getUB() + y.getUB() <= this.cste)
            return ESat.TRUE;
        else
            return ESat.UNDEFINED;
    }

    /**
     * @implSpec
     * Premise: x + y ≤ c
     * The filtering algorithm states that:
     * 

     *     ub(x) ← c - lb(y) : x cannot be greater than c minus the smallest value of y
     *     ub(y) ← c - lb(x) : y cannot be greater than c minus the smallest value of x
     * 
     * 
     * 
     * Inference rules:
     * 

     *     
     *         Let m = lb(y), then
     *         ( x ∈ (-∞..c - m] ∨ y ∈ (-∞..m - 1] ) 
     *     
     *     
     *         Let n = lb(x), then
     *         ( x ∈ (-∞..n - 1] ∨ y ∈ (-∞..c - m] ) 
     *     
     * 
     * 
     */
    @Override
    public void explain(int p, ExplanationForSignedClause explanation) {
        IntIterableRangeSet set;
        int m;
        if(explanation.readVar(p) == vars[0]){ // case a. (see javadoc)
            m = explanation.readDom(vars[1]).min();
            set = explanation.complement(vars[1]);
            set.retainBetween(IntIterableRangeSet.MIN, m - 1);
            vars[0].intersectLit(IntIterableRangeSet.MIN, cste - m, explanation);
            vars[1].unionLit(set, explanation);
        }else{ // case b. (see javadoc)
            assert explanation.readVar(p) == vars[1];
            m = explanation.readDom(vars[0]).min();
            set = explanation.complement(vars[0]);
            set.retainBetween(IntIterableRangeSet.MIN, m - 1);
            vars[0].unionLit(set, explanation);
            vars[1].intersectLit(IntIterableRangeSet.MIN, cste - m, explanation);
        }
    }

    @Override
    public String toString() {
        return x.getName() + " + " + y.getName() + " <= " + cste;
    }

}