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 * Exception to be thrown when a number is not finite.
24 *
25 * @since 3.0
26 */
27 public class NotFiniteNumberException extends MathIllegalNumberException {
28 /** Serializable version Id. */
29 private static final long serialVersionUID = -6100997100383932834L;
30
31 /**
32 * Construct the exception.
33 *
34 * @param wrong Value that is infinite or NaN.
35 * @param args Optional arguments.
36 */
37 public NotFiniteNumberException(Number wrong,
38 Object... args) {
39 this(LocalizedFormats.NOT_FINITE_NUMBER, wrong, args);
40 }
41
42 /**
43 * Construct the exception with a specific context.
44 *
45 * @param specific Specific context pattern.
46 * @param wrong Value that is infinite or NaN.
47 * @param args Optional arguments.
48 */
49 public NotFiniteNumberException(Localizable specific,
50 Number wrong,
51 Object... args) {
52 super(specific, wrong, args);
53 }
54
55 /**
56 * Check that the argument is a real number.
57 *
58 * @param x Argument.
59 * @throws NotFiniteNumberException if {@code x} is not a
60 * finite real number.
61 */
62 public static void check(final double x) {
63 if (Double.isInfinite(x) ||
64 Double.isNaN(x)) {
65 throw new NotFiniteNumberException(x);
66 }
67 }
68
69 /**
70 * Check that all the elements are real numbers.
71 *
72 * @param val Arguments.
73 * @throws NotFiniteNumberException if any values of the array is not a
74 * finite real number.
75 */
76 public static void check(final double[] val) {
77 for (int i = 0; i < val.length; i++) {
78 final double x = val[i];
79 if (Double.isInfinite(x) ||
80 Double.isNaN(x)) {
81 throw new NotFiniteNumberException(LocalizedFormats.ARRAY_ELEMENT, x, i);
82 }
83 }
84 }
85 }