MATH-193. javadoc and style fixes.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@635154 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/math/linear/BigMatrixImpl.java

@@ -104,7 +104,7 @@ public class BigMatrixImpl implements BigMatrix, Serializable {
     }
     
     /**
-     * Create a new BigMatrix using the <code>data</code> as the underlying
+     * Create a new BigMatrix using <code>d</code> as the underlying
      * data array.
      * <p>
      * The input array is copied, not referenced.</p>
@@ -120,7 +120,7 @@ public class BigMatrixImpl implements BigMatrix, Serializable {
     }
     
     /**
-     * Create a new BigMatrix using the <code>data</code> as the underlying
+     * Create a new BigMatrix using <code>d</code> as the underlying
      * data array.
      * <p>
      * The input array is copied, not referenced.</p>
@@ -153,7 +153,7 @@ public class BigMatrixImpl implements BigMatrix, Serializable {
     
     /**
      * Create a new BigMatrix using the values represented by the strings in 
-     * <code>data</code> as the underlying data array.
+     * <code>d</code> as the underlying data array.
      *
      * @param d data for new matrix
      * @throws IllegalArgumentException if <code>d</code> is not rectangular

src/java/org/apache/commons/math/linear/RealMatrixImpl.java

@@ -101,9 +101,9 @@ public class RealMatrixImpl implements RealMatrix, Serializable {
      * The input array is copied, not referenced.</p>
      *
      * @param d data for new matrix
-     * @throws IllegalArgumentException if <code>data</code> is not rectangular
+     * @throws IllegalArgumentException if <code>d</code> is not rectangular
      *  (not all rows have the same length) or empty
-     * @throws NullPointerException if <code>data</code> is null
+     * @throws NullPointerException if <code>d</code> is null
      */
     public RealMatrixImpl(double[][] d) {
         this.copyIn(d);
@@ -164,7 +164,7 @@ public class RealMatrixImpl implements RealMatrix, Serializable {
      *
      * @param m    matrix to be subtracted
      * @return     this + m
-     * @throws  IllegalArgumentException if m is not the same size as *this
+     * @throws  IllegalArgumentException if m is not the same size as this
      */
     public RealMatrix subtract(RealMatrix m) throws IllegalArgumentException {
         if (this.getColumnDimension() != m.getColumnDimension() ||

src/java/org/apache/commons/math/ode/ContinuousOutputModel.java

@@ -19,6 +19,7 @@ package org.apache.commons.math.ode;
 
 import java.util.ArrayList;
 import java.util.Iterator;
+import java.util.List;
 import java.io.Serializable;
 
 /**
@@ -368,7 +369,7 @@ public class ContinuousOutputModel
   private int index;
 
   /** Steps table. */
-  private ArrayList steps;
+  private List steps;
 
   /** Serializable version identifier */
   private static final long serialVersionUID = 2259286184268533249L;

src/java/org/apache/commons/math/ode/SwitchingFunctionsHandler.java

@@ -22,6 +22,7 @@ import org.apache.commons.math.FunctionEvaluationException;
 
 import java.util.ArrayList;
 import java.util.Iterator;
+import java.util.List;
 
 /** This class handles several {@link SwitchingFunction switching
  * functions} during integration.
@@ -194,7 +195,7 @@ public class SwitchingFunctionsHandler {
   }
 
   /** Switching functions. */
-  private ArrayList functions;
+  private List functions;
 
   /** First active switching function. */
   private SwitchState first;

src/java/org/apache/commons/math/random/EmpiricalDistributionImpl.java

@@ -64,7 +64,7 @@ public class EmpiricalDistributionImpl implements Serializable, EmpiricalDistrib
     private static final long serialVersionUID = -6773236347582113490L;
 
     /** List of SummaryStatistics objects characterizing the bins */
-    private ArrayList binStats = null;
+    private List binStats = null;
 
     /** Sample statistics */
     private SummaryStatistics sampleStats = null;
@@ -447,8 +447,8 @@ public class EmpiricalDistributionImpl implements Serializable, EmpiricalDistrib
     }
 
     /**
-     * Returns an ArrayList of {@link SummaryStatistics} instances containing
-     * statistics describing the values in each of the bins.  The ArrayList is
+     * Returns a List of {@link SummaryStatistics} instances containing
+     * statistics describing the values in each of the bins.  The list is
      * indexed on the bin number.
      * 
      * @return List of bin statistics.

src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java

@@ -368,7 +368,7 @@ public class DescriptiveStatistics implements StatisticalSummary, Serializable {
      * <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
      * </p><p>
      * <strong>Preconditions</strong>:<ul>
-     * <li><code>0 &lt; p &lt; 100</code> (otherwise an 
+     * <li><code>0 &lt; p &le; 100</code> (otherwise an 
      * <code>IllegalArgumentException</code> is thrown)</li>
      * <li>at least one value must be stored (returns <code>Double.NaN
      *     </code> otherwise)</li>

src/site/xdoc/changes.xml

@@ -39,7 +39,13 @@ The <action> type attribute can be add,update,fix,remove.
 Commons Math Release Notes</title>
   </properties>
   <body>
-    <release version="1.2-RC2" date="TBD"
+    <release version="1.3-SNAPSHOT" date="TBD"
+    description="TBD">
+      <action dev="brentworden" type="fix" issue="MATH-193" due-to="Michael Heuer and Sebb">
+        Javadoc and style fixes.
+      </action>
+    </release>
+    <release version="1.2" date="2008-02-24"
     description="This release combines bug fixes and new features. Most notable
     among the new features are the estimation, optimization, geometry and ode
     packages added from the Mantissa library. Implementations of fast Fourier

src/test/org/apache/commons/math/random/EmpiricalDistributionTest.java

@@ -185,7 +185,40 @@ public final class EmpiricalDistributionTest extends RetryTestCase {
         dist2 = (EmpiricalDistribution) TestUtils.serializeAndRecover(empiricalDistribution2);
         verifySame(empiricalDistribution2, dist2);
     }
-    
+
+    public void testLoadNullDoubleArray() {
+        EmpiricalDistribution dist = new EmpiricalDistributionImpl();
+        try {
+            dist.load((double[]) null);
+            fail("load((double[]) null) expected RuntimeException");
+        }
+        catch (RuntimeException e) {
+            // expected
+        }
+    }
+
+    public void testLoadNullURL() throws Exception {
+        EmpiricalDistribution dist = new EmpiricalDistributionImpl();
+        try {
+            dist.load((URL) null);
+            fail("load((URL) null) expected NullPointerException");
+        }
+        catch (NullPointerException e) {
+            // expected
+        }
+    }
+
+    public void testLoadNullFile() throws Exception {
+        EmpiricalDistribution dist = new EmpiricalDistributionImpl();
+        try {
+            dist.load((File) null);
+            fail("load((File) null) expected NullPointerException");
+        }
+        catch (NullPointerException e) {
+            // expected
+        }
+    }
+
     private void verifySame(EmpiricalDistribution d1, EmpiricalDistribution d2) {
         assertEquals(d1.isLoaded(), d2.isLoaded());
         assertEquals(d1.getBinCount(), d2.getBinCount());