peek_all_overlaps: Peek All Intervals Overlapping a Query Interval

View source: R/60-interval_index-query-api.R

peek_all_overlapsR Documentation

Peek All Intervals Overlapping a Query Interval

Description

Peek All Intervals Overlapping a Query Interval

Usage

peek_all_overlaps(x, start, end, bounds = NULL)

Arguments

x

An interval_index.

start

Query interval start.

end

Query interval end.

bounds

Optional boundary override. One of "[)", "[]", "()", "(]".

Details

The returned interval_index can be inspected with as.list().

Value

An interval_index slice of all matches (possibly empty).

Examples

ix <- interval_index("a", "b", "c", start = c(1, 3, 5), end = c(2, 4, 6))
as.list(peek_all_overlaps(ix, 2, 5))

Immutables documentation built on April 29, 2026, 1:06 a.m.