Author: erans
Date: Thu Nov 29 13:27:10 2012
New Revision: 1415158
URL: http://svn.apache.org/viewvc?rev=1415158&view=rev
Log:
Javadoc.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java?rev=1415158&r1=1415157&r2=1415158&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
Thu Nov 29 13:27:10 2012
@@ -100,9 +100,9 @@ public class DerivativeStructure impleme
* themselves is +1.</p>
* @param parameters number of free parameters
* @param order derivation order
- * @param index index of the variable (from 0 to {@code variables - 1})
+ * @param index index of the variable (from 0 to {@code parameters - 1})
* @param value value of the variable
- * @exception NumberIsTooLargeException if index is equal to variables or
larger
+ * @exception NumberIsTooLargeException if {@code index >= parameters}.
* @see #DerivativeStructure(int, int, double)
*/
public DerivativeStructure(final int parameters, final int order,
@@ -115,7 +115,7 @@ public class DerivativeStructure impleme
}
if (order > 0) {
- // the derivative of the variable with respect to itself is 1.0
+ // the derivative of the variable with respect to itself is 1.
data[DSCompiler.getCompiler(index, order).getSize()] = 1.0;
}
