fix #172 : added arguments rtol, atol and nans_equal to the compare() function

alixdamman · alixdamman · commit 48c0c3a32474 · 2019-09-04T09:47:57.000+02:00
diff --git a/doc/source/changes/version_0_32.rst.inc b/doc/source/changes/version_0_32.rst.inc
@@ -1,38 +1,12 @@
 ﻿.. py:currentmodule:: larray_editor
 
-Syntax changes
-^^^^^^^^^^^^^^
-
-* renamed ``MappingEditor.old_method_name()`` to :py:obj:`MappingEditor.new_method_name()` (closes :editor_issue:`1`).
-
-* renamed ``old_argument_name`` argument of :py:obj:`MappingEditor.method_name()` to ``new_argument_name``.
-
-
-Backward incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* other backward incompatible changes
-
-
-New features
-^^^^^^^^^^^^
-
-* added a feature (see the :ref:`miscellaneous section <misc_editor>` for details).
-
-* added another feature in the editor (closes :editor_issue:`1`).
-
-  .. note::
-
-     - It works for foo bar !
-     - It does not work for foo baz !
-
-
 .. _misc_editor:
 
 Miscellaneous improvements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* improved something.
+* added keyword arguments ``rtol``, ``atol`` and ``nans_equal`` to the :py:obj:`compare()` function
+  (closes :editor_issue:`172`).
 
 
 Fixes
diff --git a/larray_editor/api.py b/larray_editor/api.py
@@ -200,6 +200,22 @@ def compare(*args, **kwargs):
     display_caller_info: bool, optional
         Whether or not to display the filename and line number where the Editor has been called.
         Defaults to True.
+    rtol : float or int, optional
+        The relative tolerance parameter (see Notes). Defaults to 0.
+    atol : float or int, optional
+        The absolute tolerance parameter (see Notes). Defaults to 0.
+    nans_equal : boolean, optional
+        Whether or not to consider NaN values at the same positions in the two arrays as equal.
+        By default, an array containing NaN values is never equal to another array, even if that other array
+        also contains NaN values at the same positions. The reason is that a NaN value is different from
+        *anything*, including itself. Defaults to True.
+
+    Notes
+    -----
+    For finite values, the following equation is used to test whether two values are equal:
+
+        absolute(array1 - array2) <= (atol + rtol * absolute(array2))
+
 
     Examples
     --------
@@ -214,6 +230,7 @@ def compare(*args, **kwargs):
     names = kwargs.pop('names', None)
     depth = kwargs.pop('depth', 0)
     display_caller_info = kwargs.pop('display_caller_info', True)
+
     _app = QApplication.instance()
     if _app is None:
         _app = qapplication()
diff --git a/larray_editor/comparator.py b/larray_editor/comparator.py
@@ -13,7 +13,7 @@
 
 class ComparatorWidget(QWidget):
     """Comparator Widget"""
-    def __init__(self, parent=None, bg_gradient='red-white-blue'):
+    def __init__(self, parent=None, bg_gradient='red-white-blue', rtol=0, atol=0, nans_equal=True, **kwargs):
         QWidget.__init__(self, parent)
 
         layout = QVBoxLayout()
@@ -62,6 +62,17 @@ def __init__(self, parent=None, bg_gradient='red-white-blue'):
 
         self.arraywidget.btn_layout.addLayout(tolerance_layout)
 
+        if rtol > 0 and atol > 0:
+            raise ValueError("Arguments 'rtol' and 'atol' cannot be used together.")
+        if rtol > 0:
+            self.tolerance_combobox.setCurrentText("relative")
+            self.tolerance_line_edit.setText(str(rtol))
+        if atol > 0:
+            self.tolerance_combobox.setCurrentText("absolute")
+            self.tolerance_line_edit.setText(str(atol))
+
+        self.nans_equal = nans_equal
+
         # add local arraywidget to layout
         self.arraywidget.btn_layout.addStretch()
         layout.addWidget(self.arraywidget)
