View Javadoc
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.exception.LocalizedCoreFormats;
25  import org.hipparchus.exception.MathIllegalArgumentException;
26  
27  /**
28   * Maximum number of iterations performed by an (iterative) algorithm.
29   *
30   */
31  public class MaxIter implements OptimizationData {
32      /** Allowed number of evalutations. */
33      private final int max;
34  
35      /** Simple constructor.
36       * @param max Allowed number of iterations.
37       * @throws MathIllegalArgumentException if {@code max <= 0}.
38       */
39      public MaxIter(int max) {
40          if (max <= 0) {
41              throw new MathIllegalArgumentException(LocalizedCoreFormats.NUMBER_TOO_SMALL_BOUND_EXCLUDED,
42                                                     max, 0);
43          }
44  
45          this.max = max;
46      }
47  
48      /**
49       * Gets the maximum number of evaluations.
50       *
51       * @return the allowed number of evaluations.
52       */
53      public int getMaxIter() {
54          return max;
55      }
56  
57      /**
58       * Factory method that creates instance of this class that represents
59       * a virtually unlimited number of iterations.
60       *
61       * @return a new instance suitable for allowing {@link Integer#MAX_VALUE}
62       * evaluations.
63       */
64      public static MaxIter unlimited() {
65          return new MaxIter(Integer.MAX_VALUE);
66      }
67  }