You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by lu...@apache.org on 2009/03/15 20:30:46 UTC
svn commit: r754732 - in /commons/proper/math/trunk/src:
java/org/apache/commons/math/estimation/
test/org/apache/commons/math/estimation/
Author: luc
Date: Sun Mar 15 19:30:44 2009
New Revision: 754732
URL: http://svn.apache.org/viewvc?rev=754732&view=rev
Log:
resurrected the estimation package but with all interfaces and classes deprecated
this will help users switch smoothly to the new optimization.general package
Added:
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/
- copied from r748273, commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/
- copied from r748273, commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/package.html
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/EstimatedParameterTest.java
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/GaussNewtonEstimatorTest.java
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/LevenbergMarquardtEstimatorTest.java
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/MinpackTest.java
commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/WeightedMeasurementTest.java
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java Sun Mar 15 19:30:44 2009
@@ -30,8 +30,11 @@
* settings, jacobian and error estimation.</p>
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
+@Deprecated
public abstract class AbstractEstimator implements Estimator {
/** Default maximal number of cost evaluations allowed. */
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java Sun Mar 15 19:30:44 2009
@@ -29,9 +29,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
-
+@Deprecated
public class EstimatedParameter
implements Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java Sun Mar 15 19:30:44 2009
@@ -24,9 +24,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
-
+@Deprecated
public class EstimationException
extends MathException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java Sun Mar 15 19:30:44 2009
@@ -40,9 +40,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
-
+@Deprecated
public interface EstimationProblem {
/**
* Get the measurements of an estimation problem.
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java Sun Mar 15 19:30:44 2009
@@ -32,9 +32,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
-
+@Deprecated
public interface Estimator {
/**
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java Sun Mar 15 19:30:44 2009
@@ -35,9 +35,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
-
+@Deprecated
public class GaussNewtonEstimator extends AbstractEstimator implements Serializable {
/** Serializable version identifier */
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java Sun Mar 15 19:30:44 2009
@@ -94,8 +94,11 @@
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*
*/
+@Deprecated
public class LevenbergMarquardtEstimator extends AbstractEstimator implements Serializable {
/**
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java Sun Mar 15 19:30:44 2009
@@ -37,8 +37,11 @@
* @version $Revision$ $Date$
* @since 1.2
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*/
+@Deprecated
public class SimpleEstimationProblem implements EstimationProblem {
/**
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java Sun Mar 15 19:30:44 2009
@@ -46,9 +46,11 @@
*
* @version $Revision$ $Date$
* @since 1.2
- *
+ * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
+ * been deprecated and replaced by package org.apache.commons.math.optimization.general
*/
+@Deprecated
public abstract class WeightedMeasurement implements Serializable {
/** Serializable version identifier. */
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/package.html
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/package.html?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/package.html (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/package.html Sun Mar 15 19:30:44 2009
@@ -17,39 +17,9 @@
-->
<!-- $Revision$ -->
<body>
-This package provides classes to solve estimation problems.
+This package provided classes to solve estimation problems, it is deprecated since 2.0.
-<p>The estimation problems considered here are parametric problems where a user model
-depends on initially unknown scalar parameters and several measurements made on
-values that depend on the model are available. As an example, one can consider the
-flow rate of a river given rain data on its vicinity, or the center and radius of a
-circle given points on a ring.</p>
-
-<p>One important class of estimation problems is weighted least squares problems.
-They basically consist in finding the values for some parameters p<sub>k</sub> such
-that a cost function J = sum(w<sub>i</sub> r<sub>i</sub><sup>2</sup>) is minimized.
-The various r<sub>i</sub> terms represent the deviation r<sub>i</sub> =
-mes<sub>i</sub> - mod<sub>i</sub> between the measurements and the parameterized
-models. The w<sub>i</sub> factors are the measurements weights, they are often chosen
-either all equal to 1.0 or proportional to the inverse of the variance of the
-measurement type. The solver adjusts the values of the estimated parameters
-p<sub>k</sub> which are not bound. It does not touch the parameters which have been
-put in a bound state by the user.</p>
-
-<p>This package provides the {@link
-org.apache.commons.math.estimation.EstimatedParameter EstimatedParameter} class to
-represent each estimated parameter, and the {@link
-org.apache.commons.math.estimation.WeightedMeasurement WeightedMeasurement} abstract
-class the user can extend to define its measurements. All parameters and measurements
-are then provided to some {@link org.apache.commons.math.estimation.Estimator
-Estimator} packed together in an {@link
-org.apache.commons.math.estimation.EstimationProblem EstimationProblem} instance
-which acts only as a container. The package provides two common estimators for
-weighted least squares problems, one based on the {@link
-org.apache.commons.math.estimation.GaussNewtonEstimator Gauss-Newton} method and the
-other one based on the {@link
-org.apache.commons.math.estimation.LevenbergMarquardtEstimator Levenberg-Marquardt}
-method.</p>
+<p>This package has been deprecated as of 2.0. It is replaced by the optimization.general package.</p>
</body>
</html>
Modified: commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/EstimatedParameterTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/EstimatedParameterTest.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/EstimatedParameterTest.java (original)
+++ commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/EstimatedParameterTest.java Sun Mar 15 19:30:44 2009
@@ -21,6 +21,7 @@
import junit.framework.*;
+@Deprecated
public class EstimatedParameterTest
extends TestCase {
Modified: commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/GaussNewtonEstimatorTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/GaussNewtonEstimatorTest.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/GaussNewtonEstimatorTest.java (original)
+++ commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/GaussNewtonEstimatorTest.java Sun Mar 15 19:30:44 2009
@@ -86,6 +86,7 @@
* @author Jorge J. More (original fortran minpack tests)
* @author Luc Maisonobe (non-minpack tests and minpack tests Java translation)
*/
+@Deprecated
public class GaussNewtonEstimatorTest
extends TestCase {
Modified: commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/LevenbergMarquardtEstimatorTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/LevenbergMarquardtEstimatorTest.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/LevenbergMarquardtEstimatorTest.java (original)
+++ commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/LevenbergMarquardtEstimatorTest.java Sun Mar 15 19:30:44 2009
@@ -86,6 +86,7 @@
* @author Jorge J. More (original fortran minpack tests)
* @author Luc Maisonobe (non-minpack tests and minpack tests Java translation)
*/
+@Deprecated
public class LevenbergMarquardtEstimatorTest
extends TestCase {
Modified: commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/MinpackTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/MinpackTest.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/MinpackTest.java (original)
+++ commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/MinpackTest.java Sun Mar 15 19:30:44 2009
@@ -89,6 +89,7 @@
* @author Jorge J. More (original fortran minpack tests)
* @author Luc Maisonobe (non-minpack tests and minpack tests Java translation)
*/
+@Deprecated
public class MinpackTest
extends TestCase {
Modified: commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/WeightedMeasurementTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/WeightedMeasurementTest.java?rev=754732&r1=748273&r2=754732&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/WeightedMeasurementTest.java (original)
+++ commons/proper/math/trunk/src/test/org/apache/commons/math/estimation/WeightedMeasurementTest.java Sun Mar 15 19:30:44 2009
@@ -22,6 +22,7 @@
import junit.framework.*;
+@Deprecated
public class WeightedMeasurementTest
extends TestCase {