diff --git a/src/java/org/apache/commons/math/ContractableDoubleArray.java b/src/java/org/apache/commons/math/ContractableDoubleArray.java index 4f1c0e24a..190c6c5a4 100644 --- a/src/java/org/apache/commons/math/ContractableDoubleArray.java +++ b/src/java/org/apache/commons/math/ContractableDoubleArray.java @@ -170,7 +170,7 @@ public class ContractableDoubleArray /** * Adds an element to the end of this expandable array * - * @return value to be added to end of array + * @param value to be added to end of array */ public synchronized void addElement(double value) { super.addElement(value); @@ -266,7 +266,7 @@ public class ContractableDoubleArray /** * Sets the contraction criteria for this ExpandContractDoubleArray. * - * @param new contraction criteria + * @param contractionCriteria contraction criteria */ public void setContractionCriteria(float contractionCriteria) { checkContractExpand(contractionCriteria, getExpansionFactor()); @@ -280,7 +280,7 @@ public class ContractableDoubleArray * expansionCriteria * * @param expansionFactor - * @param contractionCriteria + * @param contractionCritera */ protected void checkContractExpand(float contractionCritera, float expansionFactor) { diff --git a/src/java/org/apache/commons/math/EmpiricalDistribution.java b/src/java/org/apache/commons/math/EmpiricalDistribution.java index 201995c5a..e4668ed6b 100644 --- a/src/java/org/apache/commons/math/EmpiricalDistribution.java +++ b/src/java/org/apache/commons/math/EmpiricalDistribution.java @@ -81,7 +81,7 @@ import org.apache.commons.math.stat.Univariate; * generate random values "like" those in the input file -- i.e., the values * generated will follow the distribution of the values in the file. * @author Phil Steitz - * @version $Revision: 1.3 $ + * @version $Revision: 1.4 $ */ public interface EmpiricalDistribution { @@ -94,7 +94,7 @@ public interface EmpiricalDistribution { /** * Computes the empirical distribution from the input file - * @param URL url of the input file + * @param file url of the input file * @throws IOException if an IO error occurs */ void load(File file) throws IOException; @@ -135,7 +135,7 @@ public interface EmpiricalDistribution { * Saves distribution to a file. Overwrites the file if it exists. * Preconditions: - * @param fully qualified file path for the file to be written + * @param filePath fully qualified file path for the file to be written * @throws IOException if an error occurs reading the file * @throws IllegalStateException if the distribution has not been loaded */ diff --git a/src/java/org/apache/commons/math/ExpandableDoubleArray.java b/src/java/org/apache/commons/math/ExpandableDoubleArray.java index 9db06dcf1..55058f25b 100644 --- a/src/java/org/apache/commons/math/ExpandableDoubleArray.java +++ b/src/java/org/apache/commons/math/ExpandableDoubleArray.java @@ -223,7 +223,7 @@ public class ExpandableDoubleArray implements Serializable, DoubleArray { * array class. Note that this function will also expand the internal * array as needed. * - * @param a new number of elements + * @param i a new number of elements */ public synchronized void setNumElements(int i) { @@ -321,7 +321,7 @@ public class ExpandableDoubleArray implements Serializable, DoubleArray { /** * Adds an element to the end of this expandable array * - * @return value to be added to end of array + * @param value value to be added to end of array */ public synchronized void addElement(double value) { numElements++; diff --git a/src/java/org/apache/commons/math/FixedDoubleArray.java b/src/java/org/apache/commons/math/FixedDoubleArray.java index 0c53b636a..4973803be 100644 --- a/src/java/org/apache/commons/math/FixedDoubleArray.java +++ b/src/java/org/apache/commons/math/FixedDoubleArray.java @@ -312,7 +312,7 @@ public class FixedDoubleArray implements DoubleArray { * make little sense to allow people to "drop" objects from the * "front". * - * @param number of elements to discard. + * @param i number of elements to discard. * * @see org.apache.commons.math.DoubleArray#discardFrontElements(int) */ diff --git a/src/java/org/apache/commons/math/RandomDataImpl.java b/src/java/org/apache/commons/math/RandomDataImpl.java index 34be3524e..a254e5d26 100644 --- a/src/java/org/apache/commons/math/RandomDataImpl.java +++ b/src/java/org/apache/commons/math/RandomDataImpl.java @@ -105,7 +105,7 @@ import java.util.Collection; * identical). * * @author Phil Steitz - * @version $Revision: 1.4 $ $Date: 2003/06/05 18:35:24 $ + * @version $Revision: 1.5 $ $Date: 2003/06/11 14:50:29 $ */ public class RandomDataImpl implements RandomData { @@ -501,7 +501,7 @@ public class RandomDataImpl implements RandomData { * shuffle to randomly re-order the last end elements of list. * * @param list list to be shuffled - * @end element past which shuffling begins + * @param end element past which shuffling begins */ private void shuffle(int[] list, int end) { int target = 0; diff --git a/src/java/org/apache/commons/math/RealMatrix.java b/src/java/org/apache/commons/math/RealMatrix.java index f8c50f52d..6a84ea5ea 100644 --- a/src/java/org/apache/commons/math/RealMatrix.java +++ b/src/java/org/apache/commons/math/RealMatrix.java @@ -57,7 +57,7 @@ package org.apache.commons.math; /** * Interface defining a real-valued matrix with basic algebraic operations * @author Phil Steitz - * @version $Revision: 1.2 $ $Date: 2003/05/13 19:08:14 $ + * @version $Revision: 1.3 $ $Date: 2003/06/11 14:50:29 $ */ public interface RealMatrix { @@ -116,7 +116,7 @@ public interface RealMatrix { /** * Sets/overwrites the underlying data for the matrix - * @param 2-dimensional array of entries + * @param data 2-dimensional array of entries */ public void setData(double[][] data); @@ -145,7 +145,7 @@ public interface RealMatrix { /** * Returns the entry in the specified row and column * @param row row location of entry to be fetched - * @param col column location of entry to be fetched + * @param column column location of entry to be fetched * @return matrix entry in row,column * @throws IllegalArgumentException if entry does not exist */ @@ -154,7 +154,7 @@ public interface RealMatrix { /** * Sets the entry in the specified row and column to the specified value * @param row row location of entry to be set - * @param col column location of entry to be set + * @param column column location of entry to be set * @param value value to set * @throws IllegalArgumentException if entry does not exist */ @@ -175,7 +175,7 @@ public interface RealMatrix { /** * Returns the determinant of this matrix - * @returns determinant + * @return determinant */ public double getDeterminant(); diff --git a/src/java/org/apache/commons/math/RealMatrixImpl.java b/src/java/org/apache/commons/math/RealMatrixImpl.java index a441a7d92..62af788bc 100644 --- a/src/java/org/apache/commons/math/RealMatrixImpl.java +++ b/src/java/org/apache/commons/math/RealMatrixImpl.java @@ -58,7 +58,7 @@ import java.io.Serializable; /** * Implementation for RealMatrix using double[][] array * @author Phil Stetiz - * @version $Revision: 1.2 $ $Date: 2003/05/13 19:08:14 $ + * @version $Revision: 1.3 $ $Date: 2003/06/11 14:50:29 $ */ public class RealMatrixImpl implements RealMatrix, Serializable { @@ -72,7 +72,6 @@ public class RealMatrixImpl implements RealMatrix, Serializable { * Create a new RealMatrix with the supplied row and column dimensions * @param rowDimension the number of rows in the new matrix * @param columnDimension the number of columns in the new matrix - * @return newly created matrix */ public RealMatrixImpl(int rowDimension, int columnDimension) { @@ -218,7 +217,7 @@ public class RealMatrixImpl implements RealMatrix, Serializable { /** * Sets/overwrites the underlying data for the matrix - * @param 2-dimensional array of entries + * @param data 2-dimensional array of entries */ public void setData(double[][] data) { this.data = data; @@ -263,7 +262,7 @@ public class RealMatrixImpl implements RealMatrix, Serializable { /** * Returns the entry in the specified row and column * @param row row location of entry to be fetched - * @param col column location of entry to be fetched + * @param column column location of entry to be fetched * @return matrix entry in row,column * @throws IllegalArgumentException if entry does not exist */ @@ -279,7 +278,7 @@ public class RealMatrixImpl implements RealMatrix, Serializable { /** * Sets the entry in the specified row and column to the specified value * @param row row location of entry to be set - * @param col column location of entry to be set + * @param column column location of entry to be set * @param value value to set * @throws IllegalArgumentException if entry does not exist */ diff --git a/src/java/org/apache/commons/math/distribution/FDistributionImpl.java b/src/java/org/apache/commons/math/distribution/FDistributionImpl.java index 76db34fc8..89665a637 100644 --- a/src/java/org/apache/commons/math/distribution/FDistributionImpl.java +++ b/src/java/org/apache/commons/math/distribution/FDistributionImpl.java @@ -73,7 +73,8 @@ public class FDistributionImpl /** * Create a F distribution using the given degrees of freedom. - * @param degreesOfFreedom the degrees of freedom. + * @param numeratorDegreesOfFreedom the degrees of freedom. + * @param denominatorDegreesOfFreedom */ public FDistributionImpl(double numeratorDegreesOfFreedom, double denominatorDegreesOfFreedom){ diff --git a/src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java b/src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java index 1732440aa..c5f7e8734 100644 --- a/src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java +++ b/src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java @@ -64,7 +64,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the most frequently occuring value - * @see org.apache.commons.math.StoreUnivariate#getMode() + * @see org.apache.commons.math.stat.StoreUnivariate#getMode() */ public double getMode() { // Mode depends on a refactor Freq class @@ -74,7 +74,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the skewness of this collection of values - * @see org.apache.commons.math.StoreUnivariate#getSkewness() + * @see org.apache.commons.math.stat.StoreUnivariate#getSkewness() */ public double getSkewness() { // Initialize the skewness @@ -102,7 +102,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the kurtosis for this collection of values - * @see org.apache.commons.math.StoreUnivariate#getKurtosis() + * @see org.apache.commons.math.stat.StoreUnivariate#getKurtosis() */ public double getKurtosis() { // Initialize the kurtosis @@ -134,7 +134,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the type or class of kurtosis that this collection of * values exhibits - * @see org.apache.commons.math.StoreUnivariate#getKurtosisClass() + * @see org.apache.commons.math.stat.StoreUnivariate#getKurtosisClass() */ public int getKurtosisClass() { @@ -153,7 +153,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the mean for this collection of values - * @see org.apache.commons.math.Univariate#getMean() + * @see org.apache.commons.math.stat.Univariate#getMean() */ public double getMean() { double arithMean = getSum() / getN(); @@ -162,7 +162,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the geometric mean for this collection of values - * @see org.apache.commons.math.Univariate#getGeometricMean() + * @see org.apache.commons.math.stat.Univariate#getGeometricMean() */ public double getGeometricMean() { double gMean = Math.pow(getProduct(),(1.0/getN())); @@ -171,7 +171,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the product for this collection of values - * @see org.apache.commons.math.Univariate#getProduct() + * @see org.apache.commons.math.stat.Univariate#getProduct() */ public double getProduct() { double product = Double.NaN; @@ -187,7 +187,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the variance for this collection of values - * @see org.apache.commons.math.Univariate#getVariance() + * @see org.apache.commons.math.stat.Univariate#getVariance() */ public double getVariance() { // Initialize variance @@ -216,7 +216,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the standard deviation for this collection of values - * @see org.apache.commons.math.Univariate#getStandardDeviation() + * @see org.apache.commons.math.stat.Univariate#getStandardDeviation() */ public double getStandardDeviation() { double stdDev = Double.NaN; @@ -228,7 +228,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the maximum value contained herein. - * @see org.apache.commons.math.Univariate#getMax() + * @see org.apache.commons.math.stat.Univariate#getMax() */ public double getMax() { @@ -250,7 +250,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the minimum value contained herein - * @see org.apache.commons.math.Univariate#getMin() + * @see org.apache.commons.math.stat.Univariate#getMin() */ public double getMin() { // Initialize minimum to NaN @@ -271,7 +271,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the sum of all values contained herein - * @see org.apache.commons.math.Univariate#getSum() + * @see org.apache.commons.math.stat.Univariate#getSum() */ public double getSum() { double accum = 0.0; @@ -283,7 +283,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns the sun of the squares of all values contained herein - * @see org.apache.commons.math.Univariate#getSumsq() + * @see org.apache.commons.math.stat.Univariate#getSumsq() */ public double getSumsq() { double accum = 0.0; @@ -296,7 +296,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Uses Shell sort * - * @see org.apache.commons.math.StoreUnivariate#getSortedValues() + * @see org.apache.commons.math.stat.StoreUnivariate#getSortedValues() * */ public double[] getSortedValues() { @@ -324,7 +324,7 @@ public abstract class AbstractStoreUnivariate implements StoreUnivariate { /** * Returns an estimate for the pth percentile of the stored values - * @see org.apache.commons.math.StoreUnivariate#getPercentile() + * @see org.apache.commons.math.stat.StoreUnivariate#getPercentile(double) */ public double getPercentile(double p) { if ((p > 100) || (p <= 0)) {