Skip to content

PERF: Allow ensure_index_from_sequence to return RangeIndex #57786

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

Merged
merged 26 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
aa5589c
PERF: RangeIndex.take with 1 value return RangeIndex
mroeschke Mar 6, 2024
47af1ce
add issue number
mroeschke Mar 6, 2024
e7e0fcb
Move to _shallow_copy, support empty join as well
mroeschke Mar 6, 2024
67f1998
Fix self.name
mroeschke Mar 6, 2024
676a1f4
Merge remote-tracking branch 'upstream/main' into perf/ri/take_1
mroeschke Mar 6, 2024
e37500e
Merge remote-tracking branch 'upstream/main' into perf/ri/take_1
mroeschke Mar 6, 2024
2cc41fc
FIx error message
mroeschke Mar 6, 2024
7e1dac7
Merge remote-tracking branch 'upstream/main' into perf/ri/take_1
mroeschke Mar 6, 2024
c7da6ac
Fix hdf test
mroeschke Mar 6, 2024
90ff39c
PERF: Allow ensure_index_from_sequence to return RangeIndex
mroeschke Mar 8, 2024
66d3456
Ignore Index and Series objects
mroeschke Mar 9, 2024
5c01d6a
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 9, 2024
7e6fcea
Fix doctest
mroeschke Mar 9, 2024
1ab4c1e
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 13, 2024
b5144f4
More specific check
mroeschke Mar 13, 2024
64918cf
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 13, 2024
08da810
Only allow int64, fix indexing
mroeschke Mar 13, 2024
8957995
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 13, 2024
b7e5dc1
use Index
mroeschke Mar 13, 2024
f0592c5
Use np_values
mroeschke Mar 13, 2024
33fa1f4
Add back int32
mroeschke Mar 13, 2024
4015ac6
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 14, 2024
5fb9516
Ignore Series and Index objects
mroeschke Mar 14, 2024
ff186c1
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 14, 2024
4e7cf98
Wrong condition
mroeschke Mar 14, 2024
b5b9a89
Merge remote-tracking branch 'upstream/main' into perf/ri/ensure_inde…
mroeschke Mar 19, 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
44 changes: 41 additions & 3 deletions pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -7154,6 +7154,43 @@ def shape(self) -> Shape:
return (len(self),)


def maybe_sequence_to_range(sequence) -> Any | range:
"""
Convert a 1D, non-pandas sequence to a range if possible.

Returns the input if not possible.

Parameters
----------
sequence : 1D sequence
names : sequence of str

Returns
-------
Any : input or range
"""
if isinstance(sequence, (ABCSeries, Index)):
return sequence
np_sequence = np.asarray(sequence)
if np_sequence.dtype.kind != "i" or len(np_sequence) == 1:
return sequence
elif len(np_sequence) == 0:
return range(0)
diff = np_sequence[1] - np_sequence[0]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are only the first two elements important here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're taking an example diff here (just between the first 2 elements) and later seeing if the rest of the diffs between the rest of the elements match

if diff == 0:
return sequence
elif len(np_sequence) == 2:
return range(np_sequence[0], np_sequence[1] + diff, diff)
maybe_range_indexer, remainder = np.divmod(np_sequence - np_sequence[0], diff)
if (
lib.is_range_indexer(maybe_range_indexer, len(maybe_range_indexer))
and not remainder.any()
):
return range(np_sequence[0], np_sequence[-1] + diff, diff)
else:
return sequence


def ensure_index_from_sequences(sequences, names=None) -> Index:
"""
Construct an index from sequences of data.
Expand All @@ -7172,8 +7209,8 @@ def ensure_index_from_sequences(sequences, names=None) -> Index:

Examples
--------
>>> ensure_index_from_sequences([[1, 2, 3]], names=["name"])
Index([1, 2, 3], dtype='int64', name='name')
>>> ensure_index_from_sequences([[1, 2, 4]], names=["name"])
Index([1, 2, 4], dtype='int64', name='name')

>>> ensure_index_from_sequences([["a", "a"], ["a", "b"]], names=["L1", "L2"])
MultiIndex([('a', 'a'),
Expand All @@ -7189,8 +7226,9 @@ def ensure_index_from_sequences(sequences, names=None) -> Index:
if len(sequences) == 1:
if names is not None:
names = names[0]
return Index(sequences[0], name=names)
return Index(maybe_sequence_to_range(sequences[0]), name=names)
else:
# TODO: Apply maybe_sequence_to_range to sequences?
return MultiIndex.from_arrays(sequences, names=names)


Expand Down
24 changes: 4 additions & 20 deletions pandas/core/indexes/range.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
doc,
)

from pandas.core.dtypes import missing
from pandas.core.dtypes.base import ExtensionDtype
from pandas.core.dtypes.common import (
ensure_platform_int,
Expand Down Expand Up @@ -475,28 +474,13 @@ def _shallow_copy(self, values, name: Hashable = no_default):
if values.dtype.kind == "i" and values.ndim == 1:
# GH 46675 & 43885: If values is equally spaced, return a
# more memory-compact RangeIndex instead of Index with 64-bit dtype
if len(values) == 0:
return type(self)._simple_new(_empty_range, name=name)
elif len(values) == 1:
if len(values) == 1:
start = values[0]
new_range = range(start, start + self.step, self.step)
return type(self)._simple_new(new_range, name=name)
diff = values[1] - values[0]
if not missing.isna(diff) and diff != 0:
if len(values) == 2:
# Can skip is_range_indexer check
new_range = range(values[0], values[-1] + diff, diff)
return type(self)._simple_new(new_range, name=name)
else:
maybe_range_indexer, remainder = np.divmod(values - values[0], diff)
if (
lib.is_range_indexer(
maybe_range_indexer, len(maybe_range_indexer)
)
and not remainder.any()
):
new_range = range(values[0], values[-1] + diff, diff)
return type(self)._simple_new(new_range, name=name)
maybe_range = ibase.maybe_sequence_to_range(values)
if isinstance(maybe_range, range):
return type(self)._simple_new(maybe_range, name=name)
return self._constructor._simple_new(values, name=name)

def _view(self) -> Self:
Expand Down
8 changes: 5 additions & 3 deletions pandas/tests/indexes/test_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1514,8 +1514,10 @@ class TestIndexUtils:
@pytest.mark.parametrize(
"data, names, expected",
[
([[1, 2, 3]], None, Index([1, 2, 3])),
([[1, 2, 3]], ["name"], Index([1, 2, 3], name="name")),
([[1, 2, 4]], None, Index([1, 2, 4])),
([[1, 2, 4]], ["name"], Index([1, 2, 4], name="name")),
([[1, 2, 3]], None, RangeIndex(1, 4)),
([[1, 2, 3]], ["name"], RangeIndex(1, 4, name="name")),
(
[["a", "a"], ["c", "d"]],
None,
Expand All @@ -1530,7 +1532,7 @@ class TestIndexUtils:
)
def test_ensure_index_from_sequences(self, data, names, expected):
result = ensure_index_from_sequences(data, names)
tm.assert_index_equal(result, expected)
tm.assert_index_equal(result, expected, exact=True)

def test_ensure_index_mixed_closed_intervals(self):
# GH27172
Expand Down