comparison libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/optimization/SimpleVectorialValueChecker.html @ 15:878723cc40fb

commons-math-2.1 added
author dwinter
date Tue, 04 Jan 2011 10:02:41 +0100
parents
children
comparison
equal deleted inserted replaced
14:d6bddffc2fbb 15:878723cc40fb
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.6.0_17) on Sat Mar 27 22:46:15 EDT 2010 -->
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <TITLE>
8 SimpleVectorialValueChecker (Commons Math 2.1 API)
9 </TITLE>
10
11 <META NAME="date" CONTENT="2010-03-27">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="SimpleVectorialValueChecker (Commons Math 2.1 API)";
20 }
21 }
22 </SCRIPT>
23 <NOSCRIPT>
24 </NOSCRIPT>
25
26 </HEAD>
27
28 <BODY BGCOLOR="white" onload="windowTitle();">
29 <HR>
30
31
32 <!-- ========= START OF TOP NAVBAR ======= -->
33 <A NAME="navbar_top"><!-- --></A>
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36 <TR>
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38 <A NAME="navbar_top_firstrow"><!-- --></A>
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SimpleVectorialValueChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49 </TR>
50 </TABLE>
51 </TD>
52 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53 </EM>
54 </TD>
55 </TR>
56
57 <TR>
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 &nbsp;<A HREF="../../../../../org/apache/commons/math/optimization/SimpleVectorialPointChecker.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A>&nbsp;
60 &nbsp;<A HREF="../../../../../org/apache/commons/math/optimization/UnivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization"><B>NEXT CLASS</B></A></FONT></TD>
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../../index.html?org/apache/commons/math/optimization/SimpleVectorialValueChecker.html" target="_top"><B>FRAMES</B></A> &nbsp;
63 &nbsp;<A HREF="SimpleVectorialValueChecker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
64 &nbsp;<SCRIPT type="text/javascript">
65 <!--
66 if(window==top) {
67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68 }
69 //-->
70 </SCRIPT>
71 <NOSCRIPT>
72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
73 </NOSCRIPT>
74
75
76 </FONT></TD>
77 </TR>
78 <TR>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
83 </TR>
84 </TABLE>
85 <A NAME="skip-navbar_top"></A>
86 <!-- ========= END OF TOP NAVBAR ========= -->
87
88 <HR>
89 <!-- ======== START OF CLASS DATA ======== -->
90 <H2>
91 <FONT SIZE="-1">
92 org.apache.commons.math.optimization</FONT>
93 <BR>
94 Class SimpleVectorialValueChecker</H2>
95 <PRE>
96 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.math.optimization.SimpleVectorialValueChecker</B>
98 </PRE>
99 <DL>
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A></DD>
101 </DL>
102 <HR>
103 <DL>
104 <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#line.34"><B>SimpleVectorialValueChecker</B></A><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A></DL>
105 </PRE>
106
107 <P>
108 Simple implementation of the <A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization"><CODE>VectorialConvergenceChecker</CODE></A> interface using
109 only objective function values.
110 <p>
111 Convergence is considered to have been reached if either the relative
112 difference between the objective function values is smaller than a
113 threshold or if either the absolute difference between the objective
114 function values is smaller than another threshold for all vectors elements.
115 </p>
116 <P>
117
118 <P>
119 <DL>
120 <DT><B>Since:</B></DT>
121 <DD>2.0</DD>
122 <DT><B>Version:</B></DT>
123 <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD>
124 </DL>
125 <HR>
126
127 <P>
128
129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
130
131 <A NAME="constructor_summary"><!-- --></A>
132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135 <B>Constructor Summary</B></FONT></TH>
136 </TR>
137 <TR BGCOLOR="white" CLASS="TableRowColor">
138 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#SimpleVectorialValueChecker()">SimpleVectorialValueChecker</A></B>()</CODE>
139
140 <BR>
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Build an instance with default threshold.</TD>
142 </TR>
143 <TR BGCOLOR="white" CLASS="TableRowColor">
144 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#SimpleVectorialValueChecker(double, double)">SimpleVectorialValueChecker</A></B>(double&nbsp;relativeThreshold,
145 double&nbsp;absoluteThreshold)</CODE>
146
147 <BR>
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Build an instance with a specified threshold.</TD>
149 </TR>
150 </TABLE>
151 &nbsp;
152 <!-- ========== METHOD SUMMARY =========== -->
153
154 <A NAME="method_summary"><!-- --></A>
155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
158 <B>Method Summary</B></FONT></TH>
159 </TR>
160 <TR BGCOLOR="white" CLASS="TableRowColor">
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162 <CODE>&nbsp;boolean</CODE></FONT></TD>
163 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#converged(int, org.apache.commons.math.optimization.VectorialPointValuePair, org.apache.commons.math.optimization.VectorialPointValuePair)">converged</A></B>(int&nbsp;iteration,
164 <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>&nbsp;previous,
165 <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>&nbsp;current)</CODE>
166
167 <BR>
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check if the optimization algorithm has converged considering the last points.</TD>
169 </TR>
170 </TABLE>
171 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
172 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
175 </TR>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
178 </TR>
179 </TABLE>
180 &nbsp;
181 <P>
182
183 <!-- ========= CONSTRUCTOR DETAIL ======== -->
184
185 <A NAME="constructor_detail"><!-- --></A>
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
189 <B>Constructor Detail</B></FONT></TH>
190 </TR>
191 </TABLE>
192
193 <A NAME="SimpleVectorialValueChecker()"><!-- --></A><H3>
194 SimpleVectorialValueChecker</H3>
195 <PRE>
196 public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#line.50"><B>SimpleVectorialValueChecker</B></A>()</PRE>
197 <DL>
198 <DD>Build an instance with default threshold.
199 <P>
200 </DL>
201 <HR>
202
203 <A NAME="SimpleVectorialValueChecker(double, double)"><!-- --></A><H3>
204 SimpleVectorialValueChecker</H3>
205 <PRE>
206 public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#line.64"><B>SimpleVectorialValueChecker</B></A>(double&nbsp;relativeThreshold,
207 double&nbsp;absoluteThreshold)</PRE>
208 <DL>
209 <DD>Build an instance with a specified threshold.
210 <p>
211 In order to perform only relative checks, the absolute tolerance
212 must be set to a negative value. In order to perform only absolute
213 checks, the relative tolerance must be set to a negative value.
214 </p>
215 <P>
216 <DL>
217 <DT><B>Parameters:</B><DD><CODE>relativeThreshold</CODE> - relative tolerance threshold<DD><CODE>absoluteThreshold</CODE> - absolute tolerance threshold</DL>
218 </DL>
219
220 <!-- ============ METHOD DETAIL ========== -->
221
222 <A NAME="method_detail"><!-- --></A>
223 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
225 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
226 <B>Method Detail</B></FONT></TH>
227 </TR>
228 </TABLE>
229
230 <A NAME="converged(int, org.apache.commons.math.optimization.VectorialPointValuePair, org.apache.commons.math.optimization.VectorialPointValuePair)"><!-- --></A><H3>
231 converged</H3>
232 <PRE>
233 public boolean <A HREF="../../../../../src-html/org/apache/commons/math/optimization/SimpleVectorialValueChecker.html#line.71"><B>converged</B></A>(int&nbsp;iteration,
234 <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>&nbsp;previous,
235 <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>&nbsp;current)</PRE>
236 <DL>
237 <DD>Check if the optimization algorithm has converged considering the last points.
238 <p>
239 This method may be called several time from the same algorithm iteration with
240 different points. This can be detected by checking the iteration number at each
241 call if needed. Each time this method is called, the previous and current point
242 correspond to points with the same role at each iteration, so they can be
243 compared. As an example, simplex-based algorithms call this method for all
244 points of the simplex, not only for the best or worst ones.
245 </p>
246 <P>
247 <DD><DL>
248 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html#converged(int, org.apache.commons.math.optimization.VectorialPointValuePair, org.apache.commons.math.optimization.VectorialPointValuePair)">converged</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A></CODE></DL>
249 </DD>
250 <DD><DL>
251 <DT><B>Parameters:</B><DD><CODE>iteration</CODE> - index of current iteration<DD><CODE>previous</CODE> - point from previous iteration<DD><CODE>current</CODE> - point from current iteration
252 <DT><B>Returns:</B><DD>true if the algorithm is considered to have converged</DL>
253 </DD>
254 </DL>
255 <!-- ========= END OF CLASS DATA ========= -->
256 <HR>
257
258
259 <!-- ======= START OF BOTTOM NAVBAR ====== -->
260 <A NAME="navbar_bottom"><!-- --></A>
261 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
262 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
263 <TR>
264 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
265 <A NAME="navbar_bottom_firstrow"><!-- --></A>
266 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
267 <TR ALIGN="center" VALIGN="top">
268 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
269 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
270 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
271 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SimpleVectorialValueChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
272 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
273 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
274 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
275 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
276 </TR>
277 </TABLE>
278 </TD>
279 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
280 </EM>
281 </TD>
282 </TR>
283
284 <TR>
285 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
286 &nbsp;<A HREF="../../../../../org/apache/commons/math/optimization/SimpleVectorialPointChecker.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A>&nbsp;
287 &nbsp;<A HREF="../../../../../org/apache/commons/math/optimization/UnivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization"><B>NEXT CLASS</B></A></FONT></TD>
288 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
289 <A HREF="../../../../../index.html?org/apache/commons/math/optimization/SimpleVectorialValueChecker.html" target="_top"><B>FRAMES</B></A> &nbsp;
290 &nbsp;<A HREF="SimpleVectorialValueChecker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
291 &nbsp;<SCRIPT type="text/javascript">
292 <!--
293 if(window==top) {
294 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
295 }
296 //-->
297 </SCRIPT>
298 <NOSCRIPT>
299 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
300 </NOSCRIPT>
301
302
303 </FONT></TD>
304 </TR>
305 <TR>
306 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
307 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
308 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
309 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
310 </TR>
311 </TABLE>
312 <A NAME="skip-navbar_bottom"></A>
313 <!-- ======== END OF BOTTOM NAVBAR ======= -->
314
315 <HR>
316 Copyright &#169; 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
317 </BODY>
318 </HTML>