    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     */
    017    package org.apache.commons.math3.optim;
    018
    019    import org.apache.commons.math3.exception.NotStrictlyPositiveException;
    020
    021    /**
    022     * Maximum number of evaluations of the function to be optimized.
    023     *
    024     * @version $Id$
    025     * @since 3.1
    026     */
    027    public class MaxEval implements OptimizationData {
    028        /** Allowed number of evalutations. */
    029        private final int maxEval;
    030
    031        /**
    032         * @param max Allowed number of evalutations.
    033         * @throws NotStrictlyPositiveException if {@code max <= 0}.
    034         */
    035        public MaxEval(int max) {
    036            if (max <= 0) {
    037                throw new NotStrictlyPositiveException(max);
    038            }
    039
    040            maxEval = max;
    041        }
    042
    043        /**
    044         * Gets the maximum number of evaluations.
    045         *
    046         * @return the allowed number of evaluations.
    047         */
    048        public int getMaxEval() {
    049            return maxEval;
    050        }
    051
    052        /**
    053         * Factory method that creates instance of this class that represents
    054         * a virtually unlimited number of evaluations.
    055         *
    056         * @return a new instance suitable for allowing {@link Integer#MAX_VALUE}
    057         * evaluations.
    058         */
    059        public static MaxEval unlimited() {
    060            return new MaxEval(Integer.MAX_VALUE);
    061        }
    062    }