Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
diff libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html @ 15:878723cc40fb
commons-math-2.1 added
| author | dwinter |
|---|---|
| date | Tue, 04 Jan 2011 10:02:41 +0100 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html Tue Jan 04 10:02:41 2011 +0100 @@ -0,0 +1,579 @@ +<!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> +MultiStartDifferentiableMultivariateRealOptimizer (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="MultiStartDifferentiableMultivariateRealOptimizer (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/MultiStartDifferentiableMultivariateRealOptimizer.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/LeastSquaresConverter.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.html" target="_top"><B>FRAMES</B></A> + <A HREF="MultiStartDifferentiableMultivariateRealOptimizer.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 MultiStartDifferentiableMultivariateRealOptimizer</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.MultiStartDifferentiableMultivariateRealOptimizer</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.39"><B>MultiStartDifferentiableMultivariateRealOptimizer</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/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</A></DL> +</PRE> + +<P> +Special implementation of the <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization"><CODE>DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#MultiStartDifferentiableMultivariateRealOptimizer(org.apache.commons.math.optimization.DifferentiableMultivariateRealOptimizer, int, org.apache.commons.math.random.RandomVectorGenerator)">MultiStartDifferentiableMultivariateRealOptimizer</A></B>(<A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/RealConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">RealConvergenceChecker</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.html#getGradientEvaluations()">getGradientEvaluations</A></B>()</CODE> + +<BR> + Get the number of evaluations of the objective function gradient.</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/MultiStartDifferentiableMultivariateRealOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.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/RealPointValuePair.html" title="class in org.apache.commons.math.optimization">RealPointValuePair</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#getOptima()">getOptima</A></B>()</CODE> + +<BR> + Get all the optima found during the last call to <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/RealPointValuePair.html" title="class in org.apache.commons.math.optimization">RealPointValuePair</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, double[])">optimize</A></B>(<A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">DifferentiableMultivariateRealFunction</A> f, + <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html" title="enum in org.apache.commons.math.optimization">GoalType</A> goalType, + 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/MultiStartDifferentiableMultivariateRealOptimizer.html#setConvergenceChecker(org.apache.commons.math.optimization.RealConvergenceChecker)">setConvergenceChecker</A></B>(<A HREF="../../../../../org/apache/commons/math/optimization/RealConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">RealConvergenceChecker</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/MultiStartDifferentiableMultivariateRealOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.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="MultiStartDifferentiableMultivariateRealOptimizer(org.apache.commons.math.optimization.DifferentiableMultivariateRealOptimizer, int, org.apache.commons.math.random.RandomVectorGenerator)"><!-- --></A><H3> +MultiStartDifferentiableMultivariateRealOptimizer</H3> +<PRE> +public <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.77"><B>MultiStartDifferentiableMultivariateRealOptimizer</B></A>(<A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/RealPointValuePair.html" title="class in org.apache.commons.math.optimization">RealPointValuePair</A>[] <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.118"><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/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/MultiStartDifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.126"><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/DifferentiableMultivariateRealOptimizer.html#setMaxIterations(int)">setMaxIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.131"><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/DifferentiableMultivariateRealOptimizer.html#getMaxIterations()">getMaxIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.136"><B>getIterations</B></A>()</PRE> +<DL> +<DD>Get the number of iterations realized by the algorithm. + <p> + The number of evaluations corresponds to the last call to the + <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/DifferentiableMultivariateRealOptimizer.html#getIterations()">getIterations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.141"><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/DifferentiableMultivariateRealOptimizer.html#setMaxEvaluations(int)">setMaxEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.146"><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/DifferentiableMultivariateRealOptimizer.html#getMaxEvaluations()">getMaxEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/MultiStartDifferentiableMultivariateRealOptimizer.html#line.151"><B>getEvaluations</B></A>()</PRE> +<DL> +<DD>Get the number of evaluations of the objective function. + <p> + The number of evaluations corresponds to the last call to the + <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/DifferentiableMultivariateRealOptimizer.html#getEvaluations()">getEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>number of evaluations of the objective function</DL> +</DD> +</DL> +<HR> + +<A NAME="getGradientEvaluations()"><!-- --></A><H3> +getGradientEvaluations</H3> +<PRE> +public int <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.156"><B>getGradientEvaluations</B></A>()</PRE> +<DL> +<DD>Get the number of evaluations of the objective function gradient. + <p> + The number of evaluations corresponds to the last call to the + <A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, 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/DifferentiableMultivariateRealOptimizer.html#getGradientEvaluations()">getGradientEvaluations</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>number of evaluations of the objective function gradient</DL> +</DD> +</DL> +<HR> + +<A NAME="setConvergenceChecker(org.apache.commons.math.optimization.RealConvergenceChecker)"><!-- --></A><H3> +setConvergenceChecker</H3> +<PRE> +public void <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.161"><B>setConvergenceChecker</B></A>(<A HREF="../../../../../org/apache/commons/math/optimization/RealConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">RealConvergenceChecker</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/DifferentiableMultivariateRealOptimizer.html#setConvergenceChecker(org.apache.commons.math.optimization.RealConvergenceChecker)">setConvergenceChecker</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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/RealConvergenceChecker.html" title="interface in org.apache.commons.math.optimization">RealConvergenceChecker</A> <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.166"><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/DifferentiableMultivariateRealOptimizer.html#getConvergenceChecker()">getConvergenceChecker</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</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.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, double[])"><!-- --></A><H3> +optimize</H3> +<PRE> +public <A HREF="../../../../../org/apache/commons/math/optimization/RealPointValuePair.html" title="class in org.apache.commons.math.optimization">RealPointValuePair</A> <A HREF="../../../../../src-html/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.html#line.171"><B>optimize</B></A>(<A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">DifferentiableMultivariateRealFunction</A> f, + <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html" title="enum in org.apache.commons.math.optimization">GoalType</A> goalType, + 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></PRE> +<DL> +<DD>Optimizes an objective function. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html#optimize(org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction, org.apache.commons.math.optimization.GoalType, double[])">optimize</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.html" title="interface in org.apache.commons.math.optimization">DifferentiableMultivariateRealOptimizer</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>f</CODE> - objective function<DD><CODE>goalType</CODE> - type of optimization goal: either <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html#MAXIMIZE"><CODE>GoalType.MAXIMIZE</CODE></A> + or <A HREF="../../../../../org/apache/commons/math/optimization/GoalType.html#MINIMIZE"><CODE>GoalType.MINIMIZE</CODE></A><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</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/MultiStartDifferentiableMultivariateRealOptimizer.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/LeastSquaresConverter.html" title="class in org.apache.commons.math.optimization"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.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/MultiStartDifferentiableMultivariateRealOptimizer.html" target="_top"><B>FRAMES</B></A> + <A HREF="MultiStartDifferentiableMultivariateRealOptimizer.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>