commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject svn commit: r1422195 - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math3: analysis/polynomials/ analysis/solvers/ distribution/ exception/ genetics/ geometry/euclidean/oned/ geometry/euclidean/twod/ linear/
Date Sat, 15 Dec 2012 06:45:21 GMT
Author: psteitz
Date: Sat Dec 15 06:45:18 2012
New Revision: 1422195

URL: http://svn.apache.org/viewvc?rev=1422195&view=rev
Log:
Added missing @since tags.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionNewtonForm.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/LaguerreSolver.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractIntegerDistribution.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/LogNormalDistribution.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/exception/NotANumberException.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/genetics/ListPopulation.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/Interval.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Segment.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/EigenDecomposition.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionNewtonForm.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionNewtonForm.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionNewtonForm.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionNewtonForm.java
Sat Dec 15 06:45:18 2012
@@ -95,7 +95,10 @@ public class PolynomialFunctionNewtonFor
        return evaluate(a, c, z);
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     * @since 3.1
+     */
     public DerivativeStructure value(final DerivativeStructure t) {
         verifyInputArray(a, c);
 

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/LaguerreSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/LaguerreSolver.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/LaguerreSolver.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/LaguerreSolver.java
Sat Dec 15 06:45:18 2012
@@ -188,6 +188,7 @@ public class LaguerreSolver extends Abst
      * @throws NullArgumentException if the {@code coefficients} is
      * {@code null}.
      * @throws NoDataException if the {@code coefficients} array is empty.
+     * @since 3.1
      */
     public Complex[] solveAllComplex(double[] coefficients,
                                      double initial)
@@ -217,6 +218,7 @@ public class LaguerreSolver extends Abst
      * @throws NullArgumentException if the {@code coefficients} is
      * {@code null}.
      * @throws NoDataException if the {@code coefficients} array is empty.
+     * @since 3.1
      */
     public Complex solveComplex(double[] coefficients,
                                 double initial)

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractIntegerDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractIntegerDistribution.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractIntegerDistribution.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractIntegerDistribution.java
Sat Dec 15 06:45:18 2012
@@ -38,6 +38,7 @@ public abstract class AbstractIntegerDis
 implements IntegerDistribution, Serializable {
     /** Serializable version identifier */
     private static final long serialVersionUID = -1146319659338487221L;
+
      /**
       * RandomData instance used to generate samples from the distribution.
       * @deprecated As of 3.1, to be removed in 4.0. Please use the
@@ -45,7 +46,11 @@ implements IntegerDistribution, Serializ
       */
     @Deprecated
     protected final RandomDataImpl randomData = new RandomDataImpl();
-    /** RNG instance used to generate samples from the distribution. */
+
+    /**
+     * RNG instance used to generate samples from the distribution.
+     * @since 3.1
+     */
     protected final RandomGenerator random;
 
     /**
@@ -60,6 +65,7 @@ implements IntegerDistribution, Serializ
     }
     /**
      * @param rng Random number generator.
+     * @since 3.1
      */
     protected AbstractIntegerDistribution(RandomGenerator rng) {
         random = rng;

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
Sat Dec 15 06:45:18 2012
@@ -49,8 +49,13 @@ implements RealDistribution, Serializabl
       */
     @Deprecated
     protected RandomDataImpl randomData = new RandomDataImpl();
-    /** RNG instance used to generate samples from the distribution. */
+
+    /**
+     * RNG instance used to generate samples from the distribution.
+     * @since 3.1
+     */
     protected final RandomGenerator random;
+
     /** Solver absolute accuracy for inverse cumulative computation */
     private double solverAbsoluteAccuracy = SOLVER_DEFAULT_ABSOLUTE_ACCURACY;
 
@@ -66,6 +71,7 @@ implements RealDistribution, Serializabl
     }
     /**
      * @param rng Random number generator.
+     * @since 3.1
      */
     protected AbstractRealDistribution(RandomGenerator rng) {
         random = rng;
@@ -275,6 +281,7 @@ implements RealDistribution, Serializabl
      * {@inheritDoc}
      *
      * @return zero.
+     * @since 3.1
      */
     public double probability(double x) {
         return 0d;

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java
Sat Dec 15 06:45:18 2012
@@ -167,6 +167,7 @@ public class GammaDistribution extends A
      * Returns the shape parameter of {@code this} distribution.
      *
      * @return the shape parameter
+     * @since 3.1
      */
     public double getShape() {
         return shape;
@@ -188,6 +189,7 @@ public class GammaDistribution extends A
      * Returns the scale parameter of {@code this} distribution.
      *
      * @return the scale parameter
+     * @since 3.1
      */
     public double getScale() {
         return scale;

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/LogNormalDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/LogNormalDistribution.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/LogNormalDistribution.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/LogNormalDistribution.java
Sat Dec 15 06:45:18 2012
@@ -120,6 +120,7 @@ public class LogNormalDistribution exten
      * @param shape Shape parameter of this distribution.
      * @param inverseCumAccuracy Inverse cumulative probability accuracy.
      * @throws NotStrictlyPositiveException if {@code shape <= 0}.
+     * @since 3.1
      */
     public LogNormalDistribution(RandomGenerator rng,
                                  double scale,

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/exception/NotANumberException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/exception/NotANumberException.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/exception/NotANumberException.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/exception/NotANumberException.java
Sat Dec 15 06:45:18 2012
@@ -21,7 +21,7 @@ import org.apache.commons.math3.exceptio
 /**
  * Exception to be thrown when a number is not a number.
  *
- * @since 3.0
+ * @since 3.1
  * @version $Id$
  */
 public class NotANumberException extends MathIllegalNumberException {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/genetics/ListPopulation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/genetics/ListPopulation.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/genetics/ListPopulation.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/genetics/ListPopulation.java
Sat Dec 15 06:45:18 2012
@@ -111,7 +111,8 @@ public abstract class ListPopulation imp
      * Add a {@link Collection} of chromosomes to this {@link Population}.
      * @param chromosomeColl a {@link Collection} of chromosomes
      * @throws NumberIsTooLargeException if the population would exceed the population limit
when
-     *   adding this chromosome
+     * adding this chromosome
+     * @since 3.1
      */
     public void addChromosomes(final Collection<Chromosome> chromosomeColl) throws
NumberIsTooLargeException {
         if (chromosomes.size() + chromosomeColl.size() > populationLimit) {
@@ -132,6 +133,7 @@ public abstract class ListPopulation imp
     /**
      * Access the list of chromosomes.
      * @return the list of chromosomes
+     * @since 3.1
      */
     protected List<Chromosome> getChromosomeList() {
         return chromosomes;

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/Interval.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/Interval.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/Interval.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/Interval.java
Sat Dec 15 06:45:18 2012
@@ -115,6 +115,7 @@ public class Interval {
      * belong to the boundary
      * @return a code representing the point status: either {@link
      * Location#INSIDE}, {@link Location#OUTSIDE} or {@link Location#BOUNDARY}
+     * @since 3.1
      */
     public Location checkPoint(final double point, final double tolerance) {
         if (point < lower - tolerance || point > upper + tolerance) {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
Sat Dec 15 06:45:18 2012
@@ -270,6 +270,7 @@ public class Line implements Hyperplane<
      *
      * @param p to check
      * @return distance between the instance and the point
+     * @since 3.1
      */
     public double distance(final Vector2D p) {
         return FastMath.abs(getOffset(p));

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/PolygonsSet.java
Sat Dec 15 06:45:18 2012
@@ -128,6 +128,7 @@ public class PolygonsSet extends Abstrac
      * @param hyperplaneThickness tolerance below which points are considered to
      * belong to the hyperplane (which is therefore more a slab)
      * @param vertices vertices of the simple loop boundary
+     * @since 3.1
      */
     public PolygonsSet(final double hyperplaneThickness, final Vector2D ... vertices) {
         super(verticesToTree(hyperplaneThickness, vertices));

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Segment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Segment.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Segment.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Segment.java
Sat Dec 15 06:45:18 2012
@@ -78,6 +78,7 @@ public class Segment {
      *
      * @param p to check
      * @return distance between the instance and the point
+     * @since 3.1
      */
     public double distance(final Vector2D p) {
         final double deltaX = end.getX() - start.getX();

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/EigenDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/EigenDecomposition.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/EigenDecomposition.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/EigenDecomposition.java
Sat Dec 15 06:45:18 2012
@@ -112,6 +112,7 @@ public class EigenDecomposition {
      * @throws MaxCountExceededException if the algorithm fails to converge.
      * @throws MathArithmeticException if the decomposition of a general matrix
      * results in a matrix with zero norm
+     * @since 3.1
      */
     public EigenDecomposition(final RealMatrix matrix)
         throws MathArithmeticException {
@@ -151,6 +152,7 @@ public class EigenDecomposition {
      * @param main Main diagonal of the symmetric tridiagonal form.
      * @param secondary Secondary of the tridiagonal form.
      * @throws MaxCountExceededException if the algorithm fails to converge.
+     * @since 3.1
      */
     public EigenDecomposition(final double[] main, final double[] secondary) {
         isSymmetric = true;
@@ -367,6 +369,7 @@ public class EigenDecomposition {
      * @return the square-root of the matrix.
      * @throws MathUnsupportedOperationException if the matrix is not
      * symmetric or not positive definite.
+     * @since 3.1
      */
     public RealMatrix getSquareRoot() {
         if (!isSymmetric) {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java?rev=1422195&r1=1422194&r2=1422195&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java
Sat Dec 15 06:45:18 2012
@@ -107,6 +107,7 @@ public class JacobiPreconditioner extend
      * P = diag(1 / &radic;A<sub>11</sub>, 1 / &radic;A<sub>22</sub>,
&hellip;).
      *
      * @return the square root of {@code this} preconditioner
+     * @since 3.1
      */
     public RealLinearOperator sqrt() {
         final RealVector sqrtDiag = diag.map(new Sqrt());



Mime
View raw message