Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html @ 32:d7a43156a79b default tip
new tabs
| author | dwinter |
|---|---|
| date | Mon, 10 Oct 2011 17:52:22 +0200 |
| parents | 878723cc40fb |
| children |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_17) on Sat Mar 27 22:46:15 EDT 2010 --> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <TITLE> MultiStartDifferentiableMultivariateVectorialOptimizer (Commons Math 2.1 API) </TITLE> <META NAME="date" CONTENT="2010-03-27"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="MultiStartDifferentiableMultivariateVectorialOptimizer (Commons Math 2.1 API)"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MultiStartDifferentiableMultivariateVectorialOptimizer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartMultivariateRealOptimizer.html" title="class in org.apache.commons.math.optimization"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html" target="_top"><B>FRAMES</B></A> <A HREF="MultiStartDifferentiableMultivariateVectorialOptimizer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.commons.math.optimization</FONT> <BR> Class MultiStartDifferentiableMultivariateVectorialOptimizer</H2> <PRE> <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> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.math.optimization.MultiStartDifferentiableMultivariateVectorialOptimizer</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></DD> </DL> <HR> <DL> <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.39"><B>MultiStartDifferentiableMultivariateVectorialOptimizer</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/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></DL> </PRE> <P> Special implementation of the <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization"><CODE>DifferentiableMultivariateVectorialOptimizer</CODE></A> interface adding multi-start features to an existing optimizer. <p> This class wraps a classical optimizer to use it several times in turn with different starting points in order to avoid being trapped into a local extremum when looking for a global one. </p> <P> <P> <DL> <DT><B>Since:</B></DT> <DD>2.0</DD> <DT><B>Version:</B></DT> <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD> </DL> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#MultiStartDifferentiableMultivariateVectorialOptimizer(org.apache.commons.math.optimization.DifferentiableMultivariateVectorialOptimizer, int, org.apache.commons.math.random.RandomVectorGenerator)">MultiStartDifferentiableMultivariateVectorialOptimizer</A></B>(<A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A> optimizer, int starts, <A HREF="../../../../../org/apache/commons/math/random/RandomVectorGenerator.html" title="interface in org.apache.commons.math.random">RandomVectorGenerator</A> generator)</CODE> <BR> Create a multi-start optimizer from a single-start optimizer</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getConvergenceChecker()">getConvergenceChecker</A></B>()</CODE> <BR> Get the convergence checker.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getEvaluations()">getEvaluations</A></B>()</CODE> <BR> Get the number of evaluations of the objective function.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getIterations()">getIterations</A></B>()</CODE> <BR> Get the number of iterations realized by the algorithm.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getJacobianEvaluations()">getJacobianEvaluations</A></B>()</CODE> <BR> Get the number of evaluations of the objective function jacobian .</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getMaxEvaluations()">getMaxEvaluations</A></B>()</CODE> <BR> Get the maximal number of functions evaluations.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getMaxIterations()">getMaxIterations</A></B>()</CODE> <BR> Get the maximal number of iterations of the algorithm.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#getOptima()">getOptima</A></B>()</CODE> <BR> Get all the optima found during the last call to <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])">optimize</A></B>(<A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">DifferentiableMultivariateVectorialFunction</A> f, double[] target, double[] weights, double[] startPoint)</CODE> <BR> Optimizes an objective function.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#setConvergenceChecker(org.apache.commons.math.optimization.VectorialConvergenceChecker)">setConvergenceChecker</A></B>(<A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A> checker)</CODE> <BR> Set the convergence checker.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#setMaxEvaluations(int)">setMaxEvaluations</A></B>(int maxEvaluations)</CODE> <BR> Set the maximal number of functions evaluations.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#setMaxIterations(int)">setMaxIterations</A></B>(int maxIterations)</CODE> <BR> Set the maximal number of iterations of the algorithm.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <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> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <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> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="MultiStartDifferentiableMultivariateVectorialOptimizer(org.apache.commons.math.optimization.DifferentiableMultivariateVectorialOptimizer, int, org.apache.commons.math.random.RandomVectorGenerator)"><!-- --></A><H3> MultiStartDifferentiableMultivariateVectorialOptimizer</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.80"><B>MultiStartDifferentiableMultivariateVectorialOptimizer</B></A>(<A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A> optimizer, int starts, <A HREF="../../../../../org/apache/commons/math/random/RandomVectorGenerator.html" title="interface in org.apache.commons.math.random">RandomVectorGenerator</A> generator)</PRE> <DL> <DD>Create a multi-start optimizer from a single-start optimizer <P> <DL> <DT><B>Parameters:</B><DD><CODE>optimizer</CODE> - single-start optimizer to wrap<DD><CODE>starts</CODE> - number of starts to perform (including the first one), multi-start is disabled if value is less than or equal to 1<DD><CODE>generator</CODE> - random vector generator to use for restarts</DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getOptima()"><!-- --></A><H3> getOptima</H3> <PRE> public <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A>[] <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.122"><B>getOptima</B></A>() throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></PRE> <DL> <DD>Get all the optima found during the last call to <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A>. <p>The optimizer stores all the optima found during a set of restarts. The <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> method returns the best point only. This method returns all the points found at the end of each starts, including the best one already returned by the <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> method. </p> <p> The returned array as one element for each start as specified in the constructor. It is ordered with the results from the runs that did converge first, sorted from best to worst objective value (i.e in ascending order if minimizing and in descending order if maximizing), followed by and null elements corresponding to the runs that did not converge. This means all elements will be null if the <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> method did throw a <A HREF="../../../../../org/apache/commons/math/ConvergenceException.html" title="class in org.apache.commons.math"><CODE>ConvergenceException</CODE></A>). This also means that if the first element is non null, it is the best point found across all starts.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>array containing the optima <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> has not been called</DL> </DD> </DL> <HR> <A NAME="setMaxIterations(int)"><!-- --></A><H3> setMaxIterations</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.130"><B>setMaxIterations</B></A>(int maxIterations)</PRE> <DL> <DD>Set the maximal number of iterations of the algorithm. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#setMaxIterations(int)">setMaxIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>maxIterations</CODE> - maximal number of function calls .</DL> </DD> </DL> <HR> <A NAME="getMaxIterations()"><!-- --></A><H3> getMaxIterations</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.135"><B>getMaxIterations</B></A>()</PRE> <DL> <DD>Get the maximal number of iterations of the algorithm. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getMaxIterations()">getMaxIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>maximal number of iterations</DL> </DD> </DL> <HR> <A NAME="getIterations()"><!-- --></A><H3> getIterations</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.140"><B>getIterations</B></A>()</PRE> <DL> <DD>Get the number of iterations realized by the algorithm. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getIterations()">getIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>number of iterations</DL> </DD> </DL> <HR> <A NAME="setMaxEvaluations(int)"><!-- --></A><H3> setMaxEvaluations</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.145"><B>setMaxEvaluations</B></A>(int maxEvaluations)</PRE> <DL> <DD>Set the maximal number of functions evaluations. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#setMaxEvaluations(int)">setMaxEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>maxEvaluations</CODE> - maximal number of function evaluations</DL> </DD> </DL> <HR> <A NAME="getMaxEvaluations()"><!-- --></A><H3> getMaxEvaluations</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.150"><B>getMaxEvaluations</B></A>()</PRE> <DL> <DD>Get the maximal number of functions evaluations. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getMaxEvaluations()">getMaxEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>maximal number of functions evaluations</DL> </DD> </DL> <HR> <A NAME="getEvaluations()"><!-- --></A><H3> getEvaluations</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.155"><B>getEvaluations</B></A>()</PRE> <DL> <DD>Get the number of evaluations of the objective function. <p> The number of evaluation correspond to the last call to the <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> method. It is 0 if the method has not been called yet. </p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getEvaluations()">getEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>number of evaluations of the objective function</DL> </DD> </DL> <HR> <A NAME="getJacobianEvaluations()"><!-- --></A><H3> getJacobianEvaluations</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.160"><B>getJacobianEvaluations</B></A>()</PRE> <DL> <DD>Get the number of evaluations of the objective function jacobian . <p> The number of evaluation correspond to the last call to the <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><CODE>optimize</CODE></A> method. It is 0 if the method has not been called yet. </p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getJacobianEvaluations()">getJacobianEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>number of evaluations of the objective function jacobian</DL> </DD> </DL> <HR> <A NAME="setConvergenceChecker(org.apache.commons.math.optimization.VectorialConvergenceChecker)"><!-- --></A><H3> setConvergenceChecker</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.165"><B>setConvergenceChecker</B></A>(<A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A> checker)</PRE> <DL> <DD>Set the convergence checker. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#setConvergenceChecker(org.apache.commons.math.optimization.VectorialConvergenceChecker)">setConvergenceChecker</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>checker</CODE> - object to use to check for convergence</DL> </DD> </DL> <HR> <A NAME="getConvergenceChecker()"><!-- --></A><H3> getConvergenceChecker</H3> <PRE> public <A HREF="../../../../../org/apache/commons/math/optimization/VectorialConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">VectorialConvergenceChecker</A> <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.170"><B>getConvergenceChecker</B></A>()</PRE> <DL> <DD>Get the convergence checker. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#getConvergenceChecker()">getConvergenceChecker</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>object used to check for convergence</DL> </DD> </DL> <HR> <A NAME="optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])"><!-- --></A><H3> optimize</H3> <PRE> public <A HREF="../../../../../org/apache/commons/math/optimization/VectorialPointValuePair.html" title="class in org.apache.commons.math.optimization">VectorialPointValuePair</A> <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html#line.175"><B>optimize</B></A>(<A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">DifferentiableMultivariateVectorialFunction</A> f, double[] target, double[] weights, double[] startPoint) throws <A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math">FunctionEvaluationException</A>, <A HREF="../../../../../org/apache/commons/math/optimization/OptimizationException.html" title="class in org.apache.commons.math.optimization">OptimizationException</A>, <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> <DL> <DD>Optimizes an objective function. <p> Optimization is considered to be a weighted least-squares minimization. The cost function to be minimized is ∑weight<sub>i</sub>(objective<sub>i</sub>-target<sub>i</sub>)<sup>2</sup> </p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction, double[], double[], double[])">optimize</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateVectorialOptimizer</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>f</CODE> - objective function<DD><CODE>target</CODE> - target value for the objective functions at optimum<DD><CODE>weights</CODE> - weight for the least squares cost computation<DD><CODE>startPoint</CODE> - the start point for optimization <DT><B>Returns:</B><DD>the point/value pair giving the optimal value for objective function <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math">FunctionEvaluationException</A></CODE> - if the objective function throws one during the search <DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/OptimizationException.html" title="class in org.apache.commons.math.optimization">OptimizationException</A></CODE> - if the algorithm failed to converge <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 start point dimension is wrong</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MultiStartDifferentiableMultivariateVectorialOptimizer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartMultivariateRealOptimizer.html" title="class in org.apache.commons.math.optimization"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.html" target="_top"><B>FRAMES</B></A> <A HREF="MultiStartDifferentiableMultivariateVectorialOptimizer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. </BODY> </HTML>