org.chocosolver.solver.variables.delta.IIntDeltaMonitor 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.variables.delta;

import org.chocosolver.solver.exception.ContradictionException;
import org.chocosolver.util.procedure.IntProcedure;
import org.chocosolver.util.procedure.SafeIntProcedure;

/**
 * 

 *
 * @author Charles Prud'homme
 * @since 25/05/12
 */
public interface IIntDeltaMonitor extends IDeltaMonitor{

    /**
     * Apply 'proc' on each value removed. No filtering allowed.
     * A call to this method consumes the elements stored.
     *
     * @param proc a procedure
     */
    void forEachRemVal(SafeIntProcedure proc);

    /**
     * Apply 'proc' on each value removed. Filtering allowed
     * A call to this method consumes the elements stored.
     *
     * @param proc a procedure
     * @throws ContradictionException if contradiction occurs
     */

    void forEachRemVal(IntProcedure proc) throws ContradictionException;

    /**
     * @return a rough estimation of the number of removed values
     */
    int sizeApproximation();

    enum Default implements IIntDeltaMonitor {
        NONE() {
            @Override
            public int sizeApproximation() {
                return 0;
            }

            @Override
            public void startMonitoring() {
                
            }

            @Override
            public void forEachRemVal(SafeIntProcedure proc) {
                // nothing to do by default
            }

            @Override
            public void forEachRemVal(IntProcedure proc) throws ContradictionException {
                // nothing to do by default
            }
        }
    }
}