1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 package org.apache.commons.math.optimization; 19 20 /** This interface specifies how to check if a {@link 21 * DirectSearchOptimizer direct search method} has converged. 22 * 23 * <p>Deciding if convergence has been reached is a problem-dependent 24 * issue. The user should provide a class implementing this interface 25 * to allow the optimization algorithm to stop its search according to 26 * the problem at hand.</p> 27 * 28 * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $ 29 * @since 1.2 30 */ 31 32 public interface ConvergenceChecker { 33 34 /** Check if the optimization algorithm has converged on the simplex. 35 * @param simplex ordered simplex (all points in the simplex have 36 * been eavluated and are sorted from lowest to largest cost) 37 * @return true if the algorithm is considered to have converged 38 */ 39 public boolean converged (PointCostPair[] simplex); 40 41 }