1dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond/* 2dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Licensed to the Apache Software Foundation (ASF) under one or more 3dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * contributor license agreements. See the NOTICE file distributed with 4dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * this work for additional information regarding copyright ownership. 5dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * The ASF licenses this file to You under the Apache License, Version 2.0 6dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * (the "License"); you may not use this file except in compliance with 7dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * the License. You may obtain a copy of the License at 8dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * 9dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * http://www.apache.org/licenses/LICENSE-2.0 10dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * 11dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Unless required by applicable law or agreed to in writing, software 12dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * distributed under the License is distributed on an "AS IS" BASIS, 13dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * See the License for the specific language governing permissions and 15dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * limitations under the License. 16dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 17dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 18dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondpackage org.apache.commons.math; 19dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 20dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondimport org.apache.commons.math.ConvergenceException; 21dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondimport org.apache.commons.math.exception.util.DummyLocalizable; 22dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondimport org.apache.commons.math.exception.util.Localizable; 23dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondimport org.apache.commons.math.exception.util.LocalizedFormats; 24dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 25dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond/** 26dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Error thrown when a numerical computation exceeds its allowed 27dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * number of functions evaluations. 28dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * 29dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @version $Revision: 983921 $ $Date: 2010-08-10 12:46:06 +0200 (mar. 10 août 2010) $ 30dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @since 2.0 31dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 32dee0849a9704d532af0b550146cbafbaa6ee1d19Raymondpublic class MaxEvaluationsExceededException extends ConvergenceException { 33dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 34dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** Serializable version identifier. */ 35dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond private static final long serialVersionUID = -5921271447220129118L; 36dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 37dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** Maximal number of evaluations allowed. */ 38dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond private final int maxEvaluations; 39dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 40dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** 41dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Constructs an exception with a default detail message. 42dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param maxEvaluations maximal number of evaluations allowed 43dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 44dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond public MaxEvaluationsExceededException(final int maxEvaluations) { 45dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond super(LocalizedFormats.MAX_EVALUATIONS_EXCEEDED, maxEvaluations); 46dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond this.maxEvaluations = maxEvaluations; 47dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond } 48dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 49dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** 50dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Constructs an exception with specified formatted detail message. 51dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Message formatting is delegated to {@link java.text.MessageFormat}. 52dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param maxEvaluations the exceeded maximal number of evaluations 53dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param pattern format specifier 54dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param arguments format arguments 55dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @deprecated as of 2.2 replaced by {@link #MaxEvaluationsExceededException(int, Localizable, Object...)} 56dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 57dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond @Deprecated 58dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond public MaxEvaluationsExceededException(final int maxEvaluations, 59dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond final String pattern, final Object ... arguments) { 60dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond this(maxEvaluations, new DummyLocalizable(pattern), arguments); 61dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond } 62dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 63dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** 64dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Constructs an exception with specified formatted detail message. 65dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * Message formatting is delegated to {@link java.text.MessageFormat}. 66dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param maxEvaluations the exceeded maximal number of evaluations 67dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param pattern format specifier 68dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @param arguments format arguments 69dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @since 2.2 70dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 71dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond public MaxEvaluationsExceededException(final int maxEvaluations, 72dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond final Localizable pattern, final Object ... arguments) { 73dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond super(pattern, arguments); 74dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond this.maxEvaluations = maxEvaluations; 75dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond } 76dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 77dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond /** Get the maximal number of evaluations allowed. 78dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond * @return maximal number of evaluations allowed 79dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond */ 80dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond public int getMaxEvaluations() { 81dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond return maxEvaluations; 82dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond } 83dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond 84dee0849a9704d532af0b550146cbafbaa6ee1d19Raymond} 85