Skip to main content

A library to handle interval sets

Project description

Interval Sets Library

Tests codecov PyPI version Python Versions License: MIT Code style: black

A Python library for performing set operations on intervals and points on the real number line. It supports continuous intervals with configurable open/closed boundaries and handles collections of disjoint intervals (sets) with automatic merging.

Note: This library focuses on set-theoretic operations (Union, Intersection, Difference) on intervals. It is not designed for strict interval arithmetic used for error bounding (e.g., [a,b] + [c,d]).

Features

  • 📏 Continuous Intervals: Configurable boundaries (a, b), [a, b], [a, b), (a, b].
  • 📦 Interval Sets: Disjoint collections with automatic merging.
  • 🔢 Set Operations: Exact Union (|), Intersection (&), Difference (-), and XOR (^).
  • 🛠️ Analysis & Topology: Tools for Convex Hull, Diameter, Boundedness, and Compactness.
  • 📐 Morphology: Minkowski Sum/Difference, Opening, Closing, and ε-dilation.
  • 🔒 Type Safe: Comprehensive type hints and runtime validation.
  • 🐍 Pythonic: Supports standard operators, hashing, and membership testing (in).

Installation

pip install interval-sets

Quick Start

Working with Intervals

The Interval class represents a single continuous range on the real number line.

from src.intervals import Interval

# Create intervals
closed = Interval(0, 10)                    # [0, 10]
open_int = Interval(0, 10, open_start=True, open_end=True)  # (0, 10)
half_open = Interval(0, 10, open_start=False, open_end=True) # [0, 10)

# Convenient factories
i1 = Interval.closed(0, 5)     # [0, 5]
i2 = Interval.open(5, 10)      # (5, 10)
p  = Interval.point(3)         # [3, 3] (Point)

# Check membership
5 in closed  # True
0 in open_int    # False (open boundary)

# Interval properties
closed.length()  # 10.0
closed.is_empty()  # False

Set Operations on Intervals

You can perform standard set operations on intervals. Operations that result in multiple disjoint intervals will return a Set object.

i1 = Interval(0, 10)
i2 = Interval(5, 15)
i3 = Interval(20, 25)

# Union
# Returns a single Interval if they overlap/touch, or a Set if disjoint
u1 = i1.union(i2)  # [0, 15]
u2 = i1.union(i3)  # {[0, 10], [20, 25]} (Set object)

# Intersection
inter = i1.intersection(i2)  # [5, 10]

# Difference
diff = i1.difference(i2)      # [0, 5)

Working with IntervalSets (1D Disjoint Intervals)

The IntervalSet class handles collections of 1D intervals and ensures they remain disjoint and normalized (merged).

from src.intervals import IntervalSet, Interval

# Create a set from a list of intervals
# Overlapping [0, 5] and [3, 8] automatically merge to [0, 8]
s = IntervalSet([
    Interval(0, 5),
    Interval(3, 8),
    Interval(10, 15)
])

print(s)  # {[0, 8], [10, 15]}

# Set Arithmetic using Operators
s1 = IntervalSet([Interval(0, 10)])
s2 = IntervalSet([Interval(5, 15)])

# Union (|)
print(s1 | s2)  # [0, 15]

Multi-Dimensional Support

The library supports N-dimensional intervals (Boxes) and universal sets of boxes (Sets).

The Box Class (Hyperrectangle)

A Box represents a Cartesian product of intervals: $B = I_1 \times I_2 \times ... \times I_n$.

from src.multidimensional import Box, Set
from src.intervals import Interval

# Create a 2D Unit Square [0,1]x[0,1]
square = Box([Interval(0, 1), Interval(0, 1)])
print(square.volume()) # 1.0

The Set Class (Universal N-D Set)

A Set represents a collection of disjoint Boxes. It is the N-dimensional equivalent of IntervalSet but supports all dimensions and automatic promotion.

