grew_utils.mli 6.66 KB
Newer Older
pj2m's avatar
pj2m committed
1

bguillaum's avatar
bguillaum committed
2 3 4
module StringMap : Map.S with type key = string
module StringSet : Set.S with type elt = string

pj2m's avatar
pj2m committed
5
module IntSet : Set.S with type elt = int
6
module IntMap : Map.S with type key = int
pj2m's avatar
pj2m committed
7 8


bguillaum's avatar
bguillaum committed
9 10
(* ================================================================================ *)
(* [Loc] general module to describe errors location: (file name, line number in file) *)
pj2m's avatar
pj2m committed
11 12 13
module Loc: sig
  type t = string * int 

bguillaum's avatar
bguillaum committed
14 15
  val opt_set_line: int -> t option -> t option

pj2m's avatar
pj2m committed
16 17 18 19
  val to_string: t -> string
end


bguillaum's avatar
bguillaum committed
20 21 22 23
(* ================================================================================ *)
(* [File] basic functions to read/write file *)
module File: sig
  (** [write data file_name] write [data] in file named [file_name] *)
pj2m's avatar
pj2m committed
24
  val write: string -> string -> unit
bguillaum's avatar
bguillaum committed
25

bguillaum's avatar
bguillaum committed
26 27 28 29
  (** [read file_name] read the content of [file_name] line by line. 
     Blanks lines (empty or only with spaces and tabs) are ignored.
     Lines with '%' as the first char are ignores
   *)
bguillaum's avatar
bguillaum committed
30
  val read: string -> string list
pj2m's avatar
pj2m committed
31 32
end

bguillaum's avatar
bguillaum committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

(* ================================================================================ *)
(* [Pid] describes identifier used in pattern graphs *)
module Pid : sig type t = int end

