source: Deliverables/D2.2/8051-indexed-labels-branch/src/common/costLabel.mli @ 1357

(** This module provides functions to manipulate and create indexed cost
    labels. *)
                
(** [Atom] provides functions for cost atoms, the root of indexed costs *)
module Atom : sig
        include StringSig.S
end

(** Simple expressions corresponding to loop tranformations. 
    TODO: leave it abstract or not? *)
type sexpr

val sexpr_id : sexpr

(* trying a nameless approach *)
type index = int

val make_id : string -> index -> string

type indexing = sexpr list

type const_indexing

val const_ind_iter : (int -> unit) -> const_indexing -> unit

(** Top of the stack.
    @raise [Invalid_argument "non-empty indexing stack"] if argument is empty *)
val curr_const_ind : const_indexing list -> const_indexing

(** [enter_loop inds n] is used to update the indexing stack [ind] when one
    is entering a loop indexed by [n]. Raises [Invalid_argument
                "non-empty indexing stack"] if [inds] is empty. *)
val enter_loop : const_indexing list -> index -> unit

(** [enter_loop_opt inds (Some n)] behaves like [enter_loop inds n], and does
    nothing in case of [None].
                @see enter_loop *)
val enter_loop_opt : const_indexing list -> index option -> unit 

(** [continue_loop inds n] is used to update the indexing stack [inds] when
    one is continuing a loop indexed by [n].
                @raise [Invalid_argument "non-empty indexing stack"] if [inds] is empty.
                @raise [Invalid_argument "uninitialized loop index"] if the head of
                [inds] has no value for [index]. *)
val continue_loop : const_indexing list -> index -> unit

(** [continue_loop_opt inds (Some n)] behaves like [continue_loop inds n], and
    does nothing in case of [None].
    @see continue_loop *)
val continue_loop_opt : const_indexing list -> index option -> unit

(** [new_const_ind inds] pushes a new empty constant indexing on top of the
    stack [inds]. *) 
val new_const_ind : const_indexing list -> const_indexing list

(** [forget_const_ind inds] pops and discards the top constant indexing from the
    stack [inds].  Raises [Invalid_argument "non-empty indexing stack"] if
                [inds] is empty. *) 
val forget_const_ind : const_indexing list -> const_indexing list


 

(** [empty_indexing] generates an empty indexing *) 
val empty_indexing : indexing

(** [add_id_indexing ind] adds an identity mapping in front of ind **)
val add_id_indexing : indexing -> indexing

module IndexingSet : Set.S with type elt = indexing

type t = {
        name : Atom.t;
        i : indexing
}

(** [apply_const_indexing ind lbl] returns [lbl] where its indexing has been
    evaluated in the constant indexing [ind].
                @raise  Invalid_argument "constant indexing not enough to be applied" if
                [ind] does not contain enough mappings to evaluate [lbl]'s indexing. *)
val ev_indexing : const_indexing -> t -> t

(** [string_of_cost_label pref t] converts an indexed label to a
    string suitable for a label name in source 
                [string_of_cost_label ~pretty:true t] prints a more readable form *)
val string_of_cost_label : ?pretty : bool -> t -> string

(** [fresh i u] creates a fresh label using [u] as name universe, inside
    the indexing [i] (which represents the nested loops containing the label) *)
val fresh : indexing -> Atom.Gen.universe -> t

module Set : Set.S with type elt = t
module Map : Map.S with type key = t

(** [indexings_of a s] produces the set of indexings of an atom [a] occurring
    in the set of indexed labels [s]. *)
val indexings_of : Atom.t -> Set.t -> IndexingSet.t

(** [constant_map d x] produces a finite map which associates 
    [x] to every element of the set [d]. *)
val constant_map : Set.t -> 'a -> 'a Map.t