Frama-C:
Plug-ins:
Libraries:

Frama-C API - Bottom

include Monad.S_with_product with type 'a t = 'a or_bottom
type 'a t = 'a or_bottom
val return : 'a -> 'a t
val flatten : 'a t t -> 'a t
val map : ('a -> 'b) -> 'a t -> 'b t
val bind : ('a -> 'b t) -> 'a t -> 'b t
val product : 'a t -> 'b t -> ('a * 'b) t
module Bool : sig ... end
module Option : sig ... end
module List : sig ... end
module Operators : sig ... end

Datatype constructor

Bounds a semi-lattice

val is_bottom : 'a t -> bool

Access

val non_bottom : 'a t -> 'a
val value : bottom:'a -> 'a t -> 'a
val hash : ('a -> int) -> 'a t -> int

Datatype

val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val pretty_bottom : Stdlib.Format.formatter -> unit

Pretty-printing

val pretty : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a t -> unit
val is_included : ('a -> 'b -> bool) -> 'a t -> 'b t -> bool

Lattice operators

val join : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val narrow : ('a -> 'a -> 'a t) -> 'a t -> 'a t -> 'a t
val join_list : ('a -> 'a -> 'a) -> 'a t list -> 'a t
val iter : ('a -> unit) -> 'a t -> unit

Iterator.

In a lattice where the elements are lists of non-bottom values, the empty list is the bottom case.

val to_option : 'a t -> 'a option

Conversion from Bottom to None.

val of_option : 'a option -> 'a t
val of_list : join:('a -> 'a -> 'a) -> 'a list -> 'a t

Joins all elements of a list. Returns Bottom if the list is empty.

val to_list : 'a t -> 'a list

Returns an empty list on Bottom, and a list of one element otherwise.

val list_values : 'a t list -> 'a list

Filters the given list to remove Bottom elements.

val list_filter_map : ('a -> 'b t) -> 'a list -> 'b list

list_filter_map f l maps the function f to the list l and does not keep bottoms.

val add_to_list : 'a t -> 'a list -> 'a list

add_to_list elt list adds elt to the list if it is not bottom.