Value	Description
`"left"`	Make the left endpoint inclusive. Make the right endpoint exclusive.
`"right"`	Make the right endpoint inclusive. Make the left endpoint exclusive.
`"both"`	Make both endpoints inclusive.
`"neither"`	Make both endpoints exclusive.

By default, closed="right".

3. dtype | dtype or None | optional

The data type to use for the IntervalIndex. By default, the data type will be inferred from data.

4. copy | boolean | optional

If True, then data is copied to construct a new IntervalIndex. Modifying the returned IntervalIndex will not mutate data.
If False, then no copying is done so that the returned IntervalIndex will hold a reference to data. Modifying the IntervalIndex will mutate data, and vice versa.

By default, copy=False.

5. namelink | object | optional

The name assigned to the Interval Index.

6. verify_integrity | boolean | optional

Whether or not to raise an error if the resulting index is invalid. By default, verify_integrity=True.

Return Value

A IntervalIndex.

Examples

Basic usage

To create an IntervalIndex:


        
        
            
                
                
                    i1 = pd.Interval(left=3, right=4)
i2 = pd.Interval(left=4, right=6)
idx = pd.IntervalIndex([i1,i2])
idx
                
            
            IntervalIndex([(3, 4], (4, 6]],
              closed='right',
              dtype='interval[int64]')

To use this as the index of a DataFrame:


        
        
            
                
                
                    pd.DataFrame({"A":["a","b"]}, index=idx)
                
            
                    A
(3, 4]  a
(4, 6]  b

Here, (3,4] denotes the interval 3 < x <= 4.

Specifying name

To assign a name to the IntervalIndex, specify name like so:


        
        
            
                
                
                    i1 = pd.Interval(left=3, right=4)
i2 = pd.Interval(left=4, right=6)
idx = pd.IntervalIndex([i1,i2], name="my_intervals")
idx
                
            
            IntervalIndex([(3, 4], (4, 6]],
              closed='right',
              name='my_intervals',
              dtype='interval[int64]')

When assigning this as the index of a DataFrame:


        
        
            
                
                
                    pd.DataFrame({"A":["a","b"]}, index=idx)
                
            
                          A
my_intervals  
(3, 4]        a
(4, 6]        b

Published by Isshin Inada

Edited by 0 others

Did you find this page useful?

thumb_up

thumb_down

Comment

Citation

Ask a question or leave a feedback...

Official Pandas Documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.IntervalIndex.html

thumb_up

thumb_down

chat_bubble_outline

settings

Enjoy our search

Hit / to insta-search docs and recipes!