From 55243469e02a516b19a2023f10ca7a80b544d928 Mon Sep 17 00:00:00 2001 From: Gilles Sadowski Date: Fri, 12 Nov 2010 00:20:21 +0000 Subject: [PATCH] MATH-438 Removed deprecated class. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1034222 13f79535-47bb-0310-9956-ffa450edef68 --- .../optimization/RealConvergenceChecker.java | 56 ------------------- 1 file changed, 56 deletions(-) delete mode 100644 src/main/java/org/apache/commons/math/optimization/RealConvergenceChecker.java diff --git a/src/main/java/org/apache/commons/math/optimization/RealConvergenceChecker.java b/src/main/java/org/apache/commons/math/optimization/RealConvergenceChecker.java deleted file mode 100644 index 9f17c7b01..000000000 --- a/src/main/java/org/apache/commons/math/optimization/RealConvergenceChecker.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You 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.apache.commons.math.optimization; - -/** This interface specifies how to check if an {@link MultivariateRealOptimizer optimization - * algorithm} has converged. - * - *

Deciding if convergence has been reached is a problem-dependent issue. The - * user should provide a class implementing this interface to allow the optimization - * algorithm to stop its search according to the problem at hand.

- *

For convenience, two implementations that fit simple needs are already provided: - * {@link SimpleScalarValueChecker} and {@link SimpleRealPointChecker}. The first - * one considers convergence is reached when the objective function value does not - * change much anymore, it does not use the point set at all. The second one - * considers convergence is reached when the input point set does not change - * much anymore, it does not use objective function value at all.

- * - * @version $Revision$ $Date$ - * @since 2.0 - * @deprecated To be removed in 3.0. - */ -@Deprecated -public interface RealConvergenceChecker { - - /** Check if the optimization algorithm has converged considering the last points. - *

- * This method may be called several time from the same algorithm iteration with - * different points. This can be detected by checking the iteration number at each - * call if needed. Each time this method is called, the previous and current point - * correspond to points with the same role at each iteration, so they can be - * compared. As an example, simplex-based algorithms call this method for all - * points of the simplex, not only for the best or worst ones. - *

- * @param iteration index of current iteration - * @param previous point from previous iteration - * @param current point from current iteration - * @return true if the algorithm is considered to have converged - */ - boolean converged(int iteration, RealPointValuePair previous, RealPointValuePair current); - -}