ucar.nc2.util

Class Misc

java.lang.Object

ucar.nc2.util.Misc

public class Misc
extends Object

Miscellaneous static routines.

Field Summary

Fields

Modifier and Type	Field and Description
static double	defaultMaxRelativeDiffDouble The default maximum relative difference that two doubles can have in order to be deemed nearly equal.
static float	defaultMaxRelativeDiffFloat The default maximum relative difference that two floats can have in order to be deemed nearly equal.
static int	objectSize
static int	referenceSize

Constructor Summary

Constructors

Constructor and Description
Misc()

Method Summary

Modifier and Type	Method and Description
static double	absoluteDifference(double a, double b) Same as absoluteDifference(float, float), but for doubles.
static float	absoluteDifference(float a, float b) Returns the absolute difference between two numbers, i.e.
static boolean	compare(byte[] raw1, byte[] raw2, Formatter f)
static void	compare(float[] raw1, float[] raw2, Formatter f)
static int	compare(int x, int y)
static int	compare(long x, long y)
static List	getList(Iterable ii)
static int	getSize(Iterable ii)
static boolean	nearlyEquals(double a, double b) Returns the result of nearlyEquals(double, double, double), with defaultMaxRelativeDiffDouble.
static boolean	nearlyEquals(double a, double b, double maxRelDiff) Same as nearlyEquals(float, float, float), but for doubles.
static boolean	nearlyEquals(float a, float b) Returns the result of nearlyEquals(float, float, float), with defaultMaxRelativeDiffFloat.
static boolean	nearlyEquals(float a, float b, float maxRelDiff) Returns true if a and b are nearly equal.
static boolean	nearlyEqualsAbs(double a, double b, double maxAbsDiff) Same as nearlyEqualsAbs(float, float, float), but with doubles.
static boolean	nearlyEqualsAbs(float a, float b, float maxAbsDiff) Check if two numbers are nearly equal with given absolute tolerance.
static double	relativeDifference(double a, double b) Same as relativeDifference(float, float), but for doubles.
static float	relativeDifference(float a, float b) Returns the relative difference between two numbers, i.e.
static String	showBits(byte[] bytes)
static String	showBytes(byte[] buff)
static void	showBytes(byte[] buff, Formatter f)
static String	showInts(int[] inta)
static void	showInts(int[] inta, Formatter f)
static String	showInts(List<Integer> intList)
static String	stackTraceToString(StackTraceElement[] stackTrace)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

referenceSize

public static final int referenceSize

See Also:

Constant Field Values

objectSize

public static final int objectSize

See Also:

Constant Field Values

defaultMaxRelativeDiffFloat

public static final float defaultMaxRelativeDiffFloat

The default maximum relative difference that two floats can have in order to be deemed nearly equal.

See Also:

Constant Field Values

defaultMaxRelativeDiffDouble

public static final double defaultMaxRelativeDiffDouble

The default maximum relative difference that two doubles can have in order to be deemed nearly equal.

See Also:

Constant Field Values

Constructor Detail

Misc

public Misc()

Method Detail

absoluteDifference

public static float absoluteDifference(float a,
                                       float b)

Returns the absolute difference between two numbers, i.e. |a - b|.

Parameters:

a - first number.

b - second number.

Returns:

the absolute difference.

absoluteDifference

public static double absoluteDifference(double a,
                                        double b)

Same as absoluteDifference(float, float), but for doubles.

relativeDifference

public static float relativeDifference(float a,
                                       float b)

Returns the relative difference between two numbers, i.e. |a - b| / max(|a|, |b|).

For cases where a == 0, b == 0, or a and b are extremely close, traditional relative difference calculation breaks down. So, in those instances, we compute the difference relative to Float.MIN_NORMAL, i.e. |a - b| / Float.MIN_NORMAL.

Parameters:

a - first number.

b - second number.

Returns:

the relative difference.

See Also:

The Floating-Point Guide, Comparing Floating Point Numbers, 2012 Edition

relativeDifference

public static double relativeDifference(double a,
                                        double b)

Same as relativeDifference(float, float), but for doubles.

nearlyEquals

public static boolean nearlyEquals(float a,
                                   float b)

Returns the result of nearlyEquals(float, float, float), with defaultMaxRelativeDiffFloat.

nearlyEquals

public static boolean nearlyEquals(float a,
                                   float b,
                                   float maxRelDiff)

Returns true if a and b are nearly equal. Specifically, it checks whether the relative difference of the two numbers is less than maxRelDiff.

Parameters:

a - first number.

b - second number.

maxRelDiff - the maximum relative difference the two numbers may have.

Returns:

true if a and b are nearly equal.

nearlyEquals

public static boolean nearlyEquals(double a,
                                   double b)

Returns the result of nearlyEquals(double, double, double), with defaultMaxRelativeDiffDouble.

nearlyEquals

public static boolean nearlyEquals(double a,
                                   double b,
                                   double maxRelDiff)

Same as nearlyEquals(float, float, float), but for doubles.

nearlyEqualsAbs

public static boolean nearlyEqualsAbs(float a,
                                      float b,
                                      float maxAbsDiff)

Check if two numbers are nearly equal with given absolute tolerance.

Parameters:

a - first number.

b - second number.

maxAbsDiff - the maximum absolute difference the two numbers may have.

Returns:

true if within tolerance.

nearlyEqualsAbs

public static boolean nearlyEqualsAbs(double a,
                                      double b,
                                      double maxAbsDiff)

Same as nearlyEqualsAbs(float, float, float), but with doubles.

showInts

public static String showInts(int[] inta)

showInts

public static String showInts(List<Integer> intList)

showInts

public static void showInts(int[] inta,
                            Formatter f)

showBytes

public static String showBytes(byte[] buff)

showBytes

public static void showBytes(byte[] buff,
                             Formatter f)

getSize

public static int getSize(Iterable ii)

getList

public static List getList(Iterable ii)

showBits

public static String showBits(byte[] bytes)

compare

public static boolean compare(byte[] raw1,
                              byte[] raw2,
                              Formatter f)

compare

public static void compare(float[] raw1,
                           float[] raw2,
                           Formatter f)

compare

public static int compare(int x,
                          int y)

compare

public static int compare(long x,
                          long y)

stackTraceToString

public static String stackTraceToString(StackTraceElement[] stackTrace)