insert: Insert an Element

In Immutables: Fast and Functional Data Structures

Insert an Element

Description

Inserts an element into a structure-specific position according to class semantics.

Usage

insert(x, ...)

Arguments

x	Object to insert into.
...	Method-specific arguments.

Details

insert() is an S3 generic. Required arguments in ... depend on x:

• priority_queue: element, priority (optional name)

• ordered_sequence: element, key (optional name)

• interval_index: element, start, end (optional name)

This operation is persistent: x is not modified.

Value

Updated object of the same class as x.

See Also

priority_queue(), ordered_sequence(), interval_index(), insert_at()

Examples

q <- priority_queue("a", "b", priorities = c(2, 1))
insert(q, "c", priority = 3)

o <- ordered_sequence("a", "c", keys = c(1, 3))
insert(o, "b", key = 2)

iv <- interval_index("A", "B", start = c(1, 5), end = c(3, 8))
insert(iv, "C", start = 2, end = 6)

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