summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java
diff options
context:
space:
mode:
authorKarl Shaffer <karlshaffer@google.com>2023-08-10 23:18:51 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-08-10 23:18:51 +0000
commit029d049e490dcd5fa609bb7632b0262d95f1bcce (patch)
treeace24ba4307d4978ee3134f7da671a77ad172da0 /src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java
parent4367a1c12f893ea7fb55036619f46d0e7b0634f3 (diff)
parent5484895ffd3d0c8337d159667cafc127c459f677 (diff)
downloadapache-commons-math-029d049e490dcd5fa609bb7632b0262d95f1bcce.tar.gz
Check-in commons-math 3.6.1 am: 1354beaf45 am: 0018f64b87 am: b3715644fb am: 5484895ffd
Original change: https://android-review.googlesource.com/c/platform/external/apache-commons-math/+/2702413 Change-Id: Idb04c8014ec76e9930d6d0aa22dac3b0b54333c8 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java')
-rw-r--r--src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java82
1 files changed, 82 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java
new file mode 100644
index 0000000..67a4296
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/optimization/direct/BaseAbstractMultivariateSimpleBoundsOptimizer.java
@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.math3.optimization.direct;
+
+import org.apache.commons.math3.analysis.MultivariateFunction;
+import org.apache.commons.math3.optimization.BaseMultivariateOptimizer;
+import org.apache.commons.math3.optimization.BaseMultivariateSimpleBoundsOptimizer;
+import org.apache.commons.math3.optimization.GoalType;
+import org.apache.commons.math3.optimization.InitialGuess;
+import org.apache.commons.math3.optimization.SimpleBounds;
+import org.apache.commons.math3.optimization.PointValuePair;
+import org.apache.commons.math3.optimization.ConvergenceChecker;
+
+/**
+ * Base class for implementing optimizers for multivariate scalar functions,
+ * subject to simple bounds: The valid range of the parameters is an interval.
+ * The interval can possibly be infinite (in one or both directions).
+ * This base class handles the boiler-plate methods associated to thresholds
+ * settings, iterations and evaluations counting.
+ *
+ * @param <FUNC> Type of the objective function to be optimized.
+ *
+ * @deprecated As of 3.1 (to be removed in 4.0).
+ * @since 3.0
+ * @deprecated As of 3.1 since the {@link BaseAbstractMultivariateOptimizer
+ * base class} contains similar functionality.
+ */
+@Deprecated
+public abstract class BaseAbstractMultivariateSimpleBoundsOptimizer<FUNC extends MultivariateFunction>
+ extends BaseAbstractMultivariateOptimizer<FUNC>
+ implements BaseMultivariateOptimizer<FUNC>,
+ BaseMultivariateSimpleBoundsOptimizer<FUNC> {
+ /**
+ * Simple constructor with default settings.
+ * The convergence checker is set to a
+ * {@link org.apache.commons.math3.optimization.SimpleValueChecker}.
+ *
+ * @see BaseAbstractMultivariateOptimizer#BaseAbstractMultivariateOptimizer()
+ * @deprecated See {@link org.apache.commons.math3.optimization.SimpleValueChecker#SimpleValueChecker()}
+ */
+ @Deprecated
+ protected BaseAbstractMultivariateSimpleBoundsOptimizer() {}
+
+ /**
+ * @param checker Convergence checker.
+ */
+ protected BaseAbstractMultivariateSimpleBoundsOptimizer(ConvergenceChecker<PointValuePair> checker) {
+ super(checker);
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public PointValuePair optimize(int maxEval, FUNC f, GoalType goalType,
+ double[] startPoint) {
+ return super.optimizeInternal(maxEval, f, goalType,
+ new InitialGuess(startPoint));
+ }
+
+ /** {@inheritDoc} */
+ public PointValuePair optimize(int maxEval, FUNC f, GoalType goalType,
+ double[] startPoint,
+ double[] lower, double[] upper) {
+ return super.optimizeInternal(maxEval, f, goalType,
+ new InitialGuess(startPoint),
+ new SimpleBounds(lower, upper));
+ }
+}