1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.optim;
23
24 import org.hipparchus.util.Incrementor;
25
26 /**
27 * Common settings for all optimization problems. Includes divergence and convergence
28 * criteria.
29 *
30 * @param <P> The type of value the {@link #getConvergenceChecker() convergence
31 * checker} will operate on. It should include the value of the model
32 * function and point where it was evaluated.
33 */
34 public interface OptimizationProblem<P> {
35 /**
36 * Get a independent Incrementor that counts up to the maximum number of evaluations
37 * and then throws an exception.
38 *
39 * @return a counter for the evaluations.
40 */
41 Incrementor getEvaluationCounter();
42
43 /**
44 * Get a independent Incrementor that counts up to the maximum number of iterations
45 * and then throws an exception.
46 *
47 * @return a counter for the evaluations.
48 */
49 Incrementor getIterationCounter();
50
51 /**
52 * Gets the convergence checker.
53 *
54 * @return the object used to check for convergence.
55 */
56 ConvergenceChecker<P> getConvergenceChecker();
57 }