peek_overlaps: Peek First Interval Overlapping a Query Interval

In Immutables: Fast and Functional Data Structures

Peek First Interval Overlapping a Query Interval

Description

Peek First Interval Overlapping a Query Interval

Usage

peek_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

Returns the first match in canonical interval order. Use peek_all_overlaps() to retrieve all matches as an interval_index slice.

Value

The payload value from the first match, or NULL on no match.

Examples

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

# Boundary override at touching endpoints
edge <- interval_index("a", start = 1, end = 3, default_query_bounds = "[)")
peek_overlaps(edge, 3, 4)                # default "[)": no endpoint overlap
peek_overlaps(edge, 3, 4, bounds = "[]") # closed bounds: endpoint overlaps

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