From 529415fffe716a0920646dd24e4e9e13c6760388 Mon Sep 17 00:00:00 2001 From: Gilles Sadowski Date: Sun, 18 Aug 2013 23:27:29 +0000 Subject: [PATCH] MATH-1008 Deprecated least-squares optimizers in package "o.a.c.m.optim.nonlinear.vector". git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1515242 13f79535-47bb-0310-9956-ffa450edef68 --- .../vector/JacobianMultivariateVectorOptimizer.java | 5 +++++ .../commons/math3/optim/nonlinear/vector/ModelFunction.java | 5 +++++ .../math3/optim/nonlinear/vector/ModelFunctionJacobian.java | 5 +++++ .../apache/commons/math3/optim/nonlinear/vector/Target.java | 5 +++++ .../apache/commons/math3/optim/nonlinear/vector/Weight.java | 5 +++++ .../vector/jacobian/AbstractLeastSquaresOptimizer.java | 5 +++++ .../nonlinear/vector/jacobian/GaussNewtonOptimizer.java | 6 +++++- .../vector/jacobian/LevenbergMarquardtOptimizer.java | 5 +++++ .../math3/optim/nonlinear/vector/jacobian/package-info.java | 5 +++++ .../commons/math3/optim/nonlinear/vector/package-info.java | 5 +++++ 10 files changed, 50 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.java index f47ff583d..9392f8777 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.java @@ -35,7 +35,12 @@ import org.apache.commons.math3.exception.DimensionMismatchException; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public abstract class JacobianMultivariateVectorOptimizer extends MultivariateVectorOptimizer { /** diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunction.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunction.java index 586997ae0..68d1acd9b 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunction.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunction.java @@ -24,7 +24,12 @@ import org.apache.commons.math3.optim.OptimizationData; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class ModelFunction implements OptimizationData { /** Function to be optimized. */ private final MultivariateVectorFunction model; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunctionJacobian.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunctionJacobian.java index 774f06cd6..cad973eca 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunctionJacobian.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/ModelFunctionJacobian.java @@ -24,7 +24,12 @@ import org.apache.commons.math3.optim.OptimizationData; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class ModelFunctionJacobian implements OptimizationData { /** Function to be optimized. */ private final MultivariateMatrixFunction jacobian; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Target.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Target.java index acec402a7..3ea246539 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Target.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Target.java @@ -27,7 +27,12 @@ import org.apache.commons.math3.optim.OptimizationData; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class Target implements OptimizationData { /** Target values (of the objective vector function). */ private final double[] target; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Weight.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Weight.java index a9fbb15c6..f588c4f08 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Weight.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/Weight.java @@ -28,7 +28,12 @@ import org.apache.commons.math3.linear.NonSquareMatrixException; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class Weight implements OptimizationData { /** Weight matrix. */ private final RealMatrix weightMatrix; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.java index 980150318..b821107b4 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/AbstractLeastSquaresOptimizer.java @@ -38,7 +38,12 @@ import org.apache.commons.math3.util.FastMath; * * @version $Id$ * @since 3.1 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public abstract class AbstractLeastSquaresOptimizer extends JacobianMultivariateVectorOptimizer { /** Square-root of the weight matrix. */ diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.java index 3a5b8bd09..af7443d33 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/GaussNewtonOptimizer.java @@ -47,8 +47,12 @@ import org.apache.commons.math3.optim.PointVectorValuePair; * * @version $Id$ * @since 2.0 - * + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class GaussNewtonOptimizer extends AbstractLeastSquaresOptimizer { /** Indicator for using LU decomposition. */ private final boolean useLU; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.java index a1656cbfb..8d6a50b79 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/LevenbergMarquardtOptimizer.java @@ -109,7 +109,12 @@ import org.apache.commons.math3.util.FastMath; * * @version $Id$ * @since 2.0 + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ +@Deprecated public class LevenbergMarquardtOptimizer extends AbstractLeastSquaresOptimizer { /** Twice the "epsilon machine". */ diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/package-info.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/package-info.java index d68345254..4c844bae2 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/package-info.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/jacobian/package-info.java @@ -17,5 +17,10 @@ /** * This package provides optimization algorithms that require derivatives. + * + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ package org.apache.commons.math3.optim.nonlinear.vector.jacobian; diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/package-info.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/package-info.java index 7f894ca37..439fc3ce6 100644 --- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/package-info.java +++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/package-info.java @@ -17,5 +17,10 @@ /** * Algorithms for optimizing a vector function. + * + * @deprecated All classes and interfaces in this package are deprecated. + * The optimizers that were provided here were moved to the + * {@link org.apache.commons.math3.fitting.leastsquares} package + * (cf. MATH-1008). */ package org.apache.commons.math3.optim.nonlinear.vector;