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.math4.legacy.exception;
18
19 import org.apache.commons.math4.legacy.exception.util.Localizable;
20 import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
21
22 /**
23 * Error thrown when a numerical computation can not be performed because the
24 * numerical result failed to converge to a finite value.
25 *
26 * @since 2.2
27 */
28 public class ConvergenceException extends MathIllegalStateException {
29 /** Serializable version Id. */
30 private static final long serialVersionUID = 4330003017885151975L;
31
32 /**
33 * Construct the exception.
34 */
35 public ConvergenceException() {
36 this(LocalizedFormats.CONVERGENCE_FAILED);
37 }
38
39 /**
40 * Construct the exception with a specific context and arguments.
41 *
42 * @param pattern Message pattern providing the specific context of
43 * the error.
44 * @param args Arguments.
45 */
46 public ConvergenceException(Localizable pattern, Object... args) {
47 getContext().addMessage(pattern, args);
48 }
49 }