001package org.cpsolver.ifs.algorithms.neighbourhoods;
002
003import org.cpsolver.ifs.heuristics.NeighbourSelection;
004
005/**
006 * This interface may be implemented by a {@link NeighbourSelection} to indicate that it is employed by a hill climber.
007 * <br>
008 * 
009 * @version IFS 1.3 (Iterative Forward Search)<br>
010 *          Copyright (C) 2014 Tomáš Müller<br>
011 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
012 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
013 * <br>
014 *          This library is free software; you can redistribute it and/or modify
015 *          it under the terms of the GNU Lesser General Public License as
016 *          published by the Free Software Foundation; either version 3 of the
017 *          License, or (at your option) any later version. <br>
018 * <br>
019 *          This library is distributed in the hope that it will be useful, but
020 *          WITHOUT ANY WARRANTY; without even the implied warranty of
021 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
022 *          Lesser General Public License for more details. <br>
023 * <br>
024 *          You should have received a copy of the GNU Lesser General Public
025 *          License along with this library; if not see
026 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
027 **/
028public interface HillClimberSelection {
029    
030    /**
031     * True if employed by a hill climber, e.g., worsening moves may be skipped.
032     * @param hcMode true if used by a hill climber (worsening moves are automatically discarded)
033     */
034    public void setHcMode(boolean hcMode);
035}