@@ -104,7 +115,7 @@ def update_isequal(self):
             tol_str = self.tolerance_line_edit.text()
             tol = ast.literal_eval(tol_str) if tol_str else 0
             atol, rtol = (tol, 0) if self.tolerance_combobox.currentText() == "absolute" else (0, tol)
-            self.isequal = self.array.eq(self.array0, rtol=rtol, atol=atol, nans_equal=True)
+            self.isequal = self.array.eq(self.array0, rtol=rtol, atol=atol, nans_equal=self.nans_equal)
         except TypeError:
             self.isequal = self.array == self.array0
 
@@ -171,16 +182,19 @@ def _setup_and_check(self, widget, data, title, readonly, **kwargs):
         readonly: bool
         kwargs:
 
+          * rtol: int or float
+          * atol: int or float
+          * nans_equal: bool
+          * bg_gradient: str
           * names: list of str
         """
         arrays = [aslarray(array) for array in data if isinstance(array, DISPLAY_IN_GRID)]
         names = kwargs.get('names', ["Array{}".format(i) for i in range(len(arrays))])
-        bg_gradient = kwargs.get('bg_gradient', 'red-white-blue')
 
         layout = QVBoxLayout()
         widget.setLayout(layout)
 
-        comparator_widget = ComparatorWidget(self, bg_gradient=bg_gradient)
+        comparator_widget = ComparatorWidget(self, **kwargs)
         comparator_widget.set_data(arrays, Axis(names, 'array'))
         layout.addWidget(comparator_widget)
 
@@ -213,12 +227,15 @@ def _setup_and_check(self, widget, data, title, readonly, **kwargs):
         readonly: bool
         kwargs:
 
+          * rtol: int or float
+          * atol: int or float
+          * nans_equal: bool
+          * bg_gradient: str
           * names: list of str
           * colors: str
         """
         sessions = data
         names = kwargs.get('names', ["Session{}".format(i) for i in range(len(sessions))])
-        bg_gradient = kwargs.get('bg_gradient', 'red-white-blue')
 
         assert all(isinstance(s, Session) for s in sessions)
         self.sessions = sessions
@@ -238,7 +255,7 @@ def _setup_and_check(self, widget, data, title, readonly, **kwargs):
                 listwidget.item(i).setForeground(Qt.red)
         self.listwidget = listwidget
 
-        comparatorwidget = ComparatorWidget(self, bg_gradient=bg_gradient)
+        comparatorwidget = ComparatorWidget(self, **kwargs)
         self.arraywidget = comparatorwidget
 
         main_splitter = QSplitter(Qt.Horizontal)
diff --git a/larray_editor/tests/test_api_larray.py b/larray_editor/tests/test_api_larray.py
@@ -5,7 +5,7 @@
 import logging
 
 import numpy as np
-from larray import (Session, Axis, LArray, ndtest, zeros, from_lists, union,
+from larray import (Session, Axis, LArray, ndtest, zeros, ones, from_lists, union,
                     sin, cos, radians, maximum, sqrt, where, random, inf, nan)
 
 from larray_editor.api import *
@@ -157,6 +157,16 @@ def make_demo(width=20, ball_radius=5, path_radius=5, steps=30):
 # print('\n open CSV')
 # edit('x_csv')
 
+arr1 = ones((geo, sex))
+arr2 = random.normal(axes=(geo, sex))
+compare(arr1, arr2, atol=0.5)
+compare(arr1, arr2, rtol=0.3)
+
+arr2 = where(arr2 > 1, arr1, -arr1)
+arr1['M'] = nan
+arr2['M'] = nan
+compare(arr1, arr2, nans_equal=False)
+
 arr1 = ndtest((3, 3))
 arr2 = 2 * arr1
 arr3 = where(arr1 % 2 == 0, arr1, -arr1)
