001package org.cpsolver.ifs.assignment;
002
003import org.cpsolver.ifs.model.Value;
004import org.cpsolver.ifs.model.Variable;
005
006/**
007 * Comparable interface for assignment-dependent objects. To be used by
008 * {@link AssignmentComparator}.
009 * 
010 * 
011 * @version IFS 1.3 (Iterative Forward Search)<br>
012 *          Copyright (C) 2014 Tomáš Müller<br>
013 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
014 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
015 * <br>
016 *          This library is free software; you can redistribute it and/or modify
017 *          it under the terms of the GNU Lesser General Public License as
018 *          published by the Free Software Foundation; either version 3 of the
019 *          License, or (at your option) any later version. <br>
020 * <br>
021 *          This library is distributed in the hope that it will be useful, but
022 *          WITHOUT ANY WARRANTY; without even the implied warranty of
023 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
024 *          Lesser General Public License for more details. <br>
025 * <br>
026 *          You should have received a copy of the GNU Lesser General Public
027 *          License along with this library; if not see <a href='http://www.gnu.org/licenses'>http://www.gnu.org/licenses</a>.
028 * @param <X> A class implementing this interface
029 * @param <V> Variable
030 * @param <T> Value
031 **/
032public interface AssignmentComparable<X, V extends Variable<V, T>, T extends Value<V, T>> extends Comparable<X> {
033    
034        /**
035         * Compare this object with a given one.
036         * @param assignment current assignment
037         * @param other other instance
038         * @return comparison of this instance and the given one
039         */
040    public int compareTo(Assignment<V, T> assignment, X other);
041    
042    @Deprecated
043    @Override
044    /**
045     * Compare this object with a given one.
046     * @param other other instance
047     * @return comparison of this instance and the given one
048     */
049    public int compareTo(X other);
050}