org.chocosolver.solver.constraints.nary.lex.PropIncreasing 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
Open-source constraint solver.
The newest version!
/*
 * This file is part of choco-solver, http://choco-solver.org/
 *
 * Copyright (c) 2024, 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.nary.lex;

import org.chocosolver.solver.constraints.Propagator;
import org.chocosolver.solver.constraints.PropagatorPriority;
import org.chocosolver.solver.exception.ContradictionException;
import org.chocosolver.solver.variables.IntVar;
import org.chocosolver.solver.variables.events.IntEventType;
import org.chocosolver.solver.variables.events.PropagatorEventType;
import org.chocosolver.util.ESat;

/**
 * A sweep-based algorithm for Increasing propagator
 * 

 *
 * @author Charles Prud'homme
 * @since 28/01/2022
 */
public class PropIncreasing extends Propagator {
    private final int strict;
    private int left, right;

    public PropIncreasing(IntVar[] vars, int strict) {
        super(vars, PropagatorPriority.LINEAR, true);
        this.strict = strict;
    }

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

    @Override
    public void propagate(int evtmask) throws ContradictionException {
        if (PropagatorEventType.isFullPropagation(evtmask)) {
            for (int i = 0; i < vars.length - 1; i++) {
                vars[i + 1].updateLowerBound(vars[i].getLB() + strict, this);
            }
            for (int j = vars.length - 1; j > 0; j--) {
                vars[j - 1].updateUpperBound(vars[j].getUB() - strict, this);
            }
            left = vars.length - 1;
            right = 0;
        } else {
            int i = left;
            left = vars.length - 1;
            int j = right;
            right = 0;
            while (i < vars.length - 1) {
                vars[i + 1].updateLowerBound(vars[i].getLB() + strict, this);
                i++;
            }
            while (j > 0) {
                vars[j - 1].updateUpperBound(vars[j].getUB() - strict, this);
                j--;
            }
        }
    }

    @Override
    public void propagate(int idxVarInProp, int mask) throws ContradictionException {
        if (IntEventType.isInstantiate(mask)) {
            left = Math.min(left, idxVarInProp);
            right = Math.max(right, idxVarInProp);
        } else if (IntEventType.isInclow(mask)) {
            left = Math.min(left, idxVarInProp);
        } else if (IntEventType.isDecupp(mask)) {
            right = Math.max(right, idxVarInProp);
        }
        forcePropagate(PropagatorEventType.CUSTOM_PROPAGATION);
    }

    @Override
    public ESat isEntailed() {
        int cnt = 0;
        for (int i = 0; i < vars.length - 1; i++) {
            if (vars[i].getUB() + strict <= vars[i + 1].getLB()) {
                cnt++;
            } else if (vars[i].getLB() + strict > vars[i + 1].getUB()) {
                return ESat.FALSE;
            }
        }
        return cnt == vars.length - 1 ? ESat.TRUE : ESat.UNDEFINED;
    }
}