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 */
017package org.apache.commons.math4.legacy.exception;
018
019import org.apache.commons.math4.legacy.exception.util.Localizable;
020import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
021
022/**
023 * Exception to be thrown when a number is not finite.
024 *
025 * @since 3.0
026 */
027public class NotFiniteNumberException extends MathIllegalNumberException {
028    /** Serializable version Id. */
029    private static final long serialVersionUID = -6100997100383932834L;
030
031    /**
032     * Construct the exception.
033     *
034     * @param wrong Value that is infinite or NaN.
035     * @param args Optional arguments.
036     */
037    public NotFiniteNumberException(Number wrong,
038                                    Object... args) {
039        this(LocalizedFormats.NOT_FINITE_NUMBER, wrong, args);
040    }
041
042    /**
043     * Construct the exception with a specific context.
044     *
045     * @param specific Specific context pattern.
046     * @param wrong Value that is infinite or NaN.
047     * @param args Optional arguments.
048     */
049    public NotFiniteNumberException(Localizable specific,
050                                    Number wrong,
051                                    Object... args) {
052        super(specific, wrong, args);
053    }
054
055    /**
056     * Check that the argument is a real number.
057     *
058     * @param x Argument.
059     * @throws NotFiniteNumberException if {@code x} is not a
060     * finite real number.
061     */
062    public static void check(final double x) {
063        if (Double.isInfinite(x) ||
064            Double.isNaN(x)) {
065            throw new NotFiniteNumberException(x);
066        }
067    }
068
069    /**
070     * Check that all the elements are real numbers.
071     *
072     * @param val Arguments.
073     * @throws NotFiniteNumberException if any values of the array is not a
074     * finite real number.
075     */
076    public static void check(final double[] val) {
077        for (int i = 0; i < val.length; i++) {
078            final double x = val[i];
079            if (Double.isInfinite(x) ||
080                Double.isNaN(x)) {
081                throw new NotFiniteNumberException(LocalizedFormats.ARRAY_ELEMENT, x, i);
082            }
083        }
084    }
085}