Interval

class Interval

Immutable object implementing an Interval.

Example

import pandasCore as pd

# Create Interval
obj = pd.Interval(...)

Attributes

Attribute	Description	Example
closed	String describing the inclusive side of the interval.	View
closed_left	Check if the interval is closed on the left side.	View
closed_right	Check if the interval is closed on the right side.	View
is_empty	Check if the interval is empty.
left	Left bound for the interval.	View
length	Return the length of the interval.	View
mid	Return the midpoint of the interval.	View
right	Right bound for the interval.	View

Construction

Method	Description	Example
__init__() (*args, **kwargs) | () | (left: typing.SupportsFloat, right: typing.SupportsFloat, closed: str = 'right')	Create a default interval (0, 0]	View

Comparison

Method	Description	Example
__eq__() (other: pandasCore.Interval)	Check equality with another Interval.
__ge__() (other: pandasCore.Interval)	Greater than or equal comparison
__gt__() (other: pandasCore.Interval)	Greater than comparison
__le__() (other: pandasCore.Interval)	Less than or equal comparison
__lt__() (other: pandasCore.Interval)	Less than comparison (lexicographic by left, then right)
__ne__() (other: pandasCore.Interval)	Check inequality with another Interval

Iteration

Method	Description	Example
__contains__() (item: typing.SupportsFloat)	Check if a value is contained in the interval.

Other Methods

Method	Description	Example
__hash__() ()	Return a hash value for the Interval.
__repr__() ()	Return a string representation of the Interval.
__str__() ()	Return a string representation of the interval bounds.
overlaps() (other: pandasCore.Interval)	Check whether two Interval objects overlap.

Code Examples

The following examples are extracted from the test suite.

closed (test_interval.py:37)

def test_interval_constructor():
    """Test Interval construction"""
    f_print_header("Test: Interval Constructor")

    try:
        # Default constructor
        iv = pandasCore.Interval(0, 5)
        f_print_success("Created Interval(0, 5)")

        # Check default closed is 'right'
        if iv.closed == 'right':
            f_print_success(f"Default closed is 'right': {iv.closed}")
        else:
            f_print_error(f"Expected closed='right', got '{iv.closed}'")
            return False

        # With explicit closed
        iv_left = pandasCore.Interval(0, 5, closed='left')
        if iv_left.closed == 'left':
            f_print_success(f"Created Interval with closed='left'")
        else:

closed_left (test_interval.py:108)

            return False

        # Test length
        if iv.length == 6.0:
            f_print_success(f"length property correct: {iv.length}")
        else:
            f_print_error(f"Expected length=6.0, got {iv.length}")
            return False

        # Test closed_left/closed_right
        if not iv.closed_left:
            f_print_success(f"closed_left is False for closed='right'")
        else:
            f_print_error(f"Expected closed_left=False for closed='right'")
            return False

        if iv.closed_right:
            f_print_success(f"closed_right is True for closed='right'")
        else:
            f_print_error(f"Expected closed_right=True for closed='right'")
            return False

closed_right (test_interval.py:114)

            f_print_error(f"Expected length=6.0, got {iv.length}")
            return False

        # Test closed_left/closed_right
        if not iv.closed_left:
            f_print_success(f"closed_left is False for closed='right'")
        else:
            f_print_error(f"Expected closed_left=False for closed='right'")
            return False

        if iv.closed_right:
            f_print_success(f"closed_right is True for closed='right'")
        else:
            f_print_error(f"Expected closed_right=True for closed='right'")
            return False

        return True

    except Exception as e:
        f_print_error(f"Exception: {e}")
        return False

left (test_interval.py:80)

def test_interval_properties():
    """Test Interval properties"""
    f_print_header("Test: Interval Properties")

    try:
        iv = pandasCore.Interval(2, 8, closed='right')

        # Test left
        if iv.left == 2.0:
            f_print_success(f"left property correct: {iv.left}")
        else:
            f_print_error(f"Expected left=2.0, got {iv.left}")
            return False

        # Test right
        if iv.right == 8.0:
            f_print_success(f"right property correct: {iv.right}")
        else:
            f_print_error(f"Expected right=8.0, got {iv.right}")

length (test_interval.py:101)

            return False

        # Test mid
        if iv.mid == 5.0:
            f_print_success(f"mid property correct: {iv.mid}")
        else:
            f_print_error(f"Expected mid=5.0, got {iv.mid}")
            return False

        # Test length
        if iv.length == 6.0:
            f_print_success(f"length property correct: {iv.length}")
        else:
            f_print_error(f"Expected length=6.0, got {iv.length}")
            return False

        # Test closed_left/closed_right
        if not iv.closed_left:
            f_print_success(f"closed_left is False for closed='right'")
        else:
            f_print_error(f"Expected closed_left=False for closed='right'")

mid (test_interval.py:94)

            return False

        # Test right
        if iv.right == 8.0:
            f_print_success(f"right property correct: {iv.right}")
        else:
            f_print_error(f"Expected right=8.0, got {iv.right}")
            return False

        # Test mid
        if iv.mid == 5.0:
            f_print_success(f"mid property correct: {iv.mid}")
        else:
            f_print_error(f"Expected mid=5.0, got {iv.mid}")
            return False

        # Test length
        if iv.length == 6.0:
            f_print_success(f"length property correct: {iv.length}")
        else:
            f_print_error(f"Expected length=6.0, got {iv.length}")

right (test_interval.py:87)

        iv = pandasCore.Interval(2, 8, closed='right')

        # Test left
        if iv.left == 2.0:
            f_print_success(f"left property correct: {iv.left}")
        else:
            f_print_error(f"Expected left=2.0, got {iv.left}")
            return False

        # Test right
        if iv.right == 8.0:
            f_print_success(f"right property correct: {iv.right}")
        else:
            f_print_error(f"Expected right=8.0, got {iv.right}")
            return False

        # Test mid
        if iv.mid == 5.0:
            f_print_success(f"mid property correct: {iv.mid}")
        else:
            f_print_error(f"Expected mid=5.0, got {iv.mid}")

__init__ (test_interval.py:33)

import pandasCore
import pandas as pd


def test_interval_constructor():
    """Test Interval construction"""
    f_print_header("Test: Interval Constructor")

    try:
        # Default constructor
        iv = pandasCore.Interval(0, 5)
        f_print_success("Created Interval(0, 5)")

        # Check default closed is 'right'
        if iv.closed == 'right':
            f_print_success(f"Default closed is 'right': {iv.closed}")
        else:
            f_print_error(f"Expected closed='right', got '{iv.closed}'")
            return False

        # With explicit closed