Author: erans
Date: Sun Oct 16 22:00:45 2011
New Revision: 1184942
URL: http://svn.apache.org/viewvc?rev=1184942&view=rev
Log:
Javadoc.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/function/StepFunction.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/function/StepFunction.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/function/StepFunction.java?rev=1184942&r1=1184941&r2=1184942&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/function/StepFunction.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/function/StepFunction.java
Sun Oct 16 22:00:45 2011
@@ -43,17 +43,19 @@ public class StepFunction implements Uni
* h(x) = y[0] for all x < x[1]
* y[1] for x[1] <= x < x[2]
* ...
- * y[y.length] for x >= x[x.length]
+ * y[y.length - 1] for x >= x[x.length - 1]
* </code></pre>
- * The value of x[0] is ignored, but it must be strictly less than x[1].
+ * The value of {@code x[0]} is ignored, but it must be strictly less than
+ * {@code x[1]}.
*
- * @param x domain values where the function changes value.
- * @param y values of the function.
+ * @param x Domain values where the function changes value.
+ * @param y Values of the function.
* @throws org.apache.commons.math.exception.NonMonotonicSequenceException
* if the {@code x} array is not sorted in strictly increasing order.
* @throws NullArgumentException if {@code x} or {@code y} are {@code
null}.
* @throws NoDataException if {@code x} or {@code y} are zero-length.
- * @throws DimensionMismatchException if x and y do not have the same
length
+ * @throws DimensionMismatchException if {@code x} and {@code y} do not
+ * have the same length.
*/
public StepFunction(double[] x,
double[] y) {
