Carbonated_map.MakeA functor for building gas metered maps. When building a gas metered map via Make(G)(C), C is a COMPARABLE required to construct a the map while G is a module providing the gas consuming functions. The type of the context on which the gas consuming function operates is determined by G.context.
module C : COMPARABLEtype key = C.tThe type of keys in the map.
type context = G.contextThe type used for the context.
val empty : 'a tempty an empty map.
val size : 'a t -> intsize m returns the number of elements of the map m in constant time.
val find :
context ->
key ->
'a t ->
('a option * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultfind ctxt k m looks up the value with key k in the given map m and also consumes the gas associated with the lookup. The complexity is logarithmic in the size of the map.
val update :
context ->
key ->
(context ->
'a option ->
('a option * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult) ->
'a t ->
('a t * context) Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultupdate ctxt k f map updates or adds the value of the key k using f. The function accounts for the gas cost for finding the element. The updating function f should also account for its own gas cost. The complexity is logarithmic in the size of the map.
val to_list :
context ->
'a t ->
((key * 'a) list * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultto_list m transforms a map m into a list. It also accounts for the gas cost for traversing the elements. The complexity is linear in the size of the map.
val of_list :
context ->
merge_overlap:
(context ->
'a ->
'a ->
('a * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult) ->
(key * 'a) list ->
('a t * context) Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultof_list ctxt ~merge_overlaps m creates a map from a list of key-value pairs. In case there are overlapping keys, their values are combined using the merge_overlap function. The function accounts for gas for traversing the elements. merge_overlap should account for its own gas cost. The complexity is n * log n in the size of the list.
val merge :
context ->
merge_overlap:
(context ->
'a ->
'a ->
('a * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult) ->
'a t ->
'a t ->
('a t * context) Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultmerge ctxt ~merge_overlap m1 m2 merges the maps m1 and m2. In case there are overlapping keys, their values are combined using the merge_overlap function. Gas costs for traversing all elements from both maps are accounted for. merge_overlap should account for its own gas cost. The complexity is n * log n, where n is size m1 + size m2.
val map_e :
context ->
(context ->
key ->
'a ->
('b * context) Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult) ->
'a t ->
('b t * context) Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultmap_e ctxt f m maps over all key-value pairs in the map m using the function f. It accounts for gas costs associated with traversing the elements. The mapping function f should also account for its own gas cost. The complexity is linear in the size of the map m.
val fold_e :
context ->
(context ->
'state ->
key ->
'value ->
('state * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult) ->
'state ->
'value t ->
('state * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresultfold_e ctxt f z m folds over the key-value pairs of the given map m, accumulating values using f, with z as the initial state. The function f must account for its own gas cost. The complexity is linear in the size of the map m.
val fold_es :
context ->
(context ->
'state ->
key ->
'value ->
('state * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
Mavryk_protocol_environment_001_PtAtLas.Lwt.t) ->
'state ->
'value t ->
('state * context)
Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult
Mavryk_protocol_environment_001_PtAtLas.Lwt.tLwt-aware variant of fold_e.