API for Immutables
Fast and Functional Data Structures

Global functions
$.flexseq Man page
$.interval_index Man page
$.ordered_sequence Man page
$.priority_queue Man page
$<-.flexseq Man page
$<-.interval_index Man page
$<-.ordered_sequence Man page
$<-.priority_queue Man page
.as_flexseq Source code
.as_flexseq_build Source code
.as_flexseq_build.default Source code
.as_interval_index Source code
.as_interval_index_build Source code
.as_ordered_sequence Source code
.as_priority_queue Source code
.as_priority_queue_build Source code
.flexseq_input_list Source code
.ft_assert_chr_indices Source code
.ft_assert_int_indices Source code
.ft_assert_lgl_indices Source code
.ft_assert_name_state Source code
.ft_child_size Source code
.ft_coerce_insert_values Source code
.ft_collect_names Source code
.ft_concat_same_monoids Source code
.ft_cpp_add_left Source code
.ft_cpp_add_left_named Source code
.ft_cpp_add_right Source code
.ft_cpp_add_right_named Source code
.ft_cpp_can_use Source code
.ft_cpp_can_use_oms_insert Source code
.ft_cpp_concat Source code
.ft_cpp_eligible_monoids Source code
.ft_cpp_enabled Source code
.ft_cpp_find_name_position Source code
.ft_cpp_get_by_index Source code
.ft_cpp_get_many_by_index Source code
.ft_cpp_locate Source code
.ft_cpp_name_positions Source code
.ft_cpp_oms_insert Source code
.ft_cpp_split_at_index Source code
.ft_cpp_split_tree Source code
.ft_cpp_tree_from Source code
.ft_cpp_tree_from_prepared Source code
.ft_cpp_tree_from_sorted Source code
.ft_custom_monoid_names Source code
.ft_dollar_name Source code
.ft_effective_name Source code
.ft_empty_same_type Source code
.ft_find_name_position Source code
.ft_find_name_position_impl Source code
.ft_format_measure Source code
.ft_format_scalar Source code
.ft_fun_accepts_n_positional Source code
.ft_get_elem_at Source code
.ft_get_elems_at Source code
.ft_get_name Source code
.ft_get_name_fast Source code
.ft_has_name Source code
.ft_match_name_indices Source code
.ft_name_from_value Source code
.ft_name_map_threshold Source code
.ft_name_positions Source code
.ft_name_positions_fast Source code
.ft_named_count Source code
.ft_normalize_name Source code
.ft_normalize_scalar_orderable Source code
.ft_ordered_owner_class Source code
.ft_prepare_subset_entries Source code
.ft_print_custom_monoids Source code
.ft_print_elem_at Source code
.ft_print_elem_custom_monoids Source code
.ft_print_skipped Source code
.ft_push_back_dispatch Source code
.ft_push_back_impl Source code
.ft_push_back_named_dispatch Source code
.ft_push_back_raw Source code
.ft_push_front_dispatch Source code
.ft_push_front_named_dispatch Source code
.ft_recycle_values Source code
.ft_restore_subclass Source code
.ft_scalar_compare Source code
.ft_scalar_compare_fast Source code
.ft_scalar_domain Source code
.ft_scalar_equal_fast Source code
.ft_scalar_is_fast_domain Source code
.ft_set_name Source code
.ft_set_name_fast Source code
.ft_size Source code
.ft_stop_ordered_like Source code
.ft_strip_name Source code
.ft_to_list Source code
.ft_to_list_fill Source code
.ft_tree_from_list_linear Source code
.ft_tree_from_ordered_ref Source code
.ft_true_positions Source code
.ft_unwrap_public_value Source code
.ft_update_name_map Source code
.ft_validate_drop_meta Source code
.ft_validate_insert_name_state Source code
.ft_validate_print_max_elements Source code
.ft_validate_scalar_insert_position Source code
.ft_validate_scalar_position Source code
.ft_validate_scalar_position_missable Source code
.ft_validate_show_custom_monoids Source code
.ft_values_have_name_hints Source code
.get_measure_validate Source code
.ivx_apply_impl Source code
.ivx_assert_index Source code
.ivx_bound_index_prepared Source code
.ivx_bounds_flags Source code
.ivx_bounds_phrase Source code
.ivx_build_from_items Source code
.ivx_choose_max_end Source code
.ivx_choose_max_start Source code
.ivx_choose_min_end Source code
.ivx_collect_query Source code
.ivx_compare_scalar Source code
.ivx_compare_scalar_fast Source code
.ivx_concat3_like Source code
.ivx_contains_interval Source code
.ivx_contains_point Source code
.ivx_empty_like Source code
.ivx_endpoint_type Source code
.ivx_endpoint_type_state Source code
.ivx_entries Source code
.ivx_insert_entry Source code
.ivx_is_fast_endpoint_type Source code
.ivx_is_structural_fast Source code
.ivx_make_entry Source code
.ivx_max_end_monoid Source code
.ivx_max_start_monoid Source code
.ivx_merge_monoids Source code
.ivx_merge_sort_indices Source code
.ivx_min_end_monoid Source code
.ivx_normalize_bounds Source code
.ivx_normalize_endpoint Source code
.ivx_normalize_interval Source code
.ivx_order_entries Source code
.ivx_overlaps_interval Source code
.ivx_parse_entry Source code
.ivx_partition_span Source code
.ivx_pop_positions Source code
.ivx_prepare_entry_names Source code
.ivx_query_candidate_span Source code
.ivx_query_peek_miss Source code
.ivx_query_pop_miss Source code
.ivx_remove_positions Source code
.ivx_resolve_bounds Source code
.ivx_restore_tree Source code
.ivx_run_relation_query Source code
.ivx_slice_entries Source code
.ivx_slice_positions Source code
.ivx_spec_containing Source code
.ivx_spec_overlaps Source code
.ivx_spec_point Source code
.ivx_spec_point_either Source code
.ivx_spec_point_end Source code
.ivx_spec_point_interval Source code
.ivx_spec_point_start Source code
.ivx_spec_within Source code
.ivx_split_at_index Source code
.ivx_subtree_size Source code
.ivx_supports_oms_key_type Source code
.ivx_tree_from_ordered_entries Source code
.ivx_wrap_like Source code
.measure_child_named_fast Source code
.normalize_measure_monoid_spec Source code
.oms_apply_impl Source code
.oms_assert_set Source code
.oms_bound_index Source code
.oms_bound_index_prepared Source code
.oms_build_from_items Source code
.oms_choose_max_key Source code
.oms_coerce_lgl_scalar Source code
.oms_compare_key Source code
.oms_empty_tree_like Source code
.oms_extract_items Source code
.oms_insert_impl Source code
.oms_is_cpp_key_type Source code
.oms_key_span Source code
.oms_key_type Source code
.oms_key_type_state Source code
.oms_make_entry Source code
.oms_merge_monoids Source code
.oms_merge_sort_indices Source code
.oms_normalize_key Source code
.oms_order_entries Source code
.oms_prepare_entry_names Source code
.oms_range_end_exclusive_index Source code
.oms_range_start_index Source code
.oms_required_monoids Source code
.oms_slice_key_span Source code
.oms_stop_interval_index Source code
.oms_tree_from_ordered_entries Source code
.oms_validate_insert_name_state Source code
.oms_validate_key_type Source code
.ord_normalize_selector_positions Source code
.ord_wrap_like Source code
.pick_preview_sizes Source code
.pq_append_entry Source code
.pq_apply_impl Source code
.pq_assert_queue Source code
.pq_choose_max Source code
.pq_choose_min Source code
.pq_empty_like Source code
.pq_extract Source code
.pq_extract_all Source code
.pq_extract_entry Source code
.pq_extreme_positions Source code
.pq_make_entry Source code
.pq_measure_equal Source code
.pq_merge_monoids Source code
.pq_peek Source code
.pq_peek_all Source code
.pq_priority_type_state Source code
.pq_remove_positions Source code
.pq_required_monoids Source code
.pq_resolve_priority Source code
.pq_slice_positions Source code
.pq_wrap_like Source code
.priority_queue_build Source code
.register_rounded_rect_shape Source code
.roundrect_path Source code
.seq_apply_impl Source code
Deep Source code
Digit Source code
Empty Source code
FingerTree Source code
Immutables Man page
Immutables-package Man page
Node Source code
Node2 Source code
Node3 Source code
Single Source code
[.flexseq Man page
[.interval_index Man page
[.ordered_sequence Man page
[.priority_queue Man page
[<-.flexseq Man page
[<-.interval_index Man page
[<-.ordered_sequence Man page
[<-.priority_queue Man page
[[.flexseq Man page
[[.interval_index Man page
[[.ordered_sequence Man page
[[.priority_queue Man page
[[<-.flexseq Man page
[[<-.interval_index Man page
[[<-.ordered_sequence Man page
[[<-.priority_queue Man page
`$.flexseq` Source code
`$.interval_index` Source code
`$.ordered_sequence` Source code
`$.priority_queue` Source code
`$<-.flexseq` Source code
`$<-.interval_index` Source code
`$<-.ordered_sequence` Source code
`$<-.priority_queue` Source code
`[.flexseq` Source code
`[.interval_index` Source code
`[.ordered_sequence` Source code
`[.priority_queue` Source code
`[<-.flexseq` Source code
`[<-.interval_index` Source code
`[<-.ordered_sequence` Source code
`[<-.priority_queue` Source code
`[[.flexseq` Source code
`[[.interval_index` Source code
`[[.ordered_sequence` Source code
`[[.priority_queue` Source code
`[[<-.flexseq` Source code
`[[<-.interval_index` Source code
`[[<-.ordered_sequence` Source code
`[[<-.priority_queue` Source code
add_all_left Source code
add_all_right Source code
add_left Source code
add_monoids Man page Source code
add_monoids.default Source code
add_monoids.flexseq Source code
add_monoids.interval_index Source code
add_monoids.ordered_sequence Source code
add_monoids.priority_queue Source code
add_right Source code
app3 Source code
as.list.flexseq Man page Source code
as.list.interval_index Man page Source code
as.list.ordered_sequence Man page Source code
as.list.priority_queue Man page Source code
as_flexseq Man page Source code
as_flexseq.default Source code
as_flexseq.flexseq Source code
as_flexseq.interval_index Source code
as_flexseq.ordered_sequence Source code
as_flexseq.priority_queue Source code
as_interval_index Man page Source code
as_iterator.flexseq Man page Source code
as_iterator.priority_queue Man page Source code
as_ordered_sequence Man page Source code
as_priority_queue Man page Source code
assert_has_monoids Source code
assert_measures_match_monoids Source code
assert_structural_attrs Source code
build_deep Source code
build_digit Source code
c.flexseq Man page Source code
c.ordered_sequence Source code
c.priority_queue Source code
combine_measures Source code
concat Source code
concat_trees Man page Source code
count_between Man page Source code
count_key Man page Source code
deepL Source code
deepR Source code
digit_to_tree Source code
elements_between Man page Source code
empty_tree Man page Source code
ensure_size_monoids Source code
fapply Man page Source code
fapply.flexseq Source code
fapply.interval_index Source code
fapply.ordered_sequence Source code
fapply.priority_queue Source code
flexseq Man page Source code
get_graph_df Man page Source code
get_measure Man page Source code
get_measures Man page Source code
insert Man page Source code
insert.default Source code
insert.interval_index Source code
insert.ordered_sequence Source code
insert.priority_queue Source code
insert_at Man page Source code
interval_index Man page Source code
is_measure_monoid Source code
is_measure_monoid_list Source code
is_structural_node Source code
length.flexseq Man page Source code
length.interval_index Man page Source code
length.ordered_sequence Man page Source code
length.priority_queue Man page Source code
locate_by_predicate Man page Source code
locate_by_predicate.flexseq Source code
locate_child_measure Source code
locate_child_size Source code
locate_digit Source code
locate_digit_impl Source code
locate_sequence_measure Source code
locate_tree_impl Source code
locate_tree_impl_fast Source code
loop Man page
lower_bound Man page Source code
max_endpoint Man page Source code
max_key Man page Source code
max_priority Man page Source code
measure_child_named_impl Source code
measure_children Source code
measure_monoid Man page Source code
measured_deep Source code
measured_digit Source code
measured_empty Source code
measured_node2 Source code
measured_node3 Source code
measured_nodes Source code
measured_single Source code
merge.flexseq Man page Source code
merge.interval_index Man page Source code
merge.ordered_sequence Man page Source code
merge.priority_queue Man page Source code
merge_monoid_sets Source code
min_endpoint Man page Source code
min_key Man page Source code
min_priority Man page Source code
named_count_measure_monoid Source code
node_measure Source code
node_to_digit Source code
oms_max_key_monoid Source code
ordered_sequence Man page Source code
peek_all_containing Man page Source code
peek_all_key Man page Source code
peek_all_max Man page Source code
peek_all_min Man page Source code
peek_all_overlaps Man page Source code
peek_all_point Man page Source code
peek_all_within Man page Source code
peek_at Man page Source code
peek_back Man page Source code
peek_containing Man page Source code
peek_front Man page Source code
peek_key Man page Source code
peek_max Man page Source code
peek_min Man page Source code
peek_overlaps Man page Source code
peek_point Man page Source code
peek_within Man page Source code
plot_structure Man page Source code
pop_all_containing Man page Source code
pop_all_key Man page Source code
pop_all_max Man page Source code
pop_all_min Man page Source code
pop_all_overlaps Man page Source code
pop_all_point Man page Source code
pop_all_within Man page Source code
pop_at Man page Source code
pop_back Man page Source code
pop_containing Man page Source code
pop_front Man page Source code
pop_key Man page Source code
pop_max Man page Source code
pop_min Man page Source code
pop_overlaps Man page Source code
pop_point Man page Source code
pop_within Man page Source code
pq_max_measure_monoid Source code
pq_min_measure_monoid Source code
print.Deep Man page Source code
print.Empty Man page Source code
print.FingerTree Man page Source code
print.Single Man page Source code
print.flexseq Man page Source code
print.interval_index Man page Source code
print.ordered_sequence Man page Source code
print.priority_queue Man page Source code
priority_queue Man page Source code
push_back Man page Source code
push_front Man page Source code
rebind_tree_monoids Source code
resolve_named_monoid Source code
resolve_tree_monoids Source code
set_measure Source code
set_measure_with_reuse Source code
size_measure_monoid Source code
split_around_by_predicate Man page Source code
split_around_by_predicate.flexseq Source code
split_around_by_predicate.priority_queue Source code
split_at Man page Source code
split_at.flexseq Source code
split_at.priority_queue Source code
split_by_predicate Man page Source code
split_by_predicate.flexseq Source code
split_by_predicate.priority_queue Source code
split_digit Source code
split_digit_impl Source code
split_tree_impl Source code
split_tree_impl_fast Source code
str.flexseq Man page Source code
sub-.interval_index Man page
sub-.ordered_sequence Man page
sub-.priority_queue Man page
tree_from Man page Source code
unlist.flexseq Man page Source code
upper_bound Man page Source code
validate_name_state Man page Source code
validate_tree Man page Source code
viewL Source code
viewR Source code
with_tree_monoids Source code
Immutables documentation built on April 29, 2026, 1:06 a.m.