(* ================================================================================ *)
(* [Pid_map] is the map used in pattern graphs *)
module Pid_map : sig
  include Map.S with type key = int
  exception MatchNotInjective
  val exists: (key -> 'a -> bool) -> 'a t -> bool
  val union_if: int t -> int t -> int t
  end


module Gid : sig type t = int end

module Gid_map : Map.S with type key = Gid.t 


pj2m's avatar
pj2m committed
53 54 55 56 57 58 59 60 61 62 63 64
module Array_: sig
  val dicho_mem: 'a -> 'a array -> bool

  (* dichotomic search: the array MUST be sorted and without duplicates. Not found can be raised *)
  val dicho_find: 'a -> 'a array -> int
  val dicho_find_assoc: 'a -> ('a*'b) array -> int
end

module List_: sig
  (** [rm elt list] removes the first occurence of [elt] in [list]. [Not_found] can be raised. *)
  val rm: 'a -> 'a list -> 'a list
  val opt: 'a option list -> 'a list
bguillaum's avatar
bguillaum committed
65 66 67
      
  (** [pos elt list] return [Some index] if [index] is the smallest position in the [list] equals to [elt]. None is returned if [elt] is not in the [list] *)
  val pos: 'a -> 'a list -> int option
pj2m's avatar
pj2m committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

  val opt_map: ('a -> 'b option) -> 'a list -> 'b list

  val flat_map: ('a -> 'b list) -> 'a list -> 'b list
  (* remove [elt] from [list]. raise Not_found if [elt] is not in [list] *)      
  val remove: 'a -> 'a list -> 'a list

  val foldi_left: (int -> 'a -> 'b -> 'a) -> 'a -> 'b list -> 'a

  (** [disjoint_list] returns true iff the two strictly ordered list are disjoint *)
  val sort_disjoint: 'a list -> 'a list -> bool

  val to_string: ('a -> string) -> string -> 'a list -> string

  val iteri: (int -> 'a -> unit) -> 'a list -> unit

  val mapi: (int -> 'a -> 'b) -> 'a list -> 'b list

86 87
  val sort_mem: 'a -> 'a list -> bool

pj2m's avatar
pj2m committed
88 89 90 91 92 93 94 95
  (* Insert an element in a sorted list. *)
  val sort_insert: 'a -> 'a list -> 'a list

  (* Insert an element in a usort list. Return Some l or None if the element is already in the list *)
  val usort_insert: ?compare:('a -> 'a -> int) -> 'a -> 'a list -> 'a list option

  val sort_is_empty_inter: 'a list -> 'a list -> bool
  val sort_inter: 'a list -> 'a list -> 'a list
bguillaum's avatar
bguillaum committed
96
  val sort_union: 'a list -> 'a list -> 'a list
pj2m's avatar
pj2m committed
97 98 99 100 101
  val sort_disjoint_union: ?compare:('a -> 'a -> int) -> 'a list -> 'a list -> 'a list
  val sort_include: 'a list -> 'a list -> bool
  val sort_included_diff: 'a list -> 'a list -> 'a list
  val sort_diff: 'a list -> 'a list -> 'a list

102 103 104 105 106 107
  val sort_assoc: 'a -> ('a * 'b) list -> 'b option

   (* [sort_remove_assoc k ass_list] returns the input list without the [key] element, 
      if [key] not found, the unchanged input list is returned *)
  val sort_remove_assoc: 'a -> ('a * 'b) list -> ('a * 'b) list

108
  val foldi_left: (int -> 'a -> 'b -> 'a) -> 'a -> 'b list -> 'a
pj2m's avatar
pj2m committed
109 110 111 112 113 114
end

(* module Massoc implements multi-association data: keys are int and the same key can be
associated with a set of values *)
module Massoc: sig
  type 'a t
115

pj2m's avatar
pj2m committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  val empty: 'a t

  (* an empty list returned if the key is undefined *) 
  val assoc: int -> 'a t -> 'a list

  val is_empty: 'a t -> bool

  val to_string: ('a -> string) -> 'a t -> string

  val iter: (int -> 'a -> unit) -> 'a t -> unit

  val add: int -> 'a -> 'a t -> 'a t option

  val fold_left: ('b -> int -> 'a -> 'b) -> 'b -> 'a t -> 'b

  (* raise Not_found if no (key,elt) *)
  val remove: int -> 'a -> 'a t -> 'a t
      
  (* raise Not_found if no (key,elt) *)
  val remove_key: int -> 'a t -> 'a t

  (* [mem key value t ] test if the couple (key, value) is in the massoc [t]. *)
  val mem: int -> 'a -> 'a t -> bool

  (* mem_key key t] tests is [key] is associated to at least one value in [t]. *)
  val mem_key: int -> 'a t -> bool

  exception Not_disjoint
  val disjoint_union: 'a t -> 'a t -> 'a t 

  exception Duplicate
  val merge_key: int -> int -> 'a t -> 'a t

  val exists: (int -> 'a -> bool) -> 'a t -> bool
end
    
bguillaum's avatar
bguillaum committed
152

pj2m's avatar
pj2m committed
153 154

module Error: sig
bguillaum's avatar
bguillaum committed
155 156 157 158
  exception Build of (string * Loc.t option)
  exception Run of (string * Loc.t option)
  exception Bug of (string * Loc.t option)

pj2m's avatar
pj2m committed
159 160
  val build: ?loc: Loc.t -> ('a, unit, string, 'b) format4 -> 'a
  val run: ?loc: Loc.t -> ('a, unit, string, 'b) format4 -> 'a
bguillaum's avatar
bguillaum committed
161
  val bug: ?loc: Loc.t -> ('a, unit, string, 'b) format4 -> 'a
pj2m's avatar
pj2m committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
end




module Id: sig
  type name = string
  type t = int

  type table = name array

  (* [Stop] is raised if [string] is not in [table] *)
  val build: ?loc:Loc.t -> name -> table -> t

  val build_opt: name -> table -> t option 
end

179 180 181 182
module Html: sig
  val enter: out_channel -> ?title: string -> ?header: string -> string -> unit
  val leave: out_channel -> unit
end
bguillaum's avatar
bguillaum committed
183 184 185

module Conll: sig
  type line = {
bguillaum's avatar
bguillaum committed
186 187 188 189 190 191 192 193 194 195
    line_num: int;
    num: int;
    phon: string;
    lemma: string;
    pos1: string;
    pos2: string;
    morph: (string * string) list;
    gov: int;
    dep_lab: string;
  }
bguillaum's avatar
bguillaum committed
196
        
bguillaum's avatar
bguillaum committed
197
  val load: string -> line list
bguillaum's avatar
bguillaum committed
198
end
199 200 201 202 203

(** module for rule that are lexically parametrized *)
module Lex_par: sig
  type t

204 205
  (** [load ?loc local_dir_name nb_pattern_var nb_command_var file] *)
  val load: ?loc: Loc.t -> string -> int -> int -> string -> t
206 207 208 209 210 211 212

  (** [filter index atom t] returns the subset of [t] which contains only entries 
      which refers to [atom] at the [index]^th pattern_var.
      [None] is returnes if no such entry s founded.
   *)
  val filter: int -> string -> t -> t option

bguillaum's avatar
bguillaum committed
213 214 215
  (** [get_param_value index t] returns the [index]^th param_var. *)
  val get_param_value: int -> t -> string

216 217 218 219
  (** [get_command_value index t] supposes that [t] contains iny one element.
      It returns the [index]^th command_var. *)
  val get_command_value: int -> t -> string
end
bguillaum's avatar
bguillaum committed
220 221 222 223 224 225 226 227 228

module Timeout: sig
  exception Stop

  val timeout: float option ref
  val start: unit -> unit

  val check: unit -> unit
end