commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l..@apache.org
Subject svn commit: r1571627 - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting: GaussianCurveFitter.java HarmonicCurveFitter.java PolynomialCurveFitter.java
Date Tue, 25 Feb 2014 09:21:32 GMT
Author: luc
Date: Tue Feb 25 09:21:32 2014
New Revision: 1571627

URL: http://svn.apache.org/r1571627
Log:
Javadoc.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/HarmonicCurveFitter.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/PolynomialCurveFitter.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java?rev=1571627&r1=1571626&r2=1571627&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
Tue Feb 25 09:21:32 2014
@@ -16,22 +16,22 @@
  */
 package org.apache.commons.math3.fitting;
 
-import java.util.List;
 import java.util.ArrayList;
-import java.util.Comparator;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
 
 import org.apache.commons.math3.analysis.function.Gaussian;
-import org.apache.commons.math3.linear.DiagonalMatrix;
+import org.apache.commons.math3.exception.NotStrictlyPositiveException;
 import org.apache.commons.math3.exception.NullArgumentException;
 import org.apache.commons.math3.exception.NumberIsTooSmallException;
 import org.apache.commons.math3.exception.OutOfRangeException;
 import org.apache.commons.math3.exception.ZeroException;
-import org.apache.commons.math3.exception.NotStrictlyPositiveException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
 import org.apache.commons.math3.fitting.leastsquares.LeastSquaresBuilder;
 import org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem;
+import org.apache.commons.math3.linear.DiagonalMatrix;
 import org.apache.commons.math3.util.FastMath;
 
 /**
@@ -130,16 +130,24 @@ public class GaussianCurveFitter extends
         return new GaussianCurveFitter(null, Integer.MAX_VALUE);
     }
 
-    /** {@inheritDoc} */
-    public GaussianCurveFitter withStartPoint(double[] start) {
-        return new GaussianCurveFitter(start.clone(),
+    /**
+     * Configure the sart point (initial guess).
+     * @param newStart new start point (initial guess)
+     * @return a new instance.
+     */
+    public GaussianCurveFitter withStartPoint(double[] newStart) {
+        return new GaussianCurveFitter(newStart.clone(),
                                        maxIter);
     }
 
-    /** {@inheritDoc} */
-    public GaussianCurveFitter withMaxIterations(int max) {
+    /**
+     * Configure the maximum number of iterations.
+     * @param newMaxIter maximum number of iterations
+     * @return a new instance.
+     */
+    public GaussianCurveFitter withMaxIterations(int newMaxIter) {
         return new GaussianCurveFitter(initialGuess,
-                                       max);
+                                       newMaxIter);
     }
 
     /** {@inheritDoc} */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/HarmonicCurveFitter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/HarmonicCurveFitter.java?rev=1571627&r1=1571626&r2=1571627&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/HarmonicCurveFitter.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/HarmonicCurveFitter.java
Tue Feb 25 09:21:32 2014
@@ -83,16 +83,24 @@ public class HarmonicCurveFitter extends
         return new HarmonicCurveFitter(null, Integer.MAX_VALUE);
     }
 
-    /** {@inheritDoc} */
-    public HarmonicCurveFitter withStartPoint(double[] start) {
-        return new HarmonicCurveFitter(start.clone(),
+    /**
+     * Configure the sart point (initial guess).
+     * @param newStart new start point (initial guess)
+     * @return a new instance.
+     */
+    public HarmonicCurveFitter withStartPoint(double[] newStart) {
+        return new HarmonicCurveFitter(newStart.clone(),
                                        maxIter);
     }
 
-    /** {@inheritDoc} */
-    public HarmonicCurveFitter withMaxIterations(int max) {
+    /**
+     * Configure the maximum number of iterations.
+     * @param newMaxIter maximum number of iterations
+     * @return a new instance.
+     */
+    public HarmonicCurveFitter withMaxIterations(int newMaxIter) {
         return new HarmonicCurveFitter(initialGuess,
-                                       max);
+                                       newMaxIter);
     }
 
     /** {@inheritDoc} */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/PolynomialCurveFitter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/PolynomialCurveFitter.java?rev=1571627&r1=1571626&r2=1571627&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/PolynomialCurveFitter.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fitting/PolynomialCurveFitter.java
Tue Feb 25 09:21:32 2014
@@ -74,16 +74,24 @@ public class PolynomialCurveFitter exten
         return new PolynomialCurveFitter(new double[degree + 1], Integer.MAX_VALUE);
     }
 
-    /** {@inheritDoc} */
-    public PolynomialCurveFitter withStartPoint(double[] start) {
-        return new PolynomialCurveFitter(start.clone(),
+    /**
+     * Configure the sart point (initial guess).
+     * @param newStart new start point (initial guess)
+     * @return a new instance.
+     */
+    public PolynomialCurveFitter withStartPoint(double[] newStart) {
+        return new PolynomialCurveFitter(newStart.clone(),
                                          maxIter);
     }
 
-    /** {@inheritDoc} */
-    public PolynomialCurveFitter withMaxIterations(int max) {
+    /**
+     * Configure the maximum number of iterations.
+     * @param newMaxIter maximum number of iterations
+     * @return a new instance.
+     */
+    public PolynomialCurveFitter withMaxIterations(int newMaxIter) {
         return new PolynomialCurveFitter(initialGuess,
-                                         max);
+                                         newMaxIter);
     }
 
     /** {@inheritDoc} */



Mime
View raw message