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.math;
018
019 /**
020 * Error thrown when a numerical computation can not be performed because the
021 * numerical result failed to converge to a finite value.
022 *
023 * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $
024 */
025 public class ConvergenceException extends MathException {
026
027 /** Serializable version identifier */
028 private static final long serialVersionUID = 4883703247677159141L;
029
030 /**
031 * Default constructor.
032 */
033 public ConvergenceException() {
034 super("Convergence failed");
035 }
036
037 /**
038 * Constructs an exception with specified formatted detail message.
039 * Message formatting is delegated to {@link java.text.MessageFormat}.
040 * @param pattern format specifier
041 * @param arguments format arguments
042 * @since 1.2
043 */
044 public ConvergenceException(String pattern, Object ... arguments) {
045 super(pattern, arguments);
046 }
047
048 /**
049 * Create an exception with a given root cause.
050 * @param cause the exception or error that caused this exception to be thrown
051 */
052 public ConvergenceException(Throwable cause) {
053 super(cause);
054 }
055
056 /**
057 * Constructs an exception with specified formatted detail message and root cause.
058 * Message formatting is delegated to {@link java.text.MessageFormat}.
059 * @param cause the exception or error that caused this exception to be thrown
060 * @param pattern format specifier
061 * @param arguments format arguments
062 * @since 1.2
063 */
064 public ConvergenceException(Throwable cause, String pattern, Object ... arguments) {
065 super(cause, pattern, arguments);
066 }
067
068 }