# L-Shape Construction
v_bar = Box([Interval(0, 1), Interval(0, 2)])
h_bar = Box([Interval(0, 2), Interval(0, 1)])

# Union creates a Set
l_shape = Set([v_bar]).union(h_bar)
print(l_shape.volume()) # 3.0

# Promotion: You can mix 1D Intervals into a Set!
# They are automatically treated as 1D Boxes.
s = Set([Interval(0, 5), Interval(10, 15)])
print(s.volume()) # 10.0
  • Dimension Safety: Enforces dimension matching for all operations.

Topological Analysis & Morphology

# Topological checks
square.is_compact() # True
square.is_open()    # False

# Morphology
dilated = square.dilate_epsilon(0.1) # Expansion by 0.1
eroded = dilated.erode(square) # Morphological erosion

# Analysis
print(l_shape.convex_hull()) # Smallest Box containing the shape
print(l_shape.diameter())    # Maximum distance between points

Interval

Represents a continuous interval defined by start and end points and boundary openness.

Constructor:

  • Interval(start, end, *, open_start=False, open_end=False)

Factory Methods:

  • Interval.closed(start, end): [start, end]
  • Interval.open(start, end): (start, end)
  • Interval.left_open(start, end): (start, end]
  • Interval.right_open(start, end): [start, end)
  • Interval.point(value): [value, value]
  • Interval.empty(): (0, 0)

Key Methods:

  • union(other): Returns Interval or Set
  • intersection(other): Returns Interval or Set (empty)
  • difference(other): Returns Interval or Set
  • overlaps(other): Check if intervals overlap
  • is_adjacent(other): Check if intervals touch but don't overlap

Set

Represents a collection of disjoint intervals. All set operations (union, intersection, difference) are supported and return normalized Set or Interval objects.

Constructor:

  • Set(elements): List of Interval objects or nested Sets.

Key Methods:

  • contains(value): Check if a value or interval is contained in the set.
  • measure(): Total length of all intervals in the set.
  • infimum() / supremum(): Lower and upper bounds.
  • complement(universe): Return the complement of the set within a given universe interval.

Point

A helper class (inheriting from Interval) representing a degenerate interval [x, x].

Mathematical Notes & Design Decisions

  • Set Theory vs Interval Arithmetic: This library implements strict set-theoretic operations. [1, 2] + [3, 4] is treated as a Union operation (if valid in context), not numerical addition of bounds.
  • Normalization: The Set class enforces normalization. You cannot hold {[0, 5], [2, 7]} inside a Set; it will instantly become {[0, 7]}.
  • Empty Set: An empty set is represented by a Set with no intervals, Set(). Interval.empty() creates a special empty interval (0, 0) which acts as the neutral element for union.
  • Boundaries: We meticulously handle open vs closed boundaries (< vs <=) during merging and difference operations to ensure mathematical correctness.

Development

# Install dependencies
pip install pytest pytest-cov

# Run tests
pytest --cov --cov-report=term-missing tests/

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

interval_sets-0.1.2.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

interval_sets-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file interval_sets-0.1.2.tar.gz.

File metadata

  • Download URL: interval_sets-0.1.2.tar.gz
  • Upload date:
  • Size: 41.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.2

File hashes

Hashes for interval_sets-0.1.2.tar.gz
Algorithm Hash digest
SHA256 07486866e548713c8386aa0cfab7fa49fd45b821d186f5eb3e8fe3b15318536d
MD5 90380f922be64f3dec0d9dccdd0ffeab
BLAKE2b-256 93179e06a067740f678ba4e00a81e32419dca609fadf309ccc5a2709c2efe169

See more details on using hashes here.

File details

Details for the file interval_sets-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for interval_sets-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a361ab5077ec49d5c690450a31dac6dd5b8eb210b7313902b482e18d1b2fbdb6
MD5 458877cf20c981238c089b99bcf76297
BLAKE2b-256 f296c7100d2f99ba8779dfdc291ef2932b344202c38f445d80d68a5aab724ec0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page