max_key: Maximum Key Value

View source: R/50-ordered_sequence-ops.R

max_keyR Documentation

Maximum Key Value

Description

Returns the largest key currently present in the ordered sequence.

Usage

max_key(x)

Arguments

x

An ordered_sequence.

Details

Uses cached .oms_max_key monoid state. Equivalent to key_at(x, length(x)).

Value

Maximum key, or NULL when x is empty.

See Also

min_key(), key_at(), nearest_key()

Examples

x <- ordered_sequence("a", "b", keys = c(2, 1))
max_key(x)
max_key(ordered_sequence())

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