pop_all_within: Pop All Intervals Within a Query Interval

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

pop_all_withinR Documentation

Pop All Intervals Within a Query Interval

Description

Pop All Intervals Within a Query Interval

Usage

pop_all_within(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

Use as.list() to convert elements to a standard R list.

Value

A list with elements and remaining, both interval_index objects.

Examples

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

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