Immutables-deprecated: Deprecated functions in Immutables

In Immutables: Fast and Functional Data Structures

Deprecated functions in Immutables

Description

These functions still work but emit a deprecation warning and will be removed in a future release. Use the replacements instead:

Usage

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

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

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

pop_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 "[)", "[]", "()", "(]".
as_list	Passed to peek_all_overlapping().

Details

• peek_overlaps(): use peek_overlapping().

• peek_all_overlaps(): use peek_all_overlapping().

• pop_overlaps(): use pop_overlapping().

• pop_all_overlaps(): use pop_all_overlapping().

The ⁠*_overlaps⁠ names were renamed in version 1.2.0 so that the single-match functions read as singular, matching peek_containing() and peek_within().

Value

The same value as the replacement function.

Immutables documentation built on Sept. 26, 2026, 1:07 a.m.