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.exception;
018    
019    import org.apache.commons.math3.exception.util.Localizable;
020    import org.apache.commons.math3.exception.util.LocalizedFormats;
021    
022    /**
023     * Error thrown when a numerical computation can not be performed because the
024     * numerical result failed to converge to a finite value.
025     *
026     * @since 2.2
027     * @version $Id: ConvergenceException.java 1364378 2012-07-22 17:42:38Z tn $
028     */
029    public class ConvergenceException extends MathIllegalStateException {
030        /** Serializable version Id. */
031        private static final long serialVersionUID = 4330003017885151975L;
032    
033        /**
034         * Construct the exception.
035         */
036        public ConvergenceException() {
037            this(LocalizedFormats.CONVERGENCE_FAILED);
038        }
039    
040        /**
041         * Construct the exception with a specific context and arguments.
042         *
043         * @param pattern Message pattern providing the specific context of
044         * the error.
045         * @param args Arguments.
046         */
047        public ConvergenceException(Localizable pattern,
048                                    Object ... args) {
049            getContext().addMessage(pattern, args);
050        }
051    }