summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java
diff options
context:
space:
mode:
authorKarl Shaffer <karlshaffer@google.com>2023-08-09 18:06:31 -0700
committerKarl Shaffer <karlshaffer@google.com>2023-08-09 18:08:02 -0700
commit1354beaf452fc42c23c82fc80d2f2e9ffcbf3688 (patch)
treeace24ba4307d4978ee3134f7da671a77ad172da0 /src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java
parent122880aa37838deafdd5a68fe19cdaa856ce243a (diff)
downloadapache-commons-math-1354beaf452fc42c23c82fc80d2f2e9ffcbf3688.tar.gz
Check-in commons-math 3.6.1
This includes many changes over the original version and is also incompatible, which is why the existing commons-math library is left untouched. Test: N/A Change-Id: Icd0f3069a3c62b2572f2263732d91e6c3b6e8cba
Diffstat (limited to 'src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java')
-rw-r--r--src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java
new file mode 100644
index 0000000..e883805
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/optimization/MultivariateDifferentiableMultiStartOptimizer.java
@@ -0,0 +1,51 @@
+/*
+ * 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;
+
+import org.apache.commons.math3.analysis.differentiation.MultivariateDifferentiableFunction;
+import org.apache.commons.math3.random.RandomVectorGenerator;
+
+/**
+ * Special implementation of the {@link MultivariateDifferentiableOptimizer} interface adding
+ * multi-start features to an existing optimizer.
+ *
+ * <p>This class wraps a classical optimizer to use it several times in turn with different starting
+ * points in order to avoid being trapped into a local extremum when looking for a global one.
+ *
+ * @deprecated As of 3.1 (to be removed in 4.0).
+ * @since 3.1
+ */
+@Deprecated
+public class MultivariateDifferentiableMultiStartOptimizer
+ extends BaseMultivariateMultiStartOptimizer<MultivariateDifferentiableFunction>
+ implements MultivariateDifferentiableOptimizer {
+ /**
+ * Create a multi-start optimizer from a single-start optimizer.
+ *
+ * @param optimizer Single-start optimizer to wrap.
+ * @param starts Number of starts to perform (including the first one), multi-start is disabled
+ * if value is less than or equal to 1.
+ * @param generator Random vector generator to use for restarts.
+ */
+ public MultivariateDifferentiableMultiStartOptimizer(
+ final MultivariateDifferentiableOptimizer optimizer,
+ final int starts,
+ final RandomVectorGenerator generator) {
+ super(optimizer, starts, generator);
+ }
+}