package incr_map

You can search for identifiers within the package.

in-package search v0.2.0

Helpers for incremental operations on map like data structures

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.0.tar.gz

sha256=91acc784e4760af8544c4504bee1a9f6d7385eb0620f8e56392cd193a250b7d2

doc/incr_map.erase_key/Opaque_map/index.html

Module `Opaque_map`Source

Sourcemodule Key : sig ... end

Sourcetype 'a t = (Key.t, 'a, Key.comparator_witness) Core.Map.t

include Sexplib0.Sexpable.S1 with type 'a t := 'a t

Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

include Ppx_compare_lib.Comparable.S1 with type 'a t := 'a t

Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

include Ppx_compare_lib.Equal.S1 with type 'a t := 'a t

Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

include Core.Bin_prot.Binable.S1 with type 'a t := 'a t

Sourceval bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t

Sourceval bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1

Sourceval bin_write_t : ('a, 'a t) Bin_prot.Write.writer1

Sourceval bin_read_t : ('a, 'a t) Bin_prot.Read.reader1

Sourceval __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1

Sourceval bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer

Sourceval bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader

Sourceval bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t

include Diffable.S1 with type 'a t := 'a t

Sourcemodule Diff : sig ... end

Source

val erase_key_incrementally : 
  ?data_equal:('data -> 'data -> bool) ->
  (('key, 'data, _) Core.Map.t, 'w) Incremental.t ->
  get:(key:'key -> data:'data -> 'a) ->
  ('a t, 'w) Incremental.t

When Opaque_maps are created incrementally we can be smart about insertion and get good performance around insertion and rebalancing.

empty, of_list, and of_array won't give you nice incrementality like erase_key_incrementally, but they are still fine if the primary goal is using the type itself outside of an incremental context.

But if possible, consider erase_key_incrementally.

Sourceval empty : _ t

Sourceval of_list : 'a list -> 'a t

Sourceval of_array : 'a array -> 'a t

Sourcemodule Stable : sig ... end