Removing @author tags, adding missing @version tags.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@140981 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mark R. Diggory 2003-07-09 20:04:13 +00:00
parent 31166f2bbb
commit d082672a80
65 changed files with 92 additions and 85 deletions

View File

@ -56,8 +56,7 @@ package org.apache.commons.math;
/**
* Signals a configuration problem with any of the factory methods.
*
* @author pietsch at apache.org
*
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:02:44 $
*/
public class MathConfigurationException extends MathException {

View File

@ -56,7 +56,7 @@ package org.apache.commons.math;
/**
* A generic exception indicating problems in the math package.
*
* @author pietsch at apache.org
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:02:44 $
*/
public class MathException extends Exception {

View File

@ -60,7 +60,7 @@ import org.apache.commons.math.MathException;
* functions. It will only search for one zero in the given interval. The
* function is supposed to be continuous but not necessarily smooth.
*
* @author Brent Worden
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public class BisectionSolver extends UnivariateRealSolverImpl {
/**

View File

@ -61,7 +61,7 @@ import org.apache.commons.math.MathException;
* It will only search for one zero in the given interval.
* The function is supposed to be continuous but not necessarily smooth.
*
* @author pietsch at apache.org
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:43 $
*/
public class BrentSolver extends UnivariateRealSolverImpl {
/**

View File

@ -57,7 +57,7 @@ package org.apache.commons.math.analysis;
* Error thrown when a numerical computation can not be performed because the
* numerical result failed to converge to a finite value.
*
* @author Brent Worden
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public class ConvergenceException extends RuntimeException {
/**

View File

@ -64,7 +64,7 @@ import org.apache.commons.math.MathException;
* polynominal coefficents are used.
* Arguments outside of the domain cause an IllegalArgumentException.
*
* @author pietsch at apache.org
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*
*/
public class CubicSplineFunction implements UnivariateRealFunction {

View File

@ -58,7 +58,7 @@ import org.apache.commons.math.MathException;
/**
* Utility class comprised of root finding techniques.
*
* @author Brent Worden
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:43 $
*/
public class RootFinding {
/** Maximum allowed numerical error. */

View File

@ -63,7 +63,7 @@ import org.apache.commons.math.MathException;
* It will only search for one zero in the given interval.
* The function is supposed to be continuous but not necessarily smooth.
*
* @author pietsch at apache.org
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:43 $
*/
public class SecantSolver extends UnivariateRealSolverImpl {
/**

View File

@ -56,7 +56,7 @@ package org.apache.commons.math.analysis;
/**
* Computes a natural spline interpolation for the data set.
*
* @author pietsch at apache.org
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*
*/
public class SplineInterpolator implements UnivariateRealInterpolator {

View File

@ -54,7 +54,7 @@
package org.apache.commons.math.analysis;
/**
* @author Brent Worden
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public interface UnivariateFunction {
// TODO: More documentation

View File

@ -62,7 +62,7 @@ import org.apache.commons.math.MathException;
* that derivatives are evaluated after the value, the evaluation algorithm
* should throw an InvalidStateException if it can't cope with this.
*
* @author pietsch at apache.org
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public interface UnivariateRealFunction {

View File

@ -58,8 +58,7 @@ import org.apache.commons.math.MathException;
/**
* Interface for interpolating a data set.
*
* * @author pietsch at apache.org
*
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public interface UnivariateRealInterpolator {

View File

@ -60,7 +60,7 @@ import org.apache.commons.math.MathException;
* functions.
* An implementation will only search for one zero in the given interval.
*
* @author pietsch at apache.org
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:43 $
*/
public interface UnivariateRealSolver {

View File

@ -59,16 +59,14 @@ import org.apache.commons.math.MathConfigurationException;
import org.apache.commons.math.MathException;
/**
* @author pietsch at apache.org
*
* A factory to easily get a default solver and some convenience
* functions.
* Because solvers are easily reusable, the factory does not
* store configuration data and creates preconfigured solvers
* (this may be controversial, because the configuration data
* may also be used for the default solver used by the static
* solve() method).
*
* solve() method).
* @version $Revision: 1.2 $ $Date: 2003/07/09 20:02:43 $
*/
public class UnivariateRealSolverFactory {
protected UnivariateRealSolverFactory() {

View File

@ -60,7 +60,7 @@ import org.apache.commons.math.MathException;
* Provide a default implementation for several functions useful to generic
* solvers.
*
* @author pietsch at apache.org
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:43 $
*/
public abstract class UnivariateRealSolverImpl
implements UnivariateRealSolver {

View File

@ -63,7 +63,7 @@ import org.apache.commons.math.analysis.UnivariateRealSolverFactory;
* implementations for some of the methods that do not vary from distribution
* to distribution.
*
* @author Brent Worden
* @version $Revision: 1.7 $ $Date: 2003/07/09 20:03:23 $
*/
public abstract class AbstractContinuousDistribution
implements ContinuousDistribution {

View File

@ -65,7 +65,7 @@ package org.apache.commons.math.stat.distribution;
* Chi-Squared Distribution</a></li>
* </ul>
*
* @author Brent Worden
* @version $Revision: 1.5 $ $Date: 2003/07/09 20:03:22 $
*/
public interface ChiSquaredDistribution extends ContinuousDistribution {
/**

View File

@ -56,7 +56,7 @@ package org.apache.commons.math.stat.distribution;
/**
* The default implementation of {@link ChiSquaredDistribution}
*
* @author Brent Worden
* @version $Revision: 1.5 $ $Date: 2003/07/09 20:03:23 $
*/
public class ChiSquaredDistributionImpl
extends AbstractContinuousDistribution

View File

@ -56,7 +56,7 @@ package org.apache.commons.math.stat.distribution;
/**
* Base interface for various continuous distributions.
*
* @author Brent Worden
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:03:23 $
*/
public interface ContinuousDistribution {
/**

View File

@ -70,7 +70,7 @@ package org.apache.commons.math.stat.distribution;
* ChiSquaredDistribution chi = factory.createChiSquareDistribution(5.0);
* </pre>
*
* @author Brent Worden
* @version $Revision: 1.8 $ $Date: 2003/07/09 20:03:22 $
*/
public abstract class DistributionFactory {
/**

View File

@ -58,7 +58,7 @@ package org.apache.commons.math.stat.distribution;
* A concrete distribution factory. This is the default factory used by
* Commons-Math.
*
* @author Brent Worden
* @version $Revision: 1.7 $ $Date: 2003/07/09 20:03:23 $
*/
public class DistributionFactoryImpl extends DistributionFactory {
/**

View File

@ -64,7 +64,7 @@ package org.apache.commons.math.stat.distribution;
* <li><a href="http://mathworld.wolfram.com/ExponentialDistribution.html">
* Exponential Distribution</a></li>
*
* @author Brent Worden
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:03:23 $
*/
public interface ExponentialDistribution extends ContinuousDistribution {
/**

View File

@ -56,7 +56,7 @@ package org.apache.commons.math.stat.distribution;
/**
* The default implementation of {@link ExponentialDistribution}
*
* @author Brent Worden
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:03:23 $
*/
public class ExponentialDistributionImpl
implements ExponentialDistribution {

View File

@ -65,7 +65,7 @@ package org.apache.commons.math.stat.distribution;
* F-Distribution</a></li>
* </ul>
*
* @author Brent Worden
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:03:23 $
*/
public interface FDistribution extends ContinuousDistribution {
/**

View File

@ -59,7 +59,7 @@ import org.apache.commons.math.special.Beta;
* Default implementation of
* {@link org.apache.commons.math.stat.distribution.FDistribution}.
*
* @author Brent Worden
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:03:23 $
*/
public class FDistributionImpl
extends AbstractContinuousDistribution

View File

@ -65,7 +65,7 @@ package org.apache.commons.math.stat.distribution;
* Gamma Distribution</a></li>
* </ul>
*
* @author Brent Worden
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:03:22 $
*/
public interface GammaDistribution extends ContinuousDistribution {
/**

View File

@ -58,7 +58,7 @@ import org.apache.commons.math.special.Gamma;
/**
* The default implementation of {@link GammaDistribution}
*
* @author Brent Worden
* @version $Revision: 1.5 $ $Date: 2003/07/09 20:03:23 $
*/
public class GammaDistributionImpl extends AbstractContinuousDistribution
implements GammaDistribution {

View File

@ -65,7 +65,7 @@ package org.apache.commons.math.stat.distribution;
* Student's t-Distribution</a></li>
* </ul>
*
* @author Brent Worden
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:03:23 $
*/
public interface TDistribution extends ContinuousDistribution {
/**

View File

@ -59,7 +59,7 @@ import org.apache.commons.math.special.Beta;
* Default implementation of
* {@link org.apache.commons.math.stat.distribution.TDistribution}.
*
* @author Brent Worden
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:03:23 $
*/
public class TDistributionImpl
extends AbstractContinuousDistribution

View File

@ -80,7 +80,7 @@ import org.apache.commons.math.stat.Univariate;
* build grouped frequnecy histograms representing the input data or to
* generate random values "like" those in the input file -- i.e., the values
* generated will follow the distribution of the values in the file.
* @version $Revision: 1.2 $
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:59 $
*/
public interface EmpiricalDistribution {

View File

@ -89,7 +89,7 @@ import org.apache.commons.math.stat.UnivariateImpl;
* entry per line.</li>
* </ol></p>
*
* @version $Revision: 1.2 $
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:59 $
*/
public class EmpiricalDistributionImpl implements Serializable,EmpiricalDistribution {

View File

@ -78,7 +78,7 @@ import java.net.MalformedURLException;
* standard deviation = <code>sigma</code></li>
* <li> CONSTANT_MODE -- returns <code>mu</code> every time.</li></ul>
*
* @version $Revision: 1.2 $
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:02:59 $
*
*/
public class ValueServer {

View File

@ -59,7 +59,7 @@ import org.apache.commons.math.util.ContinuedFraction;
* This is a utility class that provides computation methods related to the
* Beta family of functions.
*
* @author Brent Worden
* @version $Revision: 1.7 $ $Date: 2003/07/09 20:03:09 $
*/
public class Beta {
/** Maximum allowed numerical error. */

View File

@ -59,7 +59,7 @@ import org.apache.commons.math.analysis.ConvergenceException;
* This is a utility class that provides computation methods related to the
* Gamma family of functions.
*
* @author Brent Worden
* @version $Revision: 1.9 $ $Date: 2003/07/09 20:03:09 $
*/
public class Gamma {
/** Maximum allowed numerical error. */

View File

@ -59,6 +59,7 @@ package org.apache.commons.math.stat.univariate;
* Provides the ability to extend polymophically so that
* indiviual statistics do not need to implement these methods unless
* there are better algorithms for handling the calculation.
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:13 $
*/
public abstract class AbstractStorelessUnivariateStatistic
extends AbstractUnivariateStatistic

View File

@ -57,6 +57,7 @@ package org.apache.commons.math.stat.univariate;
* Abstract Implementation for UnivariateStatistics.
* Provides the ability to extend polymophically so that
* indiviual statistics do not need to implement these methods.
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:13 $
*/
public abstract class AbstractUnivariateStatistic
implements UnivariateStatistic {

View File

@ -60,6 +60,7 @@ package org.apache.commons.math.stat.univariate;
* in it. As such only a subset of known statistics can actually be implmented
* using it. If a Statistic cannot be implemented in a Storeless approach it
* should implement the UnivariateStatistic interface directly instead.
* @version $Revision: 1.5 $ $Date: 2003/07/09 20:04:13 $
*/
public interface StorelessUnivariateStatistic extends UnivariateStatistic {

View File

@ -56,7 +56,7 @@ package org.apache.commons.math.stat.univariate;
/**
* UnivariateStatistic interface provides methods to evaluate
* double[] based content using a particular algorithm.
*
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:13 $
*/
public interface UnivariateStatistic {

View File

@ -56,7 +56,13 @@ package org.apache.commons.math.stat.univariate.moment;
import org.apache.commons.math.stat.univariate.AbstractStorelessUnivariateStatistic;
/**
* FirstMoment.java
*
* The FirstMoment (arithmentic mean) is calculated using the following
* <a href="http://www.spss.com/tech/stat/Algorithms/11.5/descriptives.pdf">
* recursive strategy
* </a>. Both incremental and evaluation strategies currently use this approach.
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:10 $
*/
public class FirstMoment extends AbstractStorelessUnivariateStatistic {

View File

@ -54,8 +54,11 @@
package org.apache.commons.math.stat.univariate.moment;
/**
*
*
* The FourthMoment is calculated using the following
* <a href="http://www.spss.com/tech/stat/Algorithms/11.5/descriptives.pdf">
* recursive strategy
* </a>. Both incremental and evaluation strategies currently use this approach.
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class FourthMoment extends ThirdMoment {

View File

@ -55,9 +55,10 @@ package org.apache.commons.math.stat.univariate.moment;
import org.apache.commons.math.stat.univariate.summary.SumOfLogs;
/**
*
*
/**
* Returns the <a href="http://www.xycoon.com/geometric_mean.htm">
* geometric mean </a> of the available values
* @version $Revision: 1.8 $ $Date: 2003/07/09 20:04:10 $
*/
public class GeometricMean extends SumOfLogs {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class Kurtosis extends AbstractStorelessUnivariateStatistic {

View File

@ -53,19 +53,14 @@
*/
package org.apache.commons.math.stat.univariate.moment;
import org
.apache
.commons
.math
.stat
.univariate
.AbstractStorelessUnivariateStatistic;
import org.apache.commons.math.stat.univariate.summary.Sum;
/**
*
* Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm">
* arithmetic mean </a> of the available values.
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class Mean extends AbstractStorelessUnivariateStatistic {
public class Mean extends Sum {
/** first moment of values that have been added */
protected FirstMoment moment = null;
@ -106,12 +101,9 @@ public class Mean extends AbstractStorelessUnivariateStatistic {
return moment.m1;
}
/*UnvariateStatistic Approach */
Sum sum = new Sum();
/**
* Returns the <a href=http://www.xycoon.com/arithmetic_mean.htm>
* arithmetic mean </a> of the available values.
* Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm">
* arithmetic mean </a> of a double[] of the available values.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
* @param length processing at this point in the array
@ -120,7 +112,7 @@ public class Mean extends AbstractStorelessUnivariateStatistic {
*/
public double evaluate(double[] values, int begin, int length) {
if (test(values, begin, length)) {
return sum.evaluate(values, begin, length) / ((double) length);
return super.evaluate(values, begin, length) / ((double) length);
}
return Double.NaN;
}

View File

@ -54,8 +54,11 @@
package org.apache.commons.math.stat.univariate.moment;
/**
*
*
* The SecondMoment is calculated using the following
* <a href="http://www.spss.com/tech/stat/Algorithms/11.5/descriptives.pdf">
* recursive strategy
* </a>. Both incremental and evaluation strategies currently use this approach.
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class SecondMoment extends FirstMoment {

View File

@ -63,7 +63,7 @@ import org
/**
*
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class Skewness extends AbstractStorelessUnivariateStatistic {

View File

@ -55,7 +55,7 @@ package org.apache.commons.math.stat.univariate.moment;
/**
*
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class StandardDeviation extends Variance {

View File

@ -54,8 +54,11 @@
package org.apache.commons.math.stat.univariate.moment;
/**
*
*
* The ThirdMoment (arithmentic mean) is calculated using the following
* <a href="http://www.spss.com/tech/stat/Algorithms/11.5/descriptives.pdf">
* recursive strategy
* </a>. Both incremental and evaluation strategies currently use this approach.
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class ThirdMoment extends SecondMoment{

View File

@ -63,7 +63,7 @@ import org
/**
*
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:10 $
*/
public class Variance extends AbstractStorelessUnivariateStatistic {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:12 $
*/
public class Max extends AbstractStorelessUnivariateStatistic {

View File

@ -55,7 +55,7 @@ package org.apache.commons.math.stat.univariate.rank;
/**
*
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public class Median extends Percentile {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:12 $
*/
public class Min extends AbstractStorelessUnivariateStatistic {

View File

@ -57,7 +57,7 @@ import java.util.Arrays;
import org.apache.commons.math.stat.univariate.AbstractUnivariateStatistic;
/**
*
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:12 $
*/
public class Percentile extends AbstractUnivariateStatistic {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:13 $
*/
public class Product extends AbstractStorelessUnivariateStatistic {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:13 $
*/
public class Sum extends AbstractStorelessUnivariateStatistic {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:13 $
*/
public class SumOfLogs extends AbstractStorelessUnivariateStatistic {

View File

@ -62,7 +62,7 @@ import org
.AbstractStorelessUnivariateStatistic;
/**
*
* @version $Revision: 1.6 $ $Date: 2003/07/09 20:04:13 $
*/
public class SumOfSquares extends AbstractStorelessUnivariateStatistic {

View File

@ -58,6 +58,7 @@ import org.apache.commons.beanutils.PropertyUtils;
/**
* Uses PropertyUtils to map a Bean getter to a double value.
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public class BeanTransformer implements NumberTransformer {

View File

@ -64,8 +64,7 @@ import org.apache.commons.math.analysis.ConvergenceException;
* <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
* Continued Fraction</a></li>
* </ul>
*
* @author Brent Worden
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public abstract class ContinuedFraction {
/** Maximum allowed numerical error. */

View File

@ -88,7 +88,7 @@ import java.io.Serializable;
* internal storage array is swapped.
* </p>
*
* @author <a href="mailto:tobrien@apache.org">Tim O'Brien</a>
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public class ContractableDoubleArray
extends ExpandableDoubleArray

View File

@ -55,6 +55,7 @@ package org.apache.commons.math.util;
/**
* A Default NumberTransformer for java.lang.Numbers and Numeric Strings.
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public class DefaultTransformer implements NumberTransformer {

View File

@ -60,8 +60,7 @@ package org.apache.commons.math.util;
* Collections API by allowing a user to select from a number of
* array implementations with support for various storage mechanisms
* such as automatic expansion, contraction, and array "rolling".
*
* @author <a href="mailto:tobrien@apache.org">Tim O'Brien</a>
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public interface DoubleArray {

View File

@ -88,8 +88,7 @@ import java.io.Serializable;
* expand the array 10 times - first from 2 -> 4. then 4 -> 8, 8 -> 16,
* and so on until we reach 4096 which is sufficient to hold 3546 elements.
* </p>
*
* @author <a href="mailto:tobrien@apache.org">Tim O'Brien</a>
* @version $Revision: 1.4 $ $Date: 2003/07/09 20:04:12 $
*/
public class ExpandableDoubleArray implements Serializable, DoubleArray {

View File

@ -82,8 +82,7 @@ package org.apache.commons.math.util;
* "fixed" in memory, this implementation will never allocate, or copy
* the internal storage array to a new array instance.
* </p>
*
* @author <a href="mailto:tobrien@apache.org">Tim O'Brien</a>
* @version $Revision: 1.5 $ $Date: 2003/07/09 20:04:12 $
*/
public class FixedDoubleArray implements DoubleArray {

View File

@ -55,6 +55,7 @@ package org.apache.commons.math.util;
/**
* Subclasses implementing this interface can transform Objects to doubles.
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public interface NumberTransformer {

View File

@ -63,6 +63,7 @@ import java.util.Set;
* It provides a means to set NumberTransformers that will be selected
* based on the Class of the object handed to the Maps
* <code>double transform(Object o)</code> method.
* @version $Revision: 1.3 $ $Date: 2003/07/09 20:04:12 $
*/
public class TransformerMap implements NumberTransformer {