1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.math;
18
19 /**
20 * Error thrown when a numerical computation can not be performed because the
21 * numerical result failed to converge to a finite value.
22 *
23 * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
24 */
25 public class ConvergenceException extends MathException {
26
27 /** Serializable version identifier */
28 private static final long serialVersionUID = 4380655778005469702L;
29
30 /**
31 * Default constructor.
32 */
33 public ConvergenceException() {
34 super("Convergence failed", new Object[0]);
35 }
36
37 /**
38 * Constructs an exception with specified formatted detail message.
39 * Message formatting is delegated to {@link java.text.MessageFormat}.
40 * @param pattern format specifier
41 * @param arguments format arguments
42 * @since 1.2
43 */
44 public ConvergenceException(String pattern, Object[] arguments) {
45 super(pattern, arguments);
46 }
47
48 /**
49 * Create an exception with a given root cause.
50 * @param cause the exception or error that caused this exception to be thrown
51 */
52 public ConvergenceException(Throwable cause) {
53 super(cause);
54 }
55
56 /**
57 * Constructs an exception with specified formatted detail message and root cause.
58 * Message formatting is delegated to {@link java.text.MessageFormat}.
59 * @param pattern format specifier
60 * @param arguments format arguments
61 * @param cause the exception or error that caused this exception to be thrown
62 * @since 1.2
63 */
64 public ConvergenceException(String pattern, Object[] arguments, Throwable cause) {
65 super(pattern, arguments, cause);
66 }
67
68 /**
69 * Constructs a new <code>ConvergenceException</code> with specified
70 * detail message and nested <code>Throwable</code> root cause.
71 *
72 * @param msg the error message.
73 * @param rootCause the exception or error that caused this exception
74 * to be thrown.
75 * @deprecated as of 1.2, replaced by
76 * {@link #ConvergenceException(String, Object[], Throwable)}
77 */
78 public ConvergenceException(String msg, Throwable rootCause) {
79 super(msg, rootCause);
80 }
81
82 /**
83 * Constructs a new <code>ConvergenceException</code> with specified
84 * detail message.
85 *
86 * @param msg the error message.
87 * @deprecated as of 1.2, replaced by
88 * {@link #ConvergenceException(String, Object[])}
89 */
90 public ConvergenceException(String msg) {
91 super(msg);
92 }
93
94 }