MaxIter.java

  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. import org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException;

  19. /**
  20.  * Maximum number of iterations performed by an (iterative) algorithm.
  21.  *
  22.  * @since 3.1
  23.  */
  24. public class MaxIter implements OptimizationData {
  25.     /** Allowed number of evaluations. */
  26.     private final int maxIter;

  27.     /**
  28.      * @param max Allowed number of iterations.
  29.      * @throws NotStrictlyPositiveException if {@code max <= 0}.
  30.      */
  31.     public MaxIter(int max) {
  32.         if (max <= 0) {
  33.             throw new NotStrictlyPositiveException(max);
  34.         }

  35.         maxIter = max;
  36.     }

  37.     /**
  38.      * Gets the maximum number of evaluations.
  39.      *
  40.      * @return the allowed number of evaluations.
  41.      */
  42.     public int getMaxIter() {
  43.         return maxIter;
  44.     }

  45.     /**
  46.      * Factory method that creates instance of this class that represents
  47.      * a virtually unlimited number of iterations.
  48.      *
  49.      * @return a new instance suitable for allowing {@link Integer#MAX_VALUE}
  50.      * evaluations.
  51.      */
  52.     public static MaxIter unlimited() {
  53.         return new MaxIter(Integer.MAX_VALUE);
  54.     }
  55. }