package tezos-protocol-014-PtKathma

  1. Overview
  2. Docs
package tezos-protocol-014-PtKathma
Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions to ease the manipulation of Michelson maps.

A map in Michelson is a type-homegeneous, partial function of keys to values, along with the functions that operate on the structure (through a first-class module).

val make : (module Script_typed_ir.Boxed_map with type key = 'key and type value = 'value) -> ('key, 'value) Script_typed_ir.map
val get_module : ('key, 'value) Script_typed_ir.map -> (module Script_typed_ir.Boxed_map with type key = 'key and type value = 'value)

empty cmp_ty creates a map module where keys have size Gas_comparable_input_size.size_of_comparable_value cmp_ty and are compared with Script_comparable.compare_comparable cmp_ty (used for sorting keys, which ensures a reasonable complexity of the map functions). The function returns an empty map packaged as a first-class map module.

val empty_from : ('a, 'b) Script_typed_ir.map -> ('a, 'c) Script_typed_ir.map

empty_from map creates an empty map module where the size of keys and the comparison function are those of map.

val fold : ('key -> 'value -> 'acc -> 'acc) -> ('key, 'value) Script_typed_ir.map -> 'acc -> 'acc
val update : 'a -> 'b option -> ('a, 'b) Script_typed_ir.map -> ('a, 'b) Script_typed_ir.map

update k (Some v) map associates v to k in map (overwriting the previous value, if any), and update k None map removes the potential association to k in map.

val mem : 'key -> ('key, 'value) Script_typed_ir.map -> bool
val get : 'key -> ('key, 'value) Script_typed_ir.map -> 'value option
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct