blob: 3c6478e455fee457625afb5301d666f32764d8a6 (
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
60
|
/*
* 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.optim;
import org.apache.commons.math3.exception.NotStrictlyPositiveException;
/**
* Maximum number of evaluations of the function to be optimized.
*
* @since 3.1
*/
public class MaxEval implements OptimizationData {
/** Allowed number of evalutations. */
private final int maxEval;
/**
* @param max Allowed number of evalutations.
* @throws NotStrictlyPositiveException if {@code max <= 0}.
*/
public MaxEval(int max) {
if (max <= 0) {
throw new NotStrictlyPositiveException(max);
}
maxEval = max;
}
/**
* Gets the maximum number of evaluations.
*
* @return the allowed number of evaluations.
*/
public int getMaxEval() {
return maxEval;
}
/**
* Factory method that creates instance of this class that represents a virtually unlimited
* number of evaluations.
*
* @return a new instance suitable for allowing {@link Integer#MAX_VALUE} evaluations.
*/
public static MaxEval unlimited() {
return new MaxEval(Integer.MAX_VALUE);
}
}
|
