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.exception.NotStrictlyPositiveException;
20
21 /**
22 * Maximum number of evaluations of the function to be optimized.
23 *
24 * @since 3.1
25 */
26 public class MaxEval implements OptimizationData {
27 /** Allowed number of evaluations. */
28 private final int maxEval;
29
30 /**
31 * @param max Allowed number of evaluations.
32 * @throws NotStrictlyPositiveException if {@code max <= 0}.
33 */
34 public MaxEval(int max) {
35 if (max <= 0) {
36 throw new NotStrictlyPositiveException(max);
37 }
38
39 maxEval = max;
40 }
41
42 /**
43 * Gets the maximum number of evaluations.
44 *
45 * @return the allowed number of evaluations.
46 */
47 public int getMaxEval() {
48 return maxEval;
49 }
50
51 /**
52 * Factory method that creates instance of this class that represents
53 * a virtually unlimited number of evaluations.
54 *
55 * @return a new instance suitable for allowing {@link Integer#MAX_VALUE}
56 * evaluations.
57 */
58 public static MaxEval unlimited() {
59 return new MaxEval(Integer.MAX_VALUE);
60 }
61 }