001package org.cpsolver.ifs.model;
002
003import java.util.Collection;
004import java.util.Map;
005
006import org.cpsolver.ifs.assignment.Assignment;
007
008
009/**
010 * A class providing INFO table.
011 * 
012 * @see Model
013 * 
014 * @author  Tomáš Müller
015 * @version IFS 1.3 (Iterative Forward Search)<br>
016 *          Copyright (C) 2006 - 2014 Tomáš Müller<br>
017 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
018 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
019 * <br>
020 *          This library is free software; you can redistribute it and/or modify
021 *          it under the terms of the GNU Lesser General Public License as
022 *          published by the Free Software Foundation; either version 3 of the
023 *          License, or (at your option) any later version. <br>
024 * <br>
025 *          This library is distributed in the hope that it will be useful, but
026 *          WITHOUT ANY WARRANTY; without even the implied warranty of
027 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
028 *          Lesser General Public License for more details. <br>
029 * <br>
030 *          You should have received a copy of the GNU Lesser General Public
031 *          License along with this library; if not see
032 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
033 *          
034 * @param <V> Variable
035 * @param <T> Value
036 */
037public interface InfoProvider<V extends Variable<V, T>, T extends Value<V, T>> {
038    /** Adds some information into the table with information about the solution
039     * @param assignment current assignment
040     * @param info info table
041     **/
042    public void getInfo(Assignment<V, T> assignment, Map<String, String> info);
043
044    /**
045     * Adds some information into the table with information about the solution,
046     * only consider variables from the given set
047     * @param assignment current assignment
048     * @param info info table 
049     * @param variables sub-problem
050     */
051    public void getInfo(Assignment<V, T> assignment, Map<String, String> info, Collection<V> variables);
052}