|
13
|
1 <HTML>
|
|
|
2 <BODY BGCOLOR="white">
|
|
|
3 <PRE>
|
|
|
4 <FONT color="green">001</FONT> /*<a name="line.1"></a>
|
|
|
5 <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
|
|
|
6 <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
|
|
|
7 <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
|
|
|
8 <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
|
|
|
9 <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
|
|
|
10 <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
|
|
|
11 <FONT color="green">008</FONT> *<a name="line.8"></a>
|
|
|
12 <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
|
|
|
13 <FONT color="green">010</FONT> *<a name="line.10"></a>
|
|
|
14 <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
|
|
|
15 <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
|
|
|
16 <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
|
|
|
17 <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a>
|
|
|
18 <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a>
|
|
|
19 <FONT color="green">016</FONT> */<a name="line.16"></a>
|
|
|
20 <FONT color="green">017</FONT> <a name="line.17"></a>
|
|
|
21 <FONT color="green">018</FONT> package org.apache.commons.math.optimization;<a name="line.18"></a>
|
|
|
22 <FONT color="green">019</FONT> <a name="line.19"></a>
|
|
|
23 <FONT color="green">020</FONT> /** This interface specifies how to check if a {@link<a name="line.20"></a>
|
|
|
24 <FONT color="green">021</FONT> * DifferentiableMultivariateVectorialOptimizer optimization algorithm} has converged.<a name="line.21"></a>
|
|
|
25 <FONT color="green">022</FONT> *<a name="line.22"></a>
|
|
|
26 <FONT color="green">023</FONT> * <p>Deciding if convergence has been reached is a problem-dependent issue. The<a name="line.23"></a>
|
|
|
27 <FONT color="green">024</FONT> * user should provide a class implementing this interface to allow the optimization<a name="line.24"></a>
|
|
|
28 <FONT color="green">025</FONT> * algorithm to stop its search according to the problem at hand.</p><a name="line.25"></a>
|
|
|
29 <FONT color="green">026</FONT> * <p>For convenience, two implementations that fit simple needs are already provided:<a name="line.26"></a>
|
|
|
30 <FONT color="green">027</FONT> * {@link SimpleVectorialValueChecker} and {@link SimpleVectorialPointChecker}. The first<a name="line.27"></a>
|
|
|
31 <FONT color="green">028</FONT> * one considers convergence is reached when the objective function value does not<a name="line.28"></a>
|
|
|
32 <FONT color="green">029</FONT> * change much anymore, it does not use the point set at all. The second one<a name="line.29"></a>
|
|
|
33 <FONT color="green">030</FONT> * considers convergence is reached when the input point set does not change<a name="line.30"></a>
|
|
|
34 <FONT color="green">031</FONT> * much anymore, it does not use objective function value at all.</p><a name="line.31"></a>
|
|
|
35 <FONT color="green">032</FONT> *<a name="line.32"></a>
|
|
|
36 <FONT color="green">033</FONT> * @version $Revision: 780674 $ $Date: 2009-06-01 11:10:55 -0400 (Mon, 01 Jun 2009) $<a name="line.33"></a>
|
|
|
37 <FONT color="green">034</FONT> * @since 2.0<a name="line.34"></a>
|
|
|
38 <FONT color="green">035</FONT> */<a name="line.35"></a>
|
|
|
39 <FONT color="green">036</FONT> <a name="line.36"></a>
|
|
|
40 <FONT color="green">037</FONT> public interface VectorialConvergenceChecker {<a name="line.37"></a>
|
|
|
41 <FONT color="green">038</FONT> <a name="line.38"></a>
|
|
|
42 <FONT color="green">039</FONT> /** Check if the optimization algorithm has converged considering the last points.<a name="line.39"></a>
|
|
|
43 <FONT color="green">040</FONT> * <p><a name="line.40"></a>
|
|
|
44 <FONT color="green">041</FONT> * This method may be called several time from the same algorithm iteration with<a name="line.41"></a>
|
|
|
45 <FONT color="green">042</FONT> * different points. This can be detected by checking the iteration number at each<a name="line.42"></a>
|
|
|
46 <FONT color="green">043</FONT> * call if needed. Each time this method is called, the previous and current point<a name="line.43"></a>
|
|
|
47 <FONT color="green">044</FONT> * correspond to points with the same role at each iteration, so they can be<a name="line.44"></a>
|
|
|
48 <FONT color="green">045</FONT> * compared. As an example, simplex-based algorithms call this method for all<a name="line.45"></a>
|
|
|
49 <FONT color="green">046</FONT> * points of the simplex, not only for the best or worst ones.<a name="line.46"></a>
|
|
|
50 <FONT color="green">047</FONT> * </p><a name="line.47"></a>
|
|
|
51 <FONT color="green">048</FONT> * @param iteration index of current iteration<a name="line.48"></a>
|
|
|
52 <FONT color="green">049</FONT> * @param previous point from previous iteration<a name="line.49"></a>
|
|
|
53 <FONT color="green">050</FONT> * @param current point from current iteration<a name="line.50"></a>
|
|
|
54 <FONT color="green">051</FONT> * @return true if the algorithm is considered to have converged<a name="line.51"></a>
|
|
|
55 <FONT color="green">052</FONT> */<a name="line.52"></a>
|
|
|
56 <FONT color="green">053</FONT> boolean converged(int iteration, VectorialPointValuePair previous, VectorialPointValuePair current);<a name="line.53"></a>
|
|
|
57 <FONT color="green">054</FONT> <a name="line.54"></a>
|
|
|
58 <FONT color="green">055</FONT> }<a name="line.55"></a>
|
|
|
59
|
|
|
60
|
|
|
61
|
|
|
62
|
|
|
63
|
|
|
64
|
|
|
65
|
|
|
66
|
|
|
67
|
|
|
68
|
|
|
69
|
|
|
70
|
|
|
71
|
|
|
72
|
|
|
73
|
|
|
74
|
|
|
75
|
|
|
76
|
|
|
77
|
|
|
78
|
|
|
79
|
|
|
80
|
|
|
81
|
|
|
82
|
|
|
83
|
|
|
84
|
|
|
85
|
|
|
86
|
|
|
87
|
|
|
88
|
|
|
89
|
|
|
90
|
|
|
91
|
|
|
92
|
|
|
93
|
|
|
94
|
|
|
95
|
|
|
96
|
|
|
97
|
|
|
98
|
|
|
99
|
|
|
100
|
|
|
101
|
|
|
102
|
|
|
103
|
|
|
104
|
|
|
105
|
|
|
106
|
|
|
107
|
|
|
108
|
|
|
109
|
|
|
110
|
|
|
111
|
|
|
112
|
|
|
113
|
|
|
114
|
|
|
115
|
|
|
116
|
|
|
117
|
|
|
118
|
|
|
119 </PRE>
|
|
|
120 </BODY>
|
|
|
121 </HTML>
|
