superintervals 0.3.0__tar.gz → 0.3.2__tar.gz

{superintervals-0.3.0/src/superintervals.egg-info → superintervals-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: superintervals
-Version: 0.3.0
+Version: 0.3.2
 Summary: Rapid interval intersections
 Author: Kez Cleal
 Author-email: Kez Cleal <clealk@cardiff.ac.uk>

{superintervals-0.3.0 → superintervals-0.3.2}/README.md

@@ -5,7 +5,8 @@ A fast, memory-efficient data structure for interval intersection queries.
 SuperIntervals uses a novel superset-index approach that maintains 
 intervals in position-sorted order, enabling cache-friendly searches and SIMD-optimized counting.
 
-Available for [C++](#cpp), [Rust](#rust), [Python](#python), [R](#r).
+Available for [C++](#cpp), [Rust](#rust), [Python](#python).
+A version for R can be found at https://github.com/kcleal/superintervalsr.
 
 ### Features:
 
@@ -35,150 +36,8 @@ imap.build()
 results = imap.search_values(8, 20)  # ['A']
 ```
 
-### API Reference
-
-**IntervalMap** class:
-
-- `add(start, end, value=None)`  
-  Add interval with associated value
-
-
-- `build()`  
-  Build index (required before queries)
-
-
-- `clear()`  
-  Remove all intervals
-
-
-- `reserve(n)`  
-  Reserve space for n intervals
-
-
-- `size()`  
-  Get number of intervals
-
-
-- `at(index)`  
-  Get interval at index as (start, end, value)
-
-
-- `starts_at(index)`  
-  Get start position at index
-
-
-- `ends_at(index)`  
-  Get end position at index
-
-
-- `data_at(index)`  
-  Get value at index
-
-
-- `has_overlaps(start, end)`  
-  Check if any intervals overlap range
-
-
-- `count(start, end)`  
-  Count overlapping intervals
-
-
-- `search_values(start, end)`  
-  Get values of overlapping intervals
-
-
-- `search_idxs(start, end)`  
-  Get indices of overlapping intervals
-
-
-- `search_keys(start, end)`  
-  Get (start, end) pairs of overlapping intervals
-
-
-- `search_items(start, end)`  
-  Get (start, end, value) tuples of overlapping intervals
-
-
-- `coverage(start, end)`  
-  Get (count, total_coverage) for range
-
-## R
-
-```r
-library(superintervals)
-
-imap <- IntervalMap()
-add(imap, 10, 20, "A")
-build(imap)
-results <- search_values(imap, 8, 20)
-```
-
-### API Reference
-
-**IntervalMap()** - Create new IntervalMap object
-
-- `add(x, start, end, value=NULL)`  
-  Add interval with associated value
-
-
-- `build(x)`  
-  Build index (required before queries)
-
-
-- `clear(x)`  
-  Remove all intervals
-
-
-- `reserve(x, n)`  
-  Reserve space for n intervals
-
-
-- `size(x)`  
-  Get number of intervals
-
-
-- `at(x, idx)`  
-  Get interval at index as list(start, end, value)
-
-
-- `starts_at(x, idx)`  
-  Get start position at index
-
-
-- `ends_at(x, idx)`  
-  Get end position at index
-
-
-- `data_at(x, idx)`  
-  Get value at index
-
-
-- `has_overlaps(x, start, end)`  
-  Check if any intervals overlap range
-
-
-- `count(x, start, end)`  
-  Count overlapping intervals
-
-
-- `search_values(x, start, end)`  
-  Get values of overlapping intervals
-
-
-- `search_idxs(x, start, end)`  
-  Get indices of overlapping intervals
-
-
-- `search_keys(x, start, end)`  
-  Get list(start, end) of overlapping intervals
-
-
-- `search_items(x, start, end)`  
-  Get list(start, end, value) of overlapping intervals
-
-
-- `coverage(x, start, end)`  
-  Get list(count, total_coverage) for range
+Python API documentation can be found here:
+https://github.com/kcleal/superintervals/blob/main/src/superintervals/README.md
 
 
 ## Cpp
@@ -195,88 +54,8 @@ std::vector<std::string> results;
 imap.search_values(4, 9, results);
 ```
 
-### API Reference
-
-**IntervalMap<S, T>** class (also **IntervalMapEytz<S, T>** for Eytzinger layout):
-
-- `void add(S start, S end, const T& value)`  
-  Add interval with associated value
-
-
-- `void build()`  
-  Build index (required before queries)
-
-
-- `void clear()`  
-  Remove all intervals
-
-
-- `void reserve(size_t n)`  
-  Reserve space for n intervals
-
-
-- `size_t size()`  
-  Get number of intervals
-
-
-- `const Interval<S,T>& at(size_t index)`  
-  Get Interval<S,T> at index
-
-
-- `void at(size_t index, Interval<S,T>& interval)`  
-  Fill provided Interval object
-
-
-- `bool has_overlaps(S start, S end)`  
-  Check if any intervals overlap range
-
-
-- `size_t count(S start, S end)`  
-  Count overlapping intervals (SIMD optimized)
-
-
-- `size_t count_linear(S start, S end)`  
-  Count overlapping intervals (linear)
-
-
-- `size_t count_large(S start, S end)`  
-  Count optimized for large ranges
-
-
-- `void search_values(S start, S end, std::vector<T>& found)`  
-  Fill vector with values of overlapping intervals
-
-
-- `void search_values_large(S start, S end, std::vector<T>& found)`  
-  Search optimized for large ranges
-
-
-- `void search_idxs(S start, S end, std::vector<size_t>& found)`  
-  Fill vector with indices of overlapping intervals
-
-
-- `void search_keys(S start, S end, std::vector<std::pair<S,S>>& found)`  
-  Fill vector with (start,end) pairs
-
-
-- `void search_items(S start, S end, std::vector<Interval<S,T>>& found)`  
-  Fill vector with Interval<S,T> objects
-
-
-- `void search_point(S point, std::vector<T>& found)`  
-  Find intervals containing single point
-
-
-- `void coverage(S start, S end, std::pair<size_t,S>& result)`  
-  Get pair(count, total_coverage) for range
-
-
-- `IndexRange search_idxs(S start, S end)`  
-  Returns IndexRange for range-based loops over indices
-
-
-- `ItemRange search_items(S start, S end)`  
-  Returns ItemRange for range-based loops over intervals
+C++ API documentation can be found here:
+https://github.com/kcleal/superintervals/blob/main/src/README.md
 
 
 ## Rust
@@ -293,88 +72,9 @@ let mut results = Vec::new();
 imap.search_values(4, 11, &mut results);
 ```
 
-### API Reference
-
-**IntervalMap<T>** struct (also **IntervalMapEytz<T>** for Eytzinger layout):
-
-- `fn new() -> Self`  
-  Create new IntervalMap
-
-
-- `fn add(&mut self, start: i32, end: i32, value: T)`  
-  Add interval with associated value
-
-
-- `fn build(&mut self)`  
-  Build index (required before queries)
-
-
-- `fn clear(&mut self)`  
-  Remove all intervals
-
-
-- `fn reserve(&mut self, n: usize)`  
-  Reserve space for n intervals
-
-
-- `fn size(&self) -> usize`  
-  Get number of intervals
-
-
-- `fn at(&self, index: usize) -> Interval<T>`  
-  Get Interval<T> at index
-
-
-- `fn has_overlaps(&mut self, start: i32, end: i32) -> bool`  
-  Check if any intervals overlap range
-
-
-- `fn count(&mut self, start: i32, end: i32) -> usize`  
-  Count overlapping intervals (SIMD optimized)
-
-
-- `fn count_linear(&mut self, start: i32, end: i32) -> usize`  
-  Count overlapping intervals (linear)
-
-
-- `fn count_large(&mut self, start: i32, end: i32) -> usize`  
-  Count optimized for large ranges
-
-
-- `fn search_values(&mut self, start: i32, end: i32, found: &mut Vec<T>)`  
-  Fill vector with values of overlapping intervals
-
-
-- `fn search_values_large(&mut self, start: i32, end: i32, found: &mut Vec<T>)`  
-  Search optimized for large ranges
-
-
-- `fn search_idxs(&mut self, start: i32, end: i32, found: &mut Vec<usize>)`  
-  Fill vector with indices of overlapping intervals
-
-
-- `fn search_keys(&mut self, start: i32, end: i32, found: &mut Vec<(i32, i32)>)`  
-  Fill vector with (start,end) pairs
-
-
-- `fn search_items(&mut self, start: i32, end: i32, found: &mut Vec<Interval<T>>)`  
-  Fill vector with Interval<T> objects
-
-
-- `fn search_stabbed(&mut self, point: i32, found: &mut Vec<T>)`  
-  Find intervals containing single point
-
-
-- `fn coverage(&mut self, start: i32, end: i32) -> (usize, i32)`  
-  Get (count, total_coverage) for range
-
-
-- `fn search_idxs_iter(&mut self, start: i32, end: i32) -> IndexIterator<T>`  
-  Iterator over indices
-
+Rust API documentation can be found here:
+https://github.com/kcleal/superintervals/blob/main/src/README.md
 
-- `fn search_items_iter(&mut self, start: i32, end: i32) -> ItemIterator<T>`  
-  Iterator over intervals
 
 
 ## Test programs

{superintervals-0.3.0 → superintervals-0.3.2}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "superintervals"
-version = "0.3.0"
+version = "0.3.2"
 description = "Rapid interval intersections"
 dependencies = ['Cython']
 authors = [{name = "Kez Cleal", email = "clealk@cardiff.ac.uk"}]