Skip to content

Consider NaNs equal when comparing cubes #5713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trexfeathers merged 4 commits into from
Feb 13, 2024
Merged

Consider NaNs equal when comparing cubes #5713

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9bcf541
Consider NaNs equal when comparing cubes
bouweandela Jan 24, 2024
5e2a974
Add whatsnew entry
bouweandela Jan 24, 2024
6244cee
Improve whatsnew
bouweandela Feb 12, 2024
ec30de8
Update whatsnew and use numpy.allclose instead of dask.array.allclose
bouweandela Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ This document explains the changes made to Iris for this release
馃挘 Incompatible Changes
=======================

#. N/A
#. `@bouweandela`_ updated cube comparison so cubes with data containing a
:obj:`numpy.nan` are now considered equal (:pull:`5713`)
Comment thread
bouweandela marked this conversation as resolved.
Outdated


馃殌 Performance Enhancements
Expand All @@ -113,6 +114,8 @@ This document explains the changes made to Iris for this release

#. `@bouweandela`_ made comparing coordinates and arrays to themselves faster. (:pull:`5691`)

#. `@bouweandela`_ made comparing cubes to themselves faster. (:pull:`5713`)


馃敟 Deprecations
===============
Expand Down
9 changes: 8 additions & 1 deletion lib/iris/cube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3824,6 +3824,9 @@ def _deepcopy(self, memo, data=None):

# START OPERATOR OVERLOADS
def __eq__(self, other):
if other is self:
return True

result = NotImplemented

if isinstance(other, Cube):
Expand Down Expand Up @@ -3862,7 +3865,11 @@ def __eq__(self, other):
if result:
# TODO: why do we use allclose() here, but strict equality in
# _DimensionalMetadata (via util.array_equal())?
result = da.allclose(self.core_data(), other.core_data()).compute()
result = da.allclose(
self.core_data(),
other.core_data(),
equal_nan=True,
).compute()
Comment thread
trexfeathers marked this conversation as resolved.
Outdated
return result

# Must supply __ne__, Python does not defer to __eq__ for negative equality
Expand Down
9 changes: 9 additions & 0 deletions lib/iris/tests/unit/cube/test_Cube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2841,11 +2841,20 @@ def test_unit_multiply(self):
class Test__eq__data(tests.IrisTest):
"""Partial cube equality testing, for data type only."""

def test_cube_identical_to_itself(self):
cube = Cube([1.0])
self.assertTrue(cube == cube)

def test_data_float_eq(self):
cube1 = Cube([1.0])
cube2 = Cube([1.0])
self.assertTrue(cube1 == cube2)

def test_data_float_nan_eq(self):
cube1 = Cube([np.nan, 1.0])
cube2 = Cube([np.nan, 1.0])
self.assertTrue(cube1 == cube2)

def test_data_float_eqtol(self):
val1 = np.array(1.0, dtype=np.float32)
# NOTE: Since v2.3, Iris uses "allclose". Prior to that we used
Expand Down