package goblint

  1. Overview
  2. Docs
package goblint
Legend:
Library
Module
Module type
Parameter
Class
Class type

Map of keys E.t grouped into buckets by R, where each bucket is described by the map B with values V.t.

Common choice for B is MapDomain.Joined.

Handles Lattice.BotValue from B.

Parameters

module E : Printable.S
module V : Printable.S
module B : MapDomain.S with type key = E.t and type value = V.t
module R : Representative with type elt = E.t

Signature

include MapDomain.PS with type key = E.t with type value = B.value
include Printable.S
type t
type key = E.t

The type of the map keys.

type value = B.value

The type of the values.

val add : key -> value -> t -> t
val remove : key -> t -> t
val find : key -> t -> value
val find_opt : key -> t -> value option
val mem : key -> t -> bool
val iter : (key -> value -> unit) -> t -> unit
val map : (value -> value) -> t -> t
val filter : (key -> value -> bool) -> t -> t
val mapi : (key -> value -> value) -> t -> t
val fold : (key -> value -> 'a -> 'a) -> t -> 'a -> 'a
val add_list : (key * value) list -> t -> t
val add_list_set : key list -> value -> t -> t
val add_list_fun : key list -> (key -> value) -> t -> t
val for_all : (key -> value -> bool) -> t -> bool
val map2 : (value -> value -> value) -> t -> t -> t
val long_map2 : (value -> value -> value) -> t -> t -> t
val merge : (key -> value option -> value option -> value option) -> t -> t -> t
val cardinal : t -> int
val choose : t -> key * value
val singleton : key -> value -> t
val empty : unit -> t
val is_empty : t -> bool
val exists : (key -> value -> bool) -> t -> bool
val bindings : t -> (key * value) list
include Lattice.S with type t := t
include Lattice.PO with type t := t
include Printable.S with type t := t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val show : t -> string
val pretty : unit -> t -> GoblintCil.Pretty.doc
val printXml : 'a BatInnerIO.output -> t -> unit
val name : unit -> string
val to_yojson : t -> Yojson.Safe.t
val tag : t -> int

Unique ID, given by HConsed, for context identification in witness

val arbitrary : unit -> t QCheck.arbitrary
val relift : t -> t
val leq : t -> t -> bool
val join : t -> t -> t
val meet : t -> t -> t
val widen : t -> t -> t

widen x y assumes leq x y. Solvers guarantee this by calling widen old (join old new).

val narrow : t -> t -> t
val pretty_diff : unit -> (t * t) -> GoblintCil.Pretty.doc

If leq x y = false, then pretty_diff () (x, y) should explain why.

val bot : unit -> t
val is_bot : t -> bool
val top : unit -> t
val is_top : t -> bool
val widen_with_fct : (value -> value -> value) -> t -> t -> t
val join_with_fct : (value -> value -> value) -> t -> t -> t
val leq_with_fct : (value -> value -> bool) -> t -> t -> bool
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