Skip to content
Snippets Groups Projects
Commit 4c486b4d authored by David Bühler's avatar David Bühler Committed by Valentin Perrelle
Browse files

[Eva] Slightly improves the documentation of [to_seq] functions.

parent 5f9b1805
No related branches found
No related tags found
No related merge requests found
...@@ -191,7 +191,8 @@ val complement_under: size:int -> signed:bool -> t -> t or_bottom ...@@ -191,7 +191,8 @@ val complement_under: size:int -> signed:bool -> t -> t or_bottom
val fold_int: ?increasing:bool -> (Integer.t -> 'a -> 'a) -> t -> 'a -> 'a val fold_int: ?increasing:bool -> (Integer.t -> 'a -> 'a) -> t -> 'a -> 'a
(** Builds a sequence of all integers represented by an abstraction, in (** Builds a sequence of all integers represented by an abstraction, in
increasing order (resp. decreasing order if [increasing is set to false]) increasing order (resp. decreasing order if [increasing] is set to false).
The sequence might be infinite.
@raise Abstract_interp.Error_Top if the abstraction has no lower bound @raise Abstract_interp.Error_Top if the abstraction has no lower bound
(resp. no upper bound) *) (or no upper bound in decreasing order). *)
val to_seq: ?increasing:bool -> t -> Integer.t Seq.t val to_seq: ?increasing:bool -> t -> Integer.t Seq.t
...@@ -216,9 +216,10 @@ val fold_int_bounds: (t -> 'a -> 'a) -> t -> 'a -> 'a ...@@ -216,9 +216,10 @@ val fold_int_bounds: (t -> 'a -> 'a) -> t -> 'a -> 'a
in the corresponding direction(s). *) in the corresponding direction(s). *)
val to_int_seq: t -> Integer.t Seq.t val to_int_seq: t -> Integer.t Seq.t
(** Builds a sequence of integer values of the ival in increasing order. The (** Builds a sequence of integer values of the ival in increasing order.
Raise {!Abstract_interp.Error_Top} if the argument is a float or a The resulting sequence might be infinite.
potentially infinite integer. *) @raise {!Abstract_interp.Error_Top} if the argument is a floating-point
interval or an infinite integer interval. *)
(** Subdivisions into two intervals *) (** Subdivisions into two intervals *)
val subdivide: size:Integer.t -> t -> t * t val subdivide: size:Integer.t -> t -> t * t
......
...@@ -146,6 +146,8 @@ module Location_Bytes : sig ...@@ -146,6 +146,8 @@ module Location_Bytes : sig
one offset cannot be enumerated. *) one offset cannot be enumerated. *)
val to_seq_i : t -> (Base.t * Ival.t) Seq.t val to_seq_i : t -> (Base.t * Ival.t) Seq.t
(** Builds a sequence of all bases (with their offsets) of the location.
@raise Error_Top in the cases [Top _]. *)
val cached_fold: val cached_fold:
cache_name:string -> cache_name:string ->
......
...@@ -113,9 +113,9 @@ module type Shape = sig ...@@ -113,9 +113,9 @@ module type Shape = sig
to [f] in the opposite order. *) to [f] in the opposite order. *)
val to_seq : 'v map -> (key * 'v) Seq.t val to_seq : 'v map -> (key * 'v) Seq.t
(** [to_seq m] builds a sequence of each pair of key and datume in the (** [to_seq m] builds a sequence of each pair (key, datum) in the map [m].
map [m]. Keys are presented in the sequence in increasing order according Keys are presented in the sequence in increasing order according to
to the map's ordering. *) the map's ordering. *)
val cached_fold : val cached_fold :
cache_name:string -> cache_name:string ->
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment