org.chocosolver.solver.variables.view.GraphView 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.
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.variables.view;

import org.chocosolver.solver.ICause;
import org.chocosolver.solver.exception.ContradictionException;
import org.chocosolver.solver.learn.ExplanationForSignedClause;
import org.chocosolver.solver.variables.GraphVar;
import org.chocosolver.solver.variables.Variable;
import org.chocosolver.solver.variables.delta.GraphDelta;
import org.chocosolver.solver.variables.events.GraphEventType;
import org.chocosolver.solver.variables.events.IEventType;
import org.chocosolver.solver.variables.events.IntEventType;
import org.chocosolver.solver.variables.impl.scheduler.GraphEvtScheduler;
import org.chocosolver.util.iterators.EvtScheduler;
import org.chocosolver.util.objects.graphs.IGraph;
import org.chocosolver.util.objects.setDataStructures.ISet;

/**
 * An abstract class for graph views over other variables
 *
 * @author Dimitri Justeau-Allaire
 * @since 31/03/2021
 */
public abstract class GraphView extends AbstractView implements GraphVar {

    /**
     * Creates a graph view.
     *
     * @param name      name of the view
     * @param variables observed variables
     */
    protected GraphView(String name, V... variables) {
        super(name, variables);
    }

    protected abstract boolean doRemoveNode(int node) throws ContradictionException;

    protected abstract boolean doEnforceNode(int node) throws ContradictionException;

    protected abstract boolean doRemoveEdge(int from, int to) throws ContradictionException;

    protected abstract boolean doEnforceEdge(int from, int to) throws ContradictionException;


    @Override
    public boolean enforceNode(int node, ICause cause) throws ContradictionException {
        assert cause != null;
        assert (node >= 0 && node < getNbMaxNodes());
        if (!getPotentialNodes().contains(node)) {
            this.contradiction(cause, "enforce node which is not in the domain");
            return false;
        }
        if (!getMandatoryNodes().contains(node) && doEnforceNode(node)) {
            notifyPropagators(GraphEventType.ADD_NODE, cause);
            return true;
        }
        return false;
    }

    @Override
    public boolean removeNode(int node, ICause cause) throws ContradictionException {
        assert cause != null;
        assert (node >= 0 && node < getNbMaxNodes());
        if (getMandatoryNodes().contains(node)) {
            this.contradiction(cause, "remove mandatory node");
            return false;
        } else if (!getPotentialNodes().contains(node)) {
            return false;
        }
        int succSize = getPotentialSuccessorsOf(node).size();
        int predSize= getPotentialPredecessorOf(node).size();
        if (doRemoveNode(node)) {
            if (succSize + predSize > 0) {
                notifyPropagators(GraphEventType.REMOVE_EDGE, cause);
            }
            notifyPropagators(GraphEventType.REMOVE_NODE, cause);
            return true;
        }
        return false;
    }

    @Override
    public boolean enforceEdge(int x, int y, ICause cause) throws ContradictionException {
        assert cause != null;
        boolean addX = !getMandatoryNodes().contains(x);
        boolean addY = !getMandatoryNodes().contains(y);
        if (!getPotentialSuccessorsOf(x).contains(y)) {
            this.contradiction(cause, "enforce edge which is not in the domain");
            return false;
        }
        if (doEnforceEdge(x, y)) {
            if (addX || addY) {
                notifyPropagators(GraphEventType.ADD_NODE, cause);
            }
            notifyPropagators(GraphEventType.ADD_EDGE, cause);
            return true;
        }
        return false;
    }

    @Override
    public boolean removeEdge(int x, int y, ICause cause) throws ContradictionException {
        assert cause != null;
        if (getMandatorySuccessorsOf(x).contains(y)) {
            this.contradiction(cause, "remove mandatory edge");
            return false;
        }
        if (doRemoveEdge(x, y)) {
            notifyPropagators(GraphEventType.REMOVE_EDGE, cause);
            return true;
        }
        return false;
    }

    @Override
    public void instantiateTo(IGraph value, ICause cause) throws ContradictionException {
        for (int i = 0; i < getNbMaxNodes(); i++) {
            if (value.getNodes().contains(i)) {
                enforceNode(i, cause);
            } else if (getUB().containsNode(i)) {
                removeNode(i, cause);
            }
        }
        for (int i = 0; i < getNbMaxNodes(); i++) {
            for (int j = 0; j < getNbMaxNodes(); j++) {
                if (value.getNodes().contains(i) && value.getNodes().contains(j)) {
                    if (value.getSuccessorsOf(i).contains(j)) {
                        enforceEdge(i, j, cause);
                    } else if (getUB().containsEdge(i, j)) {
                        removeEdge(i, j, cause);
                    }
                }
            }
        }
    }

    @Override
    public GraphDelta getDelta() {
        throw new UnsupportedOperationException("GraphView does not support getDelta()");
    }

    @Override
    public void createDelta() {
        for (Variable v : getVariables()) {
            v.createDelta();
        }
    }

    @Override
    public void notifyPropagators(IEventType event, ICause cause) throws ContradictionException {
        assert cause != null;
        model.getSolver().getEngine().onVariableUpdate(this, event, cause);
        notifyMonitors(event);
        notifyViews(event, cause);
    }

    @Override
    public int getTypeAndKind() {
        return VIEW | GRAPH;
    }

    @Override
    protected EvtScheduler createScheduler() {
        return new GraphEvtScheduler();
    }

    @Override
    public void explain(int pivot, ExplanationForSignedClause explanation) {
        throw new UnsupportedOperationException("GraphView does not support explanation.");
    }

    @Override
    public void justifyEvent(IntEventType mask, int one, int two, int three) {
        throw new UnsupportedOperationException("GraphView does not support explanation.");
    }

    @Override
    public boolean isInstantiated() {
        if (getPotentialNodes().size() != getMandatoryNodes().size()) {
            return false;
        }
        ISet suc;
        for (int i : getUB().getNodes()) {
            suc = getPotentialSuccessorsOf(i);
            if (suc.size() != getLB().getSuccessorsOf(i).size()) {
                return false;
            }
        }
        return true;
    }
}