README

RangeSet is a lightweight PHP library for managing sets of integers with automatic interval merging.
It efficiently stores consecutive numbers as ranges, supports fast membership checks, and allows iterating over all numbers in ascending order.

Installation

Install via Composer:

composer require rekmixa/range-set

Usage

<?php

use Rekmixa\RangeSet\RangeSet;

$rangeSet = new RangeSet();

// Adding numbers
$rangeSet->push(5);
$rangeSet->push(7);
$rangeSet->push(6); // automatically merges 5, 6, 7 into one interval

$rangeSet->push(11);
$rangeSet->push(10);
$rangeSet->push(9); // merges 9, 10, 11 into another interval

$rangeSet->push(3);
$rangeSet->push(4); // merges 3, 4, 5, 6, 7 into a single interval with previous numbers

// Check if a number exists
var_dump($rangeSet->contains(5)); // true
var_dump($rangeSet->contains(12)); // false

// Iterate over all numbers in ascending order
foreach ($rangeSet->each() as $number) {
    echo $number . PHP_EOL;
}
// Output: 3, 4, 5, 6, 7, 9, 10, 11

// Count total numbers
var_dump($rangeSet->count()); // 8

// Check if the set is empty
var_dump($rangeSet->isEmpty()); // false

// Clear the set
$rangeSet->clear();
var_dump($rangeSet->isEmpty()); // true

Features

• Automatically merges consecutive numbers into intervals.
• Fast membership check using binary search.
• Generator-based iteration over all numbers in ascending order.
• Handles arbitrary insertion order efficiently.
• Lightweight, no dependencies.

License

MIT