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 * http://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 package org.apache.commons.math4.legacy.optim;
18
19 import org.apache.commons.math4.legacy.core.IntegerSequence;
20
21 /**
22 * Common settings for all optimization problems. Includes divergence and convergence
23 * criteria.
24 *
25 * @param <PAIR> The type of value the {@link #getConvergenceChecker() convergence
26 * checker} will operate on. It should include the value of the model
27 * function and point where it was evaluated.
28 * @since 3.3
29 */
30 public interface OptimizationProblem<PAIR> {
31 /**
32 * Get a independent Incrementor that counts up to the maximum number of evaluations
33 * and then throws an exception.
34 *
35 * @return a counter for the evaluations.
36 */
37 IntegerSequence.Incrementor getEvaluationCounter();
38
39 /**
40 * Get a independent Incrementor that counts up to the maximum number of iterations
41 * and then throws an exception.
42 *
43 * @return a counter for the evaluations.
44 */
45 IntegerSequence.Incrementor getIterationCounter();
46
47 /**
48 * Gets the convergence checker.
49 *
50 * @return the object used to check for convergence.
51 */
52 ConvergenceChecker<PAIR> getConvergenceChecker();
53 }