Add spec for new Interval / IntervalIndex methods: .overlaps(), .covers() #18975
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,294 @@ | ||
| from __future__ import division | ||
|
|
||
| import pytest | ||
| import numpy as np | ||
|
|
||
| from pandas import Interval, IntervalIndex, Int64Index | ||
| from pandas.tests.indexes.common import Base | ||
| import pandas.util.testing as tm | ||
|
|
||
|
|
||
| pytestmark = pytest.mark.skip(reason="new indexing tests for issue 16316") | ||
|
|
||
|
|
||
| class TestIntervalIndex(Base): | ||
|
|
||
| def _compare_tuple_of_numpy_array(self, result, expected): | ||
| lidx, ridx = result | ||
| lidx_expected, ridx_expected = expected | ||
|
|
||
| tm.assert_numpy_array_equal(lidx, lidx_expected) | ||
| tm.assert_numpy_array_equal(ridx, ridx_expected) | ||
|
|
||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("other_side", ['right', 'left', 'both', 'neither']) | ||
| def test_interval_covers_interval(self, ivl_side, other_side): | ||
|
|
||
| # class Interval: | ||
| # def covers(self, other: Interval) -> bool | ||
|
|
||
| assert Interval(1, 3).covers(Interval(1.5, 2.5)) | ||
| assert Interval(1, 3).covers(Interval(1, 2)) | ||
| assert Interval(1, 3).covers(Interval(2, 3)) | ||
| assert not Interval(1, 3).covers(Interval(0.5, 2.5)) | ||
| assert not Interval(1, 3).covers(Interval(1.5, 3.5)) | ||
|
|
||
| should_cover = { | ||
| 'right': {'right': True, 'left': False, 'both': False, 'neither': True}, | ||
| 'left': {'right': False, 'left': True, 'both': False, 'neither': True}, | ||
| 'both': {'right': True, 'left': True, 'both': True, 'neither': True}, | ||
| 'neither': {'right': False, 'left': False, 'both': False, 'neither': True} | ||
| } | ||
|
|
||
| ivl = Interval(1, 3, closed=ivl_side) | ||
| other = Interval(1, 3, closed=other_side) | ||
| assert ivl.covers(other) == should_cover[ivl_side][other_side] | ||
|
|
||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("other_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_range", [(1, 3), (-1, 1), (3, 5)]) | ||
| def test_interval_overlaps_interval(self, ivl_side, other_side, ivl_range): | ||
|
|
||
| # class Interval: | ||
| # def overlaps(self, other: Interval) -> bool | ||
|
|
||
| assert Interval(1, 3).overlaps(Interval(1.5, 2.5)) | ||
| assert Interval(1, 3).overlaps(Interval(1, 2)) | ||
| assert Interval(1, 3).overlaps(Interval(2, 3)) | ||
| assert Interval(1, 3).overlaps(Interval(0.5, 2.5)) | ||
| assert Interval(1, 3).overlaps(Interval(1.5, 3.5)) | ||
|
|
||
| assert not Interval(1, 3).overlaps(Interval(-1, 1)) | ||
| assert not Interval(1, 3).overlaps(Interval(3, 5)) | ||
|
|
||
| ivl = Interval(*ivl_range, closed=ivl_side) | ||
| other = Interval(1, 3, closed=other_side) | ||
|
|
||
| should_overlap = { | ||
| # idx_side: | ||
| # ivl_side: {ivl_range: expected_result} | ||
| 'right': { | ||
| 'right': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| 'left':{(-1, 1): False, (1, 3): True, (3, 5): True}, | ||
| 'both': {(-1, 1): False, (1, 3): True, (3, 5): True}, | ||
| 'neither': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| }, | ||
| 'left': { | ||
| 'right': {(-1, 1): True, (1, 3): True, (3, 5): False}, | ||
| 'left':{(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| 'both': {(-1, 1): True, (1, 3): True, (3, 5): False}, | ||
| 'neither': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| }, | ||
| 'both': { | ||
| 'right': {(-1, 1): True, (1, 3): True, (3, 5): False}, | ||
| 'left':{(-1, 1): False, (1, 3): True, (3, 5): True}, | ||
| 'both': {(-1, 1): True, (1, 3): True, (3, 5): True}, | ||
| 'neither': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| }, | ||
| 'neither': { | ||
| 'right': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| 'left':{(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| 'both': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| 'neither': {(-1, 1): False, (1, 3): True, (3, 5): False}, | ||
| } | ||
| } | ||
|
|
||
| assert ivl.overlaps(other) == should_overlap[other_side][ivl_side][ivl_range] == other.overlaps(ivl) | ||
|
There was a problem hiding this comment. all of the tests from here on down should go in: There was a problem hiding this comment. @jreback do you still want to see this? |
||
|
|
||
| @pytest.mark.parametrize("idx_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_range", [(1, 3), (0, 3), (0, 2), (2, 4)]) | ||
| def test_interval_covers_intervalIndex(self, idx_side, ivl_side, ivl_range): | ||
|
|
||
| # class Interval: | ||
| # def covers(self, other: IntervalIndex) -> IntegerArray1D | ||
|
|
||
| idx = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed=idx_side) | ||
| ivl = Interval(*ivl_range, closed=ivl_side) | ||
|
|
||
| should_cover = { | ||
| # idx_side: | ||
| # ivl_side: {ivl_range: expected_result} | ||
| 'right': { | ||
| 'right': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'left': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]} | ||
| }, | ||
| 'left': { | ||
| 'right': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []} | ||
| }, | ||
| 'both': { | ||
| 'right': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []}, | ||
| 'left': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [], (0, 3): [], (0, 2): [], (2, 4): []} | ||
| }, | ||
| 'neither': { | ||
| 'right': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'left': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]} | ||
| } | ||
| } | ||
|
|
||
| tm.assert_numpy_array_equal(ivl.covers(idx), | ||
| should_cover[idx_side][ivl_side][ivl_range]) | ||
|
|
||
| @pytest.mark.parametrize("idx_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_range", [(1, 3), (0, 3), (0, 2), (2, 4)]) | ||
| def test_intervalIndex_covers_interval(self, idx_side, ivl_side, ivl_range): | ||
|
|
||
| # class IntervalIndex: | ||
| # def covers(self, other: Interval) -> IntegerArray1D | ||
|
|
||
| idx = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed=idx_side) | ||
| ivl = Interval(*ivl_range, closed=ivl_side) | ||
|
|
||
| should_cover = { | ||
| # idx_side: | ||
| # ivl_side: {ivl_range: expected_result} | ||
| 'right': { | ||
| 'right': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'left': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]} | ||
| }, | ||
| 'left': { | ||
| 'right': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []} | ||
| }, | ||
| 'both': { | ||
| 'right': {(1, 3): [1], (0, 3): [1, 2], (0, 2): [], (2, 4): []}, | ||
| 'left': {(1, 3): [], (0, 3): [0], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [], (0, 3): [], (0, 2): [], (2, 4): []} | ||
| }, | ||
| 'neither': { | ||
| 'right': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'left': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'both': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]}, | ||
| 'neither': {(1, 3): [1, 2], (0, 3): [0, 1, 2], (0, 2): [0], (2, 4): [1]} | ||
| } | ||
| } | ||
|
|
||
| tm.assert_numpy_array_equal(idx.covers(ivl), | ||
| should_cover[idx_side][ivl_side][ivl_range]) | ||
|
|
||
| @pytest.mark.parametrize("idx_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_range", [(1, 3), (1, 2), (0, 2), (3, 4)]) | ||
| def test_interval_overlaps_intervalIndex(self, idx_side, ivl_side, ivl_range): | ||
|
|
||
| # class Interval: | ||
| # def overlaps(self, other: IntervalIndex) -> IntegerArray1D | ||
|
There was a problem hiding this comment. the II tests need to go in pandas/tests/indexes/interval/test_interval_new.py |
||
|
|
||
| idx = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed=idx_side) | ||
| ivl = Interval(*ivl_range, closed=ivl_side) | ||
|
|
||
| should_overlap = { | ||
| # idx_side: | ||
| # ivl_side: {ivl_range: expected_result} | ||
| 'right': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'both': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'left': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'both': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'both': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'both': {(1, 3): [0, 1, 2], (1, 2): [0, 1, 2], (0, 2): [0, 1, 2], (3, 4): [1, 2]}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'neither': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'both': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| } | ||
| } | ||
|
|
||
| tm.assert_numpy_array_equal(ivl.overlaps(idx), | ||
| should_overlap[idx_side][ivl_side][ivl_range]) | ||
|
|
||
| @pytest.mark.parametrize("idx_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_side", ['right', 'left', 'both', 'neither']) | ||
| @pytest.mark.parametrize("ivl_range", [(1, 3), (1, 2), (0, 2), (3, 4)]) | ||
| def test_intervalIndex_overlaps_interval(self, idx_side, ivl_side, ivl_range): | ||
|
|
||
| # class IntervalIndex: | ||
| # def overlaps(self, other: Interval) -> IntegerArray1D | ||
|
|
||
| idx = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed=idx_side) | ||
| ivl = Interval(*ivl_range, closed=ivl_side) | ||
|
|
||
| should_overlap = { | ||
| # idx_side: | ||
| # ivl_side: {ivl_range: expected_result} | ||
| 'right': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'both': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'left': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'both': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'both': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [1, 2], (0, 2): [0, 1, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [0, 1, 2], (1, 2): [0, 2], (0, 2): [0, 2], (3, 4): [1, 2]}, | ||
| 'both': {(1, 3): [0, 1, 2], (1, 2): [0, 1, 2], (0, 2): [0, 1, 2], (3, 4): [1, 2]}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| }, | ||
| 'neither': { | ||
| 'right': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'left': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'both': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| 'neither': {(1, 3): [1, 2], (1, 2): [2], (0, 2): [0, 2], (3, 4): []}, | ||
| } | ||
| } | ||
|
|
||
| tm.assert_numpy_array_equal(idx.overlaps(ivl), | ||
| should_overlap[idx_side][ivl_side][ivl_range]) | ||
|
|
||
| def test_intervalIndex_covers_intervalIndex(self): | ||
|
|
||
| # class IntervalIndex: | ||
| # def covers(self, other: IntervalIndex) -> Tuple[IntegerArray1D, IntegerArray1D] | ||
|
|
||
| idx1 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='right') | ||
| idx2 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='left') | ||
| idx3 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='both') | ||
|
|
||
| self._compare_tuple_of_numpy_array(idx.covers(idx1), (np.array([0,1,2,2]), np.array([0,1,1,2]))) | ||
| self._compare_tuple_of_numpy_array(idx.covers(idx2), (np.array([2]), np.array([1]))) | ||
| self._compare_tuple_of_numpy_array(idx.covers(idx3), (np.array([0,1,2,2]), np.array([0,1,1,2]))) | ||
|
|
||
| def test_intervalIndex_overlaps_intervalIndex(self): | ||
|
|
||
| # class IntervalIndex: | ||
| # def overlaps(self, other: IntervalIndex) -> Tuple[IntegerArray1D, IntegerArray1D] | ||
|
|
||
| idx1 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='right') | ||
| idx2 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='left') | ||
| idx3 = IntervalIndex.from_tuples([(0, 1), (2, 3), (1, 3)], closed='both') | ||
|
|
||
| self._compare_tuple_of_numpy_array(idx.overlaps(idx1), (np.array([0,1,2,2]), np.array([0,1,1,2]))) | ||
| self._compare_tuple_of_numpy_array(idx.overlaps(idx2), (np.array([0,0,1,1,2,2]), np.array([0,2,1,2,1,2]))) | ||
| self._compare_tuple_of_numpy_array(idx.overlaps(idx3), (np.array([0,0,1,1,2,2]), np.array([0,2,1,2,1,2]))) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would like to ideally enocde these results IN the parameterization if possible.