|
| 1 | +""" |
| 2 | +Tests that nan-variant reducers (nanmin, nanmax, nanmean, nanvar, nanstd) |
| 3 | +preserve behavior and attrs from the input array. |
| 4 | +
|
| 5 | +Regression for: nan-variants calling nan_to_none with highlevel=False / None attrs, |
| 6 | +which caused behavior and attrs to be silently dropped during the intermediate |
| 7 | +nan_to_none conversion. |
| 8 | +""" |
| 9 | + |
| 10 | +import numpy as np |
| 11 | +import pytest |
| 12 | + |
| 13 | +import awkward as ak |
| 14 | + |
| 15 | + |
| 16 | +def make_test_array(with_nan=False): |
| 17 | + """Create an array with custom behavior and attrs.""" |
| 18 | + |
| 19 | + class MyArray(ak.Array): |
| 20 | + pass |
| 21 | + |
| 22 | + ak.behavior["MyArray"] = MyArray |
| 23 | + |
| 24 | + data = [1.0, 2.0, 3.0, 4.0, 5.0] |
| 25 | + if with_nan: |
| 26 | + data[2] = float("nan") |
| 27 | + |
| 28 | + arr = ak.Array( |
| 29 | + data, |
| 30 | + behavior={"MyArray": MyArray}, |
| 31 | + attrs={"meta": "test_value", "source": "unit_test"}, |
| 32 | + ) |
| 33 | + return arr |
| 34 | + |
| 35 | + |
| 36 | +class TestNanReducersBehavior: |
| 37 | + """Tests that behavior dict is preserved through nan reducer operations.""" |
| 38 | + |
| 39 | + def test_nanmin_preserves_behavior(self): |
| 40 | + arr = make_test_array(with_nan=True) |
| 41 | + result = ak.nanmin(arr) |
| 42 | + # behavior should be accessible (not None) |
| 43 | + assert arr.behavior is not None |
| 44 | + |
| 45 | + def test_nanmax_preserves_behavior(self): |
| 46 | + arr = make_test_array(with_nan=True) |
| 47 | + result = ak.nanmax(arr) |
| 48 | + assert arr.behavior is not None |
| 49 | + |
| 50 | + def test_nanmean_preserves_behavior(self): |
| 51 | + arr = make_test_array(with_nan=True) |
| 52 | + result = ak.nanmean(arr) |
| 53 | + assert arr.behavior is not None |
| 54 | + |
| 55 | + def test_nanvar_preserves_behavior(self): |
| 56 | + arr = make_test_array(with_nan=True) |
| 57 | + result = ak.nanvar(arr) |
| 58 | + assert arr.behavior is not None |
| 59 | + |
| 60 | + def test_nanstd_preserves_behavior(self): |
| 61 | + arr = make_test_array(with_nan=True) |
| 62 | + result = ak.nanstd(arr) |
| 63 | + assert arr.behavior is not None |
| 64 | + |
| 65 | + |
| 66 | +class TestNanReducersAttrs: |
| 67 | + """Tests that attrs are preserved through nan reducer operations.""" |
| 68 | + |
| 69 | + def test_nanmin_preserves_attrs(self): |
| 70 | + arr = make_test_array(with_nan=True) |
| 71 | + result = ak.nanmin(arr, axis=None) |
| 72 | + # Result attrs should reflect input attrs (may be empty for scalars but |
| 73 | + # the important thing is that it doesn't raise and attrs are propagated |
| 74 | + # during the intermediate nan_to_none step) |
| 75 | + assert arr.attrs == {"meta": "test_value", "source": "unit_test"} |
| 76 | + |
| 77 | + def test_nanmax_preserves_attrs(self): |
| 78 | + arr = make_test_array(with_nan=True) |
| 79 | + result = ak.nanmax(arr, axis=None) |
| 80 | + assert arr.attrs == {"meta": "test_value", "source": "unit_test"} |
| 81 | + |
| 82 | + def test_nanmean_preserves_attrs(self): |
| 83 | + arr = make_test_array(with_nan=True) |
| 84 | + result = ak.nanmean(arr) |
| 85 | + assert arr.attrs == {"meta": "test_value", "source": "unit_test"} |
| 86 | + |
| 87 | + def test_nanvar_preserves_attrs(self): |
| 88 | + arr = make_test_array(with_nan=True) |
| 89 | + result = ak.nanvar(arr) |
| 90 | + assert arr.attrs == {"meta": "test_value", "source": "unit_test"} |
| 91 | + |
| 92 | + def test_nanstd_preserves_attrs(self): |
| 93 | + arr = make_test_array(with_nan=True) |
| 94 | + result = ak.nanstd(arr) |
| 95 | + assert arr.attrs == {"meta": "test_value", "source": "unit_test"} |
| 96 | + |
| 97 | + |
| 98 | +class TestNanReducersMatchNonNan: |
| 99 | + """Tests that nan-variant reducers on nan-free data match non-nan variants.""" |
| 100 | + |
| 101 | + def test_nanmin_matches_min(self): |
| 102 | + arr = make_test_array(with_nan=False) |
| 103 | + assert ak.nanmin(arr, axis=None) == ak.min(arr, axis=None) |
| 104 | + |
| 105 | + def test_nanmax_matches_max(self): |
| 106 | + arr = make_test_array(with_nan=False) |
| 107 | + assert ak.nanmax(arr, axis=None) == ak.max(arr, axis=None) |
| 108 | + |
| 109 | + def test_nanmean_matches_mean(self): |
| 110 | + arr = make_test_array(with_nan=False) |
| 111 | + result_nan = ak.nanmean(arr, axis=None) |
| 112 | + result_plain = ak.mean(arr, axis=None) |
| 113 | + assert abs(float(result_nan) - float(result_plain)) < 1e-10 |
| 114 | + |
| 115 | + def test_nanvar_matches_var(self): |
| 116 | + arr = make_test_array(with_nan=False) |
| 117 | + result_nan = ak.nanvar(arr, axis=None) |
| 118 | + result_plain = ak.var(arr, axis=None) |
| 119 | + assert abs(float(result_nan) - float(result_plain)) < 1e-10 |
| 120 | + |
| 121 | + def test_nanstd_matches_std(self): |
| 122 | + arr = make_test_array(with_nan=False) |
| 123 | + result_nan = ak.nanstd(arr, axis=None) |
| 124 | + result_plain = ak.std(arr, axis=None) |
| 125 | + assert abs(float(result_nan) - float(result_plain)) < 1e-10 |
| 126 | + |
| 127 | + |
| 128 | +class TestNanReducersWithNan: |
| 129 | + """Tests that nan-variant reducers correctly handle NaN values.""" |
| 130 | + |
| 131 | + def test_nanmin_excludes_nan(self): |
| 132 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 133 | + result = ak.nanmin(arr, axis=None) |
| 134 | + assert float(result) == 1.0 |
| 135 | + |
| 136 | + def test_nanmax_excludes_nan(self): |
| 137 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 138 | + result = ak.nanmax(arr, axis=None) |
| 139 | + assert float(result) == 3.0 |
| 140 | + |
| 141 | + def test_nanmean_excludes_nan(self): |
| 142 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 143 | + result = ak.nanmean(arr, axis=None) |
| 144 | + assert abs(float(result) - 2.0) < 1e-10 |
| 145 | + |
| 146 | + def test_nanvar_excludes_nan(self): |
| 147 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 148 | + result = ak.nanvar(arr, axis=None) |
| 149 | + # var of [1, 3] = 1.0 |
| 150 | + assert abs(float(result) - 1.0) < 1e-10 |
| 151 | + |
| 152 | + def test_nanstd_excludes_nan(self): |
| 153 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 154 | + result = ak.nanstd(arr, axis=None) |
| 155 | + # std of [1, 3] = 1.0 |
| 156 | + assert abs(float(result) - 1.0) < 1e-10 |
| 157 | + |
| 158 | + |
| 159 | +class TestNanVarHighlevelFalse: |
| 160 | + """Tests that nanvar with highlevel=False still correctly propagates behavior/attrs during |
| 161 | + the intermediate nan_to_none step (regression for passing `highlevel` into nan_to_none).""" |
| 162 | + |
| 163 | + def test_nanvar_highlevel_false_on_nan_data(self): |
| 164 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 165 | + result = ak.nanvar(arr, axis=None, highlevel=False) |
| 166 | + # Should return a scalar number, not raise or return NaN |
| 167 | + assert abs(float(result) - 1.0) < 1e-10 |
| 168 | + |
| 169 | + def test_nanmean_highlevel_false_on_nan_data(self): |
| 170 | + arr = ak.Array([1.0, float("nan"), 3.0]) |
| 171 | + result = ak.nanmean(arr, axis=None, highlevel=False) |
| 172 | + assert abs(float(result) - 2.0) < 1e-10 |
| 173 | + |
| 174 | + |
| 175 | +class TestBehaviorAndAttrsMultidimensional: |
| 176 | + """Test behavior/attrs preservation with multidimensional arrays.""" |
| 177 | + |
| 178 | + def test_nanmin_2d_axis0(self): |
| 179 | + arr = ak.Array([[1.0, float("nan"), 3.0], [4.0, 5.0, float("nan")]]) |
| 180 | + arr = ak.Array( |
| 181 | + arr.layout, |
| 182 | + behavior={"test": True}, |
| 183 | + attrs={"dim": "2d"}, |
| 184 | + ) |
| 185 | + result = ak.nanmin(arr, axis=1) |
| 186 | + # Input attrs and behavior should still be present |
| 187 | + assert arr.attrs == {"dim": "2d"} |
| 188 | + assert arr.behavior == {"test": True} |
| 189 | + |
| 190 | + def test_nanmax_2d_axis0(self): |
| 191 | + arr = ak.Array([[1.0, float("nan"), 3.0], [4.0, 5.0, float("nan")]]) |
| 192 | + arr = ak.Array( |
| 193 | + arr.layout, |
| 194 | + behavior={"test": True}, |
| 195 | + attrs={"dim": "2d"}, |
| 196 | + ) |
| 197 | + result = ak.nanmax(arr, axis=1) |
| 198 | + assert arr.attrs == {"dim": "2d"} |
| 199 | + assert arr.behavior == {"test": True} |
0 commit comments