elements_between: Return Elements in a Key Range

In Immutables: Fast and Functional Data Structures

Return Elements in a Key Range

Description

Return Elements in a Key Range

Usage

elements_between(x, from_key, to_key, include_from = TRUE, include_to = TRUE)

Arguments

x	An ordered_sequence.
from_key	Lower bound key.
to_key	Upper bound key.
include_from	Include lower bound when TRUE.
include_to	Include upper bound when TRUE.

Details

Range membership is controlled by include_from and include_to:

• include_from = TRUE uses key >= from_key; otherwise key > from_key.

• include_to = TRUE uses key <= to_key; otherwise key < to_key.

If no elements fall in the range, returns an empty ordered_sequence.

Value

An ordered_sequence of matched elements, in key order. Use as.list() to convert to a plain list.

Examples

x <- ordered_sequence("a", "b", "c", "d", keys = c(1, 2, 2, 3))
elements_between(x, 2, 3)
as.list(elements_between(x, 2, 3))
elements_between(x, 2, 2, include_to = FALSE)

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