package incr_map

You can search for identifiers within the package.

in-package search v0.2.0

package incr_map

incr_map
- Library incr_map
  - Incr_map
    
    Instrumentation
    
    Lookup
    
    M
    
    For_debug
    
    For_testing
    
    S_gen
    
    Incr
    
    Cutoff
    
    Instrumentation
    
    Lookup
    
    M
    
    For_debug
    
    For_testing
    
    S
    
    Incr
    
    Cutoff
    
    Instrumentation
    
    Lookup
    
    M
    
    For_debug
    
    For_testing
    
    Make
    
    Instrumentation
    
    Lookup
    
    M
    
    For_debug
    
    For_testing
- Library incr_map.collate
  - Incr_map_collate
    
    Collate
    
    Which_range
    
    Fields
    
    Direct
    
    Collated
    
    Private
    
    For_testing
    
    Concrete
    
    Key
    
    Value
    
    Update
    
    Diff
    
    Intermediate
    
    Part
    
    Make_concrete
    
    Key
    
    Value
    
    Update
    
    Diff
    
    Intermediate
    
    Part
    
    Map_list
    
    Store_params
    
    Compare
    
    Fold
    
    With_caching
    
    Range_memoize_bucket
    
    Replace_polymorphic_compare
    
    Map
    
    Key
    
    Provide_of_sexp
    
    Provide_bin_io
    
    Provide_hash
    
    Set
    
    Elt
    
    Provide_of_sexp
    
    Provide_bin_io
    
    Provide_hash
- Library incr_map.erase_key
  - Incr_map_erase_key
    
    Key
    
    Replace_polymorphic_compare
    
    Map
    
    Key
    
    Provide_of_sexp
    
    Provide_bin_io
    
    Provide_hash
    
    Set
    
    Elt
    
    Provide_of_sexp
    
    Provide_bin_io
    
    Provide_hash
    
    Stable
    
    V1
    
    For_testing
- Sources
  - incr_map
    
    incr_map.ml
    
    incr_map__.ml
    
    incr_map_intf.ml
  - incr_map.collate
    
    collate.ml
    
    collated.ml
    
    collated_intf.ml
    
    incr_map_collate.ml
    
    incr_map_collate__.ml
  - incr_map.erase_key
    
    incr_map_erase_key.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Incr_map_collate`Source

Sourcemodule Collate : sig ... end

Sourcemodule Collated : sig ... end

Sourcemodule Map_list = Incr_map_erase_key

Sourcemodule Store_params = Incr_memoize.Store_params

Sourcemodule Compare : sig ... end

Sourcemodule Fold : sig ... end

Source

val collate : 
  ?operation_order:[ `Filter_first | `Sort_first ] ->
  filter_equal:('filter -> 'filter -> bool) ->
  order_equal:('order -> 'order -> bool) ->
  filter_to_predicate:('filter -> (key:'k -> data:'v -> bool) option) ->
  order_to_compare:('order -> ('k, 'v, 'cmp) Compare.t) ->
  (('k, 'v, 'cmp) Core.Map.t, 'w) Incremental.t ->
  (('k, 'filter, 'order) Collate.t, 'w) Incremental.t ->
  (('k, 'v) Collated.t, 'w) Incremental.t

Perform filtering, sorting and restricting to ranges.

The Collate.t Incr.t contains the parameters for filtering and sorting, and ranges. It can be updated incrementally, but note that filtering & sorting isn't really incremental on filter & order since we bind to these.

For sorting & filtering, technically all this function should need is a compare function and a filtering predicate. However, the interface is slightly different: we require users to provide 'filter and 'order opaque types in Collate.t, and ways to convert them to predicate & compare here.

It is done this way for better interaction with Incr. We belive that most users would have such types, being simple algebraic data types, anyways. You can always set e.g. filter_to_predicate=Fn.id, and just pass the functions directly, but be prepared to explore the fascinating world of functions' physical equality.

Source

val collate_and_fold : 
  ?operation_order:[ `Filter_first | `Sort_first ] ->
  filter_equal:('filter -> 'filter -> bool) ->
  order_equal:('order -> 'order -> bool) ->
  filter_to_predicate:('filter -> (key:'k -> data:'v -> bool) option) ->
  order_to_compare:('order -> ('k, 'v, 'cmp) Compare.t) ->
  fold:('k, 'v, 'fold_result) Fold.t ->
  (('k, 'v, 'cmp) Core.Map.t, 'w) Incremental.t ->
  (('k, 'filter, 'order) Collate.t, 'w) Incremental.t ->
  (('k, 'v) Collated.t, 'w) Incremental.t * ('fold_result, 'w) Incremental.t

Sourcemodule With_caching : sig ... end

A version of collate with caching.

package incr_map

Module Incr_map_collateSource

Module `Incr_map_collate`Source