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