org.jamesframework.core.search.stopcriteria.StopCriterion Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of james-core Show documentation

The James core module is part of the James framework for optimization using local search metaheuristics in Java. The core contains general components to model problems, objectives and constraints, as well as generic algorithms to solve the problems. Moreover, the core provides implementations of specific utilities for subset selection.

There is a newer version: 1.2

Show newest version

//  Copyright 2014 Herman De Beukelaer
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

package org.jamesframework.core.search.stopcriteria;

import org.jamesframework.core.exceptions.IncompatibleStopCriterionException;
import org.jamesframework.core.search.Search;

/**
 * Interface of a stop criterion that may be attached to a search to terminate it when a certain condition is met.
 * A specific stop criterion might be applicable to a certain search type only. When trying to use it for an incompatible
 * search, an {@link IncompatibleStopCriterionException} may be thrown.
 * 
 * @author Herman De Beukelaer
 */
public interface StopCriterion {

    /**
     * Checks the stop condition for a given search. If the search is not compatible with
     * this stop criterion, an {@link IncompatibleStopCriterionException} may be thrown.
     * Else, true is returned if the stop condition is met for the given
     * search, so that it should be terminated.
     * 
     * @throws IncompatibleStopCriterionException when the given search is not compatible with the stop criterion
     * @param search search for which the stop criterion should be checked
     * @return true if the stop condition is met
     */
    public boolean searchShouldStop(Search search);
    
}