Skip to content

BUG: pandas.cut should disallow overlapping IntervalIndex bins #23980

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.

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

Already on GitHub? Sign in to your account

Closed
jschendel opened this issue Nov 28, 2018 · 2 comments · Fixed by #23999
Closed

BUG: pandas.cut should disallow overlapping IntervalIndex bins #23980

jschendel opened this issue Nov 28, 2018 · 2 comments · Fixed by #23999
Labels
Bug good first issue Interval Interval data type Reshaping Concat, Merge/Join, Stack/Unstack, Explode
Milestone

Comments

@jschendel
Copy link
Member

Code Sample, a copy-pastable example if possible

In [2]: ii = pd.IntervalIndex.from_tuples([(0, 10), (2, 12), (4, 14)])

In [3]: pd.cut([5, 6], bins=ii)
Out[3]:
[(0, 10], (2, 12], (4, 14], (0, 10], (2, 12], (4, 14]]
Categories (3, interval[int64]): [(0, 10] < (2, 12] < (4, 14]]

Problem description

When an overlapping IntervalIndex is provided for bins, all intervals overlapping a given point will be returned for that point. I don't think this behavior makes sense.

Expected Output

I'd expect a ValueError to be raised, or at the very least for this behavior to be documented if it's intended.

I think this should be straightforward to implement once IntervalIndex.is_overlapping has been completed, which should be soon assuming there aren't any major issues with the PR (xref #23327).

If I'm not mistaken, it should just be just a matter of modifying this block of code:

elif isinstance(bins, IntervalIndex):
pass

And make it check if the bins are overlapping:

elif isinstance(bins, IntervalIndex):
    if bins.is_overlapping:
        raise ValueError(...)    

Output of pd.show_versions()

INSTALLED VERSIONS

commit: 30c1290
python: 3.6.1.final.0
python-bits: 64
OS: Windows
OS-release: 10
machine: AMD64
processor: Intel64 Family 6 Model 78 Stepping 3, GenuineIntel
byteorder: little
LC_ALL: None
LANG: None
LOCALE: None.None

pandas: 0.24.0.dev0+1141.g30c129061
pytest: 3.8.2
pip: 9.0.1
setuptools: 39.0.1
Cython: 0.28.2
numpy: 1.13.3
scipy: 1.0.0
pyarrow: 0.6.0
xarray: 0.9.6
IPython: 6.1.0
sphinx: 1.5.6
patsy: 0.4.1
dateutil: 2.6.0
pytz: 2017.2
blosc: None
bottleneck: 1.2.1
tables: 3.4.2
numexpr: 2.6.4
feather: 0.4.0
matplotlib: 2.0.2
openpyxl: 2.4.8
xlrd: 1.1.0
xlwt: 1.3.0
xlsxwriter: 0.9.8
lxml: 3.8.0
bs4: None
html5lib: 0.999
sqlalchemy: 1.1.13
pymysql: None
psycopg2: None
jinja2: 2.9.6
s3fs: None
fastparquet: 0.1.5
pandas_gbq: None
pandas_datareader: None
gcsfs: None

@jschendel jschendel added Interval Interval data type good first issue labels Nov 28, 2018
@jschendel jschendel added this to the Contributions Welcome milestone Nov 28, 2018
@charlesdong1991
Copy link
Member

i would like to pick this up!

@jschendel
Copy link
Member Author

Thanks @charlesdong1991 : the IntervalIndex.is_overlapping PR has been merged, so this should be clear to work on when you have the time.

@jschendel jschendel changed the title BUG: pandas.cut with should disallow overlapping IntervalIndex bins BUG: pandas.cut should disallow overlapping IntervalIndex bins Nov 29, 2018
@jschendel jschendel added Bug Reshaping Concat, Merge/Join, Stack/Unstack, Explode labels Nov 29, 2018
@jschendel jschendel modified the milestones: Contributions Welcome, 0.24.0 Nov 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug good first issue Interval Interval data type Reshaping Concat, Merge/Join, Stack/Unstack, Explode
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants