Determines whether two floating point values are close enough to be considered "equal" (i.e., the difference may be attributed to rounding errors). - Java java.lang

Java examples for java.lang:Math Value

Description

Determines whether two floating point values are close enough to be considered "equal" (i.e., the difference may be attributed to rounding errors).

Demo Code

/**//w w  w . j  ava 2 s  . c o m
 * Java Modular Image Synthesis Toolkit (JMIST)
 * Copyright (C) 2008-2013 Bradley W. Kimmel
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

public class Main{
    /**
     * A comparison threshold value to be used when a normal degree of
     * precision is expected.
     */
    public static final double EPSILON = 1e-6;
    /**
     * Determines whether two floating point values are close enough
     * to be considered "equal" (i.e., the difference may be attributed
     * to rounding errors).
     * @param x The first value to compare.
     * @param y The second value to compare.
     * @param epsilon The minimum difference required for the two values
     *     to be considered distinguishable.
     * @return A value indicating whether the difference between x and y
     *     is less than the given threshold.
     */
    public static boolean equal(double x, double y, double epsilon) {
        return Math.abs(x - y) < epsilon;
    }
    /**
     * Determines whether two floating point values are close enough
     * to be considered "equal" (i.e., the difference may be attributed
     * to rounding errors).
     * @param x The first value to compare.
     * @param y The second value to compare.
     * @return A value indicating whether the difference between x and y
     *     is less than MathUtil.EPSILON.
     * @see #EPSILON
     */
    public static boolean equal(double x, double y) {
        return Math.abs(x - y) < MathUtil.EPSILON;
    }
}

Related Tutorials