Author: erans
Date: Mon Dec 31 00:30:27 2012
New Revision: 1427025
URL: http://svn.apache.org/viewvc?rev=1427025&view=rev
Log:
Javadoc.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseOptimizer.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseOptimizer.java?rev=1427025&r1=1427024&r2=1427025&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseOptimizer.java
Mon Dec 31 00:30:27 2012
@@ -104,6 +104,14 @@ public abstract class BaseOptimizer<PAIR
/**
* Stores data and performs the optimization.
+ * <br/>
+ * The list of parameters is open-ended so that sub-classes can extend it
+ * with arguments specific to their concrete implementations.
+ * <br/>
+ * When the method is called multiple times, instance data is overwritten
+ * only when actually present in the list of arguments: when not specified,
+ * data set in a previous call is retained (and thus is optional in
+ * subsequent calls).
*
* @param optData Optimization data. The following data will be looked for:
* <ul>
