Return-Path:
p
, used to
- * bracket a CDF root. This method is used by
- * {@link #inverseCumulativeProbability(double)} to find critical values.
- *
- * @param p the desired probability for the critical value
- * @return initial domain value
- */
+ /** {@inheritDoc} */
protected double getInitialDomain(double p) {
return p;
}
- /**
- * Access the domain value lower bound, based on p
, used to
- * bracket a CDF root. This method is used by
- * {@link #inverseCumulativeProbability(double)} to find critical values.
- *
- * @param p the desired probability for the critical value
- * @return domain value lower bound, i.e.
- * P(X < lower bound) < p
- */
+ /** {@inheritDoc} */
protected double getDomainLowerBound(double p) {
return 0;
}
- /**
- * Access the domain value upper bound, based on p
, used to
- * bracket a CDF root. This method is used by
- * {@link #inverseCumulativeProbability(double)} to find critical values.
- *
- * @param p the desired probability for the critical value
- * @return domain value upper bound, i.e.
- * P(X < upper bound) > p
- */
+ /** {@inheritDoc} */
protected double getDomainUpperBound(double p) {
return 1;
}
- /**
- * For a random variable X whose values are distributed according
- * to this distribution, this method returns P(X ≤ x). In other words,
- * this method represents the (cumulative) distribution function, or
- * CDF, for this distribution.
- *
- * @param x the value at which the distribution function is evaluated.
- * @return the probability that a random variable with this
- * distribution takes a value less than or equal to x
- * @throws org.apache.commons.math.MathException
- * if the cumulative probability can not be
- * computed due to convergence or other numerical errors.
- */
+ /** {@inheritDoc} */
public double cumulativeProbability(double x) throws MathException {
if (x <= 0) {
return 0;
@@ -212,20 +150,7 @@
}
}
- /**
- * For a random variable X whose values are distributed according
- * to this distribution, this method returns P(x0 ≤ X ≤ x1).
- *
- * @param x0 the (inclusive) lower bound
- * @param x1 the (inclusive) upper bound
- * @return the probability that a random variable with this distribution
- * will take a value between x0
and x1
,
- * including the endpoints
- * @throws org.apache.commons.math.MathException
- * if the cumulative probability can not be
- * computed due to convergence or other numerical errors.
- * @throws IllegalArgumentException if x0 > x1
- */
+ /** {@inheritDoc} */
public double cumulativeProbability(double x0, double x1) throws MathException {
return cumulativeProbability(x1) - cumulativeProbability(x0);
}
Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/HasDensity.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/HasDensity.java?rev=705239&r1=705238&r2=705239&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/HasDensity.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/HasDensity.java Thu Oct 16 06:32:32 2008
@@ -22,6 +22,8 @@
/**
* Interface that signals that a distribution can compute the probability density function
* for a particular point.
+ * @param the type of the point at which density is to be computed, this
+ * may be for example Double
* @version $Revision$ $Date$
*/
public interface HasDensity
{ Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java Thu Oct 16 06:32:32 2008 @@ -35,12 +35,14 @@ /** Serializable version identifier */ private static final long serialVersionUID = 8589540077390120676L; + /** &sqrt;(2 π) */ + private static final double SQRT2PI = Math.sqrt(2 * Math.PI); + /** The mean of this distribution. */ private double mean = 0; /** The standard deviation of this distribution. */ private double standardDeviation = 1; - private static final double SQRT2PI = Math.sqrt(2 * Math.PI); /** * Create a normal distribution using the given mean and standard deviation. Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/DecompositionSolver.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/DecompositionSolver.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/DecompositionSolver.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/DecompositionSolver.java Thu Oct 16 06:32:32 2008 @@ -40,7 +40,7 @@ /** * Decompose a matrix. - * @param matrix + * @param matrix matrix to decompose * @exception InvalidMatrixException if matrix does not fulfill * the decomposition requirements (for example non-square matrix * for {@link LUDecomposition}) Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/EigenDecomposition.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/EigenDecomposition.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/EigenDecomposition.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/EigenDecomposition.java Thu Oct 16 06:32:32 2008 @@ -93,6 +93,7 @@ /** * Returns the ith eigenvalue of the original matrix. + * @param i index of the eigenvalue (counting from 0) * @return ith eigenvalue of the original matrix * @exception IllegalStateException if {@link * DecompositionSolver#decompose(RealMatrix) decompose} has not been called @@ -103,6 +104,7 @@ /** * Returns a copy of the ith eigenvector of the original matrix. + * @param i index of the eigenvector (counting from 0) * @return copy of the ith eigenvector of the original matrix * @exception IllegalStateException if {@link * DecompositionSolver#decompose(RealMatrix) decompose} has not been called Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/GershgorinCirclesUnion.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/GershgorinCirclesUnion.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/GershgorinCirclesUnion.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/GershgorinCirclesUnion.java Thu Oct 16 06:32:32 2008 @@ -75,13 +75,18 @@ * either circles union. It is mainly intended for circles unions * that {@link #intersects(GershgorinCirclesUnion) intersect} * each other beforehand.
+ * @param other Gershgorin circles union to swallow */ public void swallow(final GershgorinCirclesUnion other) { low = Math.min(low, other.low); high = Math.max(high, other.high); } - /** Comparator class for sorting intervals. */ + /** Compare another Gershgorin circles union in interval start order. + * @param other Gershgorin circles union to compare to instance + * @return a negative, zero or positive value depending on the other + * union starting before, at same location or after instance + */ public int compareTo(GershgorinCirclesUnion other) { return Double.compare(low, other.low); } Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/LUDecompositionImpl.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/LUDecompositionImpl.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/LUDecompositionImpl.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/LUDecompositionImpl.java Thu Oct 16 06:32:32 2008 @@ -348,8 +348,10 @@ *The A matrix is implicit here. It is
* @param b right-hand side of the equation A × X = B * @return a vector X such that A × X = B - * @throws IllegalArgumentException if matrices dimensions don't match - * @throws InvalidMatrixException if decomposed matrix is singular + * @exception IllegalStateException if {@link #decompose(RealMatrix) decompose} + * has not been called + * @exception IllegalArgumentException if matrices dimensions don't match + * @exception InvalidMatrixException if decomposed matrix is singular */ public RealVectorImpl solve(RealVectorImpl b) throws IllegalStateException, IllegalArgumentException, InvalidMatrixException { Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java Thu Oct 16 06:32:32 2008 @@ -56,7 +56,7 @@ /** * Decompose a matrix to find its largest singular values. - * @param matrix + * @param matrix matrix to decompose * @param maxSingularValues maximal number of singular values to compute * @exception InvalidMatrixException (wrapping a {@link ConvergenceException} * if algorithm fails to converge Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java Thu Oct 16 06:32:32 2008 @@ -48,6 +48,11 @@ /** Inverse of covariance matrix. */ private RealMatrix OmegaInverse; + /** Replace sample data, overriding any previous sample. + * @param y y values of the sample + * @param x x values of the sample + * @param covariance array representing the covariance matrix + */ public void newSampleData(double[] y, double[][] x, double[][] covariance) { validateSampleData(x, y); newYSampleData(y); Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java?rev=705239&r1=705238&r2=705239&view=diff ============================================================================== --- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java (original) +++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java Thu Oct 16 06:32:32 2008 @@ -58,7 +58,7 @@ /** Cached QR decomposition of X matrix */ private QRDecomposition qr = null; - /* + /** * {@inheritDoc} * * Computes and caches QR decomposition of the X matrix.