Merge pull request #1287 from tdrwenski/fix-nearlyEquals-docstring

Update nearlyEquals docstring
Unidata · Jan 17, 2024 · 23ecb6b · 23ecb6b
2 parents bb69bbd + f4e3864
commit 23ecb6b
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/cdm/core/src/main/java/ucar/nc2/util/Misc.java b/cdm/core/src/main/java/ucar/nc2/util/Misc.java
@@ -91,24 +91,24 @@ public static double relativeDifference(double a, double b) {
     }
   }
 
-  /** RelativeDifference is less than {@link #defaultMaxRelativeDiffFloat}. */
+  /** AbsoluteDifference is less than {@link #defaultMaxRelativeDiffFloat}. */
   public static boolean nearlyEquals(float a, float b) {
     return nearlyEquals(a, b, defaultMaxRelativeDiffFloat);
   }
 
-  /** RelativeDifference is less than maxRelDiff. */
-  public static boolean nearlyEquals(float a, float b, float maxRelDiff) {
-    return DoubleMath.fuzzyEquals(a, b, maxRelDiff);
+  /** AbsoluteDifference is less than maxAbsDiff. */
+  public static boolean nearlyEquals(float a, float b, float maxAbsDiff) {
+    return DoubleMath.fuzzyEquals(a, b, maxAbsDiff);
   }
 
-  /** RelativeDifference is less than {@link #defaultMaxRelativeDiffDouble}. */
+  /** AbsoluteDifference is less than {@link #defaultMaxRelativeDiffDouble}. */
   public static boolean nearlyEquals(double a, double b) {
     return nearlyEquals(a, b, defaultMaxRelativeDiffDouble);
   }
 
-  /** RelativeDifference is less than maxRelDiff. */
-  public static boolean nearlyEquals(double a, double b, double maxRelDiff) {
-    return DoubleMath.fuzzyEquals(a, b, maxRelDiff);
+  /** AbsoluteDifference is less than maxAbsDiff. */
+  public static boolean nearlyEquals(double a, double b, double maxAbsDiff) {
+    return DoubleMath.fuzzyEquals(a, b, maxAbsDiff);
   }
 
   /** AbsoluteDifference is less than maxAbsDiff. */