001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.commons.math3.optim; 018 019import org.apache.commons.math3.exception.NotStrictlyPositiveException; 020 021/** 022 * Maximum number of iterations performed by an (iterative) algorithm. 023 * 024 * @since 3.1 025 */ 026public class MaxIter implements OptimizationData { 027 /** Allowed number of evalutations. */ 028 private final int maxIter; 029 030 /** 031 * @param max Allowed number of iterations. 032 * @throws NotStrictlyPositiveException if {@code max <= 0}. 033 */ 034 public MaxIter(int max) { 035 if (max <= 0) { 036 throw new NotStrictlyPositiveException(max); 037 } 038 039 maxIter = max; 040 } 041 042 /** 043 * Gets the maximum number of evaluations. 044 * 045 * @return the allowed number of evaluations. 046 */ 047 public int getMaxIter() { 048 return maxIter; 049 } 050 051 /** 052 * Factory method that creates instance of this class that represents 053 * a virtually unlimited number of iterations. 054 * 055 * @return a new instance suitable for allowing {@link Integer#MAX_VALUE} 056 * evaluations. 057 */ 058 public static MaxIter unlimited() { 059 return new MaxIter(Integer.MAX_VALUE); 060 } 061}