package frama-c
Install
Dune Dependency
Authors
-
MMichele Alberti
-
TThibaud Antignac
-
GGergö Barany
-
PPatrick Baudin
-
NNicolas Bellec
-
TThibaut Benjamin
-
AAllan Blanchard
-
LLionel Blatter
-
FFrançois Bobot
-
RRichard Bonichon
-
VVincent Botbol
-
QQuentin Bouillaguet
-
DDavid Bühler
-
ZZakaria Chihani
-
LLoïc Correnson
-
JJulien Crétin
-
PPascal Cuoq
-
ZZaynah Dargaye
-
BBasile Desloges
-
JJean-Christophe Filliâtre
-
PPhilippe Herrmann
-
MMaxime Jacquemin
-
FFlorent Kirchner
-
AAlexander Kogtenkov
-
RRemi Lazarini
-
TTristan Le Gall
-
JJean-Christophe Léchenet
-
MMatthieu Lemerre
-
DDara Ly
-
DDavid Maison
-
CClaude Marché
-
AAndré Maroneze
-
TThibault Martin
-
FFonenantsoa Maurica
-
MMelody Méaulle
-
BBenjamin Monate
-
YYannick Moy
-
PPierre Nigron
-
AAnne Pacalet
-
VValentin Perrelle
-
GGuillaume Petiot
-
DDario Pinto
-
VVirgile Prevosto
-
AArmand Puccetti
-
FFélix Ridoux
-
VVirgile Robles
-
JJan Rochel
-
MMuriel Roger
-
JJulien Signoles
-
NNicolas Stouls
-
KKostyantyn Vorobyov
-
BBoris Yakobowski
Maintainers
Sources
sha256=d2fbb3b8d0ff83945872e9e6fa258e934a706360e698dae3b4d5f971addf7493
doc/frama-c.kernel/Frama_c_kernel/Locations/Zone/Set/index.html
Module Zone.Set
include Set.S with type elt = t
Sets
type elt = t
The type of the set elements.
val empty : t
The empty set.
add x s
returns a set containing all elements of s
, plus x
. If x
was already in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
remove x s
returns a set containing all elements of s
, except x
. If x
was not in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
val cardinal : t -> int
Return the number of elements of a set.
Elements
Return the list of all elements of the given set. The returned list is sorted in increasing order with respect to the ordering Ord.compare
, where Ord
is the argument given to Set.Make
.
Return the smallest element of the given set (with respect to the Ord.compare
ordering), or raise Not_found
if the set is empty.
Return the smallest element of the given set (with respect to the Ord.compare
ordering), or None
if the set is empty.
Same as min_elt_opt
, but returns the largest element of the given set.
Return one element of the given set, or raise Not_found
if the set is empty. Which element is chosen is unspecified, but equal elements will be chosen for equal sets.
Return one element of the given set, or None
if the set is empty. Which element is chosen is unspecified, but equal elements will be chosen for equal sets.
Searching
find x s
returns the element of s
equal to x
(according to Ord.compare
), or raise Not_found
if no such element exists.
find_opt x s
returns the element of s
equal to x
(according to Ord.compare
), or None
if no such element exists.
find_first f s
, where f
is a monotonically increasing function, returns the lowest element e
of s
such that f e
, or raises Not_found
if no such element exists.
For example, find_first (fun e -> Ord.compare e x >= 0) s
will return the first element e
of s
where Ord.compare e x >= 0
(intuitively: e >= x
), or raise Not_found
if x
is greater than any element of s
.
find_first_opt f s
, where f
is a monotonically increasing function, returns an option containing the lowest element e
of s
such that f e
, or None
if no such element exists.
find_last f s
, where f
is a monotonically decreasing function, returns the highest element e
of s
such that f e
, or raises Not_found
if no such element exists.
find_last_opt f s
, where f
is a monotonically decreasing function, returns an option containing the highest element e
of s
such that f e
, or None
if no such element exists.
Traversing
iter f s
applies f
in turn to all elements of s
. The elements of s
are presented to f
in increasing order with respect to the ordering over the type of the elements.
fold f s init
computes (f xN ... (f x2 (f x1 init))...)
, where x1 ... xN
are the elements of s
, in increasing order.
Transforming
map f s
is the set whose elements are f a0
,f a1
... f aN
, where a0
,a1
...aN
are the elements of s
.
The elements are passed to f
in increasing order with respect to the ordering over the type of the elements.
If no element of s
is changed by f
, s
is returned unchanged. (If each output of f
is physically equal to its input, the returned set is physically equal to s
.)
filter f s
returns the set of all elements in s
that satisfy predicate f
. If f
satisfies every element in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
filter_map f s
returns the set of all v
such that f x = Some v
for some element x
of s
.
For example,
filter_map (fun n -> if n mod 2 = 0 then Some (n / 2) else None) s
is the set of halves of the even elements of s
.
If no element of s
is changed or dropped by f
(if f x = Some x
for each element x
), then s
is returned unchanged: the result of the function is then physically equal to s
.
partition f s
returns a pair of sets (s1, s2)
, where s1
is the set of all the elements of s
that satisfy the predicate f
, and s2
is the set of all the elements of s
that do not satisfy f
.
split x s
returns a triple (l, present, r)
, where l
is the set of elements of s
that are strictly less than x
; r
is the set of elements of s
that are strictly greater than x
; present
is false
if s
contains no element equal to x
, or true
if s
contains an element equal to x
.
Predicates and comparisons
val is_empty : t -> bool
Test whether a set is empty or not.
for_all f s
checks if all elements of the set satisfy the predicate f
.
exists f s
checks if at least one element of the set satisfies the predicate f
.
Converting
of_list l
creates a set from a list of elements. This is usually more efficient than folding add
over the list, except perhaps for lists with many duplicated elements.
to_seq_from x s
iterates on a subset of the elements of s
in ascending order, from x
or above.
include Datatype.S with type t := t
include Datatype.S_no_copy with type t := t
include Datatype.Ty with type t := t
val packed_descr : Structural_descr.pack
Packed version of the descriptor.
val reprs : t list
List of representants of the descriptor.
val hash : t -> int
Hash function: same spec than Hashtbl.hash
.
val pretty : Format.formatter -> t -> unit
Pretty print each value in an user-friendly way.
val mem_project : (Project_skeleton.t -> bool) -> t -> bool
mem_project f x
must return true
iff there is a value p
of type Project.t
in x
such that f p
returns true
.