pandas.IntervalIndex — pandas 3.0.0.dev0+2095.g2e141aaf99 documentation (original) (raw)
class pandas.IntervalIndex(data, closed=None, dtype=None, copy=False, name=None, verify_integrity=True)[source]#
Immutable index of intervals that are closed on the same side.
Parameters:
dataarray-like (1-dimensional)
Array-like (ndarray, DateTimeArray, TimeDeltaArray) containing Interval objects from which to build the IntervalIndex.
closed{‘left’, ‘right’, ‘both’, ‘neither’}, default ‘right’
Whether the intervals are closed on the left-side, right-side, both or neither.
dtypedtype or None, default None
If None, dtype will be inferred.
copybool, default False
Copy the input data.
nameobject, optional
Name to be stored in the index.
verify_integritybool, default True
Verify that the IntervalIndex is valid.
Attributes
Methods
See also
The base pandas Index type.
A bounded slice-like interval; the elements of an IntervalIndex.
Function to create a fixed frequency IntervalIndex.
Bin values into discrete Intervals.
Bin values into equal-sized Intervals based on rank or sample quantiles.
Notes
See the user guidefor more.
Examples
A new IntervalIndex is typically constructed usinginterval_range():
pd.interval_range(start=0, end=5) IntervalIndex([(0, 1], (1, 2], (2, 3], (3, 4], (4, 5]], dtype='interval[int64, right]')
It may also be constructed using one of the constructor methods: IntervalIndex.from_arrays(),IntervalIndex.from_breaks(), and IntervalIndex.from_tuples().
See further examples in the doc strings of interval_range and the mentioned constructor methods.