Changeset 2738 for trunk

Timestamp:

09/29/2008 09:12:43 AM (3 months ago)

Author:

guyer

Message:

Added an isclose function. Element-by-element version of allclose. Why
isn't this in NumPy already?

Files:

• trunk/fipy/tools/numerix.py (modified) (2 diffs)

trunk/fipy/tools/numerix.py

@@ -7 +7 @@
  #  FILE: "numerix.py"
  #                                    created: 1/10/04 {10:23:17 AM} 
- #                                last update: 6/13/08 {6:38:52 PM} 
+ #                                last update: 9/29/08 {9:52:36 AM} 
  #  Author: Jonathan Guyer <guyer@nist.gov>
  #  Author: Daniel Wheeler <daniel.wheeler@nist.gov>
@@ -1074 +1074 @@
         return MA.allclose(first, second, atol=atol, rtol=rtol)
 
+def isclose(first, second, rtol=1.e-5, atol=1.e-8):
+    r"""
+    Returns which elements of `first` and `second` are equal, subect to the given
+    relative and absolute tolerances, such that::
+        
+        | first - second | < atol + rtol * | second |
+        
+    This means essentially that both elements are small compared to `atol` or
+    their difference divided by `second`'s value is small compared to `rtol`.
+    """
+    return abs(first - second) < atol + rtol * abs(second)
 
 def take(a, indices, axis=0, fill_value=None):