Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
comparison libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/optimization/LeastSquaresConverter.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 LeastSquaresConverter (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="LeastSquaresConverter (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> </TD> | |
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LeastSquaresConverter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html" title="enum in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> | |
60 <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html" title="class 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/LeastSquaresConverter.html" target="_top"><B>FRAMES</B></A> | |
63 <A HREF="LeastSquaresConverter.html" target="_top"><B>NO FRAMES</B></A> | |
64 <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
82 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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 LeastSquaresConverter</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.LeastSquaresConverter</B> | |
98 </PRE> | |
99 <DL> | |
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></DD> | |
101 </DL> | |
102 <HR> | |
103 <DL> | |
104 <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/optimization/LeastSquaresConverter.html#line.57"><B>LeastSquaresConverter</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/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></DL> | |
105 </PRE> | |
106 | |
107 <P> | |
108 This class converts <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>vectorial | |
109 objective functions</CODE></A> to <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>scalar objective functions</CODE></A> | |
110 when the goal is to minimize them. | |
111 <p> | |
112 This class is mostly used when the vectorial objective function represents | |
113 a theoretical result computed from a point set applied to a model and | |
114 the models point must be adjusted to fit the theoretical result to some | |
115 reference observations. The observations may be obtained for example from | |
116 physical measurements whether the model is built from theoretical | |
117 considerations. | |
118 </p> | |
119 <p> | |
120 This class computes a possibly weighted squared sum of the residuals, which is | |
121 a scalar value. The residuals are the difference between the theoretical model | |
122 (i.e. the output of the vectorial objective function) and the observations. The | |
123 class implements the <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>MultivariateRealFunction</CODE></A> interface and can therefore be | |
124 minimized by any optimizer supporting scalar objectives functions.This is one way | |
125 to perform a least square estimation. There are other ways to do this without using | |
126 this converter, as some optimization algorithms directly support vectorial objective | |
127 functions. | |
128 </p> | |
129 <p> | |
130 This class support combination of residuals with or without weights and correlations. | |
131 </p> | |
132 <P> | |
133 | |
134 <P> | |
135 <DL> | |
136 <DT><B>Since:</B></DT> | |
137 <DD>2.0</DD> | |
138 <DT><B>Version:</B></DT> | |
139 <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD> | |
140 <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>MultivariateRealFunction</CODE></A>, | |
141 <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>MultivariateVectorialFunction</CODE></A></DL> | |
142 <HR> | |
143 | |
144 <P> | |
145 | |
146 <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
147 | |
148 <A NAME="constructor_summary"><!-- --></A> | |
149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
151 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
152 <B>Constructor Summary</B></FONT></TH> | |
153 </TR> | |
154 <TR BGCOLOR="white" CLASS="TableRowColor"> | |
155 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[])">LeastSquaresConverter</A></B>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
156 double[] observations)</CODE> | |
157 | |
158 <BR> | |
159 Build a simple converter for uncorrelated residuals with the same weight.</TD> | |
160 </TR> | |
161 <TR BGCOLOR="white" CLASS="TableRowColor"> | |
162 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[], double[])">LeastSquaresConverter</A></B>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
163 double[] observations, | |
164 double[] weights)</CODE> | |
165 | |
166 <BR> | |
167 Build a simple converter for uncorrelated residuals with the specific weights.</TD> | |
168 </TR> | |
169 <TR BGCOLOR="white" CLASS="TableRowColor"> | |
170 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[], org.apache.commons.math.linear.RealMatrix)">LeastSquaresConverter</A></B>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
171 double[] observations, | |
172 <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> scale)</CODE> | |
173 | |
174 <BR> | |
175 Build a simple converter for correlated residuals with the specific weights.</TD> | |
176 </TR> | |
177 </TABLE> | |
178 | |
179 <!-- ========== METHOD SUMMARY =========== --> | |
180 | |
181 <A NAME="method_summary"><!-- --></A> | |
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
184 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
185 <B>Method Summary</B></FONT></TH> | |
186 </TR> | |
187 <TR BGCOLOR="white" CLASS="TableRowColor"> | |
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
189 <CODE> double</CODE></FONT></TD> | |
190 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#value(double[])">value</A></B>(double[] point)</CODE> | |
191 | |
192 <BR> | |
193 Compute the value for the function at the given point.</TD> | |
194 </TR> | |
195 </TABLE> | |
196 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
197 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
198 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
199 <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> | |
200 </TR> | |
201 <TR BGCOLOR="white" CLASS="TableRowColor"> | |
202 <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> | |
203 </TR> | |
204 </TABLE> | |
205 | |
206 <P> | |
207 | |
208 <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
209 | |
210 <A NAME="constructor_detail"><!-- --></A> | |
211 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
212 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
213 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
214 <B>Constructor Detail</B></FONT></TH> | |
215 </TR> | |
216 </TABLE> | |
217 | |
218 <A NAME="LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[])"><!-- --></A><H3> | |
219 LeastSquaresConverter</H3> | |
220 <PRE> | |
221 public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/LeastSquaresConverter.html#line.75"><B>LeastSquaresConverter</B></A>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
222 double[] observations)</PRE> | |
223 <DL> | |
224 <DD>Build a simple converter for uncorrelated residuals with the same weight. | |
225 <P> | |
226 <DL> | |
227 <DT><B>Parameters:</B><DD><CODE>function</CODE> - vectorial residuals function to wrap<DD><CODE>observations</CODE> - observations to be compared to objective function to compute residuals</DL> | |
228 </DL> | |
229 <HR> | |
230 | |
231 <A NAME="LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[], double[])"><!-- --></A><H3> | |
232 LeastSquaresConverter</H3> | |
233 <PRE> | |
234 public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/LeastSquaresConverter.html#line.111"><B>LeastSquaresConverter</B></A>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
235 double[] observations, | |
236 double[] weights) | |
237 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE> | |
238 <DL> | |
239 <DD>Build a simple converter for uncorrelated residuals with the specific weights. | |
240 <p> | |
241 The scalar objective function value is computed as: | |
242 <pre> | |
243 objective = ∑weight<sub>i</sub>(observation<sub>i</sub>-objective<sub>i</sub>)<sup>2</sup> | |
244 </pre> | |
245 </p> | |
246 <p> | |
247 Weights can be used for example to combine residuals with different standard | |
248 deviations. As an example, consider a residuals array in which even elements | |
249 are angular measurements in degrees with a 0.01° standard deviation and | |
250 odd elements are distance measurements in meters with a 15m standard deviation. | |
251 In this case, the weights array should be initialized with value | |
252 1.0/(0.01<sup>2</sup>) in the even elements and 1.0/(15.0<sup>2</sup>) in the | |
253 odd elements (i.e. reciprocals of variances). | |
254 </p> | |
255 <p> | |
256 The array computed by the objective function, the observations array and the | |
257 weights array must have consistent sizes or a <A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math"><CODE>FunctionEvaluationException</CODE></A> will be | |
258 triggered while computing the scalar objective. | |
259 </p> | |
260 <P> | |
261 <DL> | |
262 <DT><B>Parameters:</B><DD><CODE>function</CODE> - vectorial residuals function to wrap<DD><CODE>observations</CODE> - observations to be compared to objective function to compute residuals<DD><CODE>weights</CODE> - weights to apply to the residuals | |
263 <DT><B>Throws:</B> | |
264 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the observations vector and the weights | |
265 vector dimensions don't match (objective function dimension is checked only when | |
266 the <A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#value(double[])"><CODE>value(double[])</CODE></A> method is called)</DL> | |
267 </DL> | |
268 <HR> | |
269 | |
270 <A NAME="LeastSquaresConverter(org.apache.commons.math.analysis.MultivariateVectorialFunction, double[], org.apache.commons.math.linear.RealMatrix)"><!-- --></A><H3> | |
271 LeastSquaresConverter</H3> | |
272 <PRE> | |
273 public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/LeastSquaresConverter.html#line.144"><B>LeastSquaresConverter</B></A>(<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> function, | |
274 double[] observations, | |
275 <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> scale) | |
276 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE> | |
277 <DL> | |
278 <DD>Build a simple converter for correlated residuals with the specific weights. | |
279 <p> | |
280 The scalar objective function value is computed as: | |
281 <pre> | |
282 objective = y<sup>T</sup>y with y = scale×(observation-objective) | |
283 </pre> | |
284 </p> | |
285 <p> | |
286 The array computed by the objective function, the observations array and the | |
287 the scaling matrix must have consistent sizes or a <A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math"><CODE>FunctionEvaluationException</CODE></A> | |
288 will be triggered while computing the scalar objective. | |
289 </p> | |
290 <P> | |
291 <DL> | |
292 <DT><B>Parameters:</B><DD><CODE>function</CODE> - vectorial residuals function to wrap<DD><CODE>observations</CODE> - observations to be compared to objective function to compute residuals<DD><CODE>scale</CODE> - scaling matrix | |
293 <DT><B>Throws:</B> | |
294 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the observations vector and the scale | |
295 matrix dimensions don't match (objective function dimension is checked only when | |
296 the <A HREF="../../../../../org/apache/commons/math/optimization/LeastSquaresConverter.html#value(double[])"><CODE>value(double[])</CODE></A> method is called)</DL> | |
297 </DL> | |
298 | |
299 <!-- ============ METHOD DETAIL ========== --> | |
300 | |
301 <A NAME="method_detail"><!-- --></A> | |
302 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
303 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
304 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
305 <B>Method Detail</B></FONT></TH> | |
306 </TR> | |
307 </TABLE> | |
308 | |
309 <A NAME="value(double[])"><!-- --></A><H3> | |
310 value</H3> | |
311 <PRE> | |
312 public double <A HREF="../../../../../src-html/org/apache/commons/math/optimization/LeastSquaresConverter.html#line.159"><B>value</B></A>(double[] point) | |
313 throws <A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math">FunctionEvaluationException</A></PRE> | |
314 <DL> | |
315 <DD>Compute the value for the function at the given point. | |
316 <P> | |
317 <DD><DL> | |
318 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html#value(double[])">value</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></CODE></DL> | |
319 </DD> | |
320 <DD><DL> | |
321 <DT><B>Parameters:</B><DD><CODE>point</CODE> - point at which the function must be evaluated | |
322 <DT><B>Returns:</B><DD>function value for the given point | |
323 <DT><B>Throws:</B> | |
324 <DD><CODE><A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math">FunctionEvaluationException</A></CODE> - if the function evaluation fails</DL> | |
325 </DD> | |
326 </DL> | |
327 <!-- ========= END OF CLASS DATA ========= --> | |
328 <HR> | |
329 | |
330 | |
331 <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
332 <A NAME="navbar_bottom"><!-- --></A> | |
333 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
334 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
335 <TR> | |
336 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
337 <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
338 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
339 <TR ALIGN="center" VALIGN="top"> | |
340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
342 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LeastSquaresConverter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
348 </TR> | |
349 </TABLE> | |
350 </TD> | |
351 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
352 </EM> | |
353 </TD> | |
354 </TR> | |
355 | |
356 <TR> | |
357 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
358 <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html" title="enum in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> | |
359 <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html" title="class in org.apache.commons.math.optimization"><B>NEXT CLASS</B></A></FONT></TD> | |
360 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
361 <A HREF="../../../../../index.html?org/apache/commons/math/optimization/LeastSquaresConverter.html" target="_top"><B>FRAMES</B></A> | |
362 <A HREF="LeastSquaresConverter.html" target="_top"><B>NO FRAMES</B></A> | |
363 <SCRIPT type="text/javascript"> | |
364 <!-- | |
365 if(window==top) { | |
366 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
367 } | |
368 //--> | |
369 </SCRIPT> | |
370 <NOSCRIPT> | |
371 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
372 </NOSCRIPT> | |
373 | |
374 | |
375 </FONT></TD> | |
376 </TR> | |
377 <TR> | |
378 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
379 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
380 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
381 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
382 </TR> | |
383 </TABLE> | |
384 <A NAME="skip-navbar_bottom"></A> | |
385 <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
386 | |
387 <HR> | |
388 Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
389 </BODY> | |
390 </HTML> |