blob: b9db4bdb749ce8e05ec7d93dea3eb95ee2bdad6b (
plain)
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
52
53
54
55
56
57
58
59
|
/*
* 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;
/**
* This interface is mainly intended to enforce the internal coherence of Commons-Math. Users of the
* API are advised to base their code on the following interfaces:
*
* <ul>
* <li>{@link org.apache.commons.math3.optimization.MultivariateOptimizer}
* <li>{@link org.apache.commons.math3.optimization.MultivariateDifferentiableOptimizer}
* <li>{@link org.apache.commons.math3.optimization.MultivariateDifferentiableVectorOptimizer}
* <li>{@link org.apache.commons.math3.optimization.univariate.UnivariateOptimizer}
* </ul>
*
* @param <PAIR> Type of the point/objective pair.
* @deprecated As of 3.1 (to be removed in 4.0).
* @since 3.0
*/
@Deprecated
public interface BaseOptimizer<PAIR> {
/**
* Get the maximal number of function evaluations.
*
* @return the maximal number of function evaluations.
*/
int getMaxEvaluations();
/**
* Get the number of evaluations of the objective function. The number of evaluations
* corresponds to the last call to the {@code optimize} method. It is 0 if the method has not
* been called yet.
*
* @return the number of evaluations of the objective function.
*/
int getEvaluations();
/**
* Get the convergence checker.
*
* @return the object used to check for convergence.
*/
ConvergenceChecker<PAIR> getConvergenceChecker();
}
|