src/main/java/org/apache/commons/math3/optimization/MultivariateMultiStartOptimizer.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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.MultivariateFunction;
import org.apache.commons.math3.random.RandomVectorGenerator;

/**
 * Special implementation of the {@link MultivariateOptimizer} 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 2.0
 */
@Deprecated
public class MultivariateMultiStartOptimizer
        extends BaseMultivariateMultiStartOptimizer<MultivariateFunction>
        implements MultivariateOptimizer {
    /**
     * 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 MultivariateMultiStartOptimizer(
            final MultivariateOptimizer optimizer,
            final int starts,
            final RandomVectorGenerator generator) {
        super(optimizer, starts, generator);
    }
}