src/Tools/Metis/src/Useful.sig

 (* ========================================================================= *)
 (* ML UTILITY FUNCTIONS                                                      *)
-(* Copyright (c) 2001-2005 Joe Hurd, distributed under the BSD License *)
+(* Copyright (c) 2001 Joe Hurd, distributed under the BSD License            *)
 (* ========================================================================= *)
 
 signature Useful =
 sig
 

 
 exception Error of string
 
 exception Bug of string
 
-val partial : exn -> ('a -> 'b option) -> 'a -> 'b
-
 val total : ('a -> 'b) -> 'a -> 'b option
 
 val can : ('a -> 'b) -> 'a -> bool
 
 (* ------------------------------------------------------------------------- *)

 
 val funpow : int -> ('a -> 'a) -> 'a -> 'a
 
 val exp : ('a * 'a -> 'a) -> 'a -> int -> 'a -> 'a
 
+(* ------------------------------------------------------------------------- *)
+(* Pairs.                                                                    *)
+(* ------------------------------------------------------------------------- *)
+
+val fst : 'a * 'b -> 'a
+
+val snd : 'a * 'b -> 'b
+
+val pair : 'a -> 'b -> 'a * 'b
+
+val swap : 'a * 'b -> 'b * 'a
+
+val curry : ('a * 'b -> 'c) -> 'a -> 'b -> 'c
+
+val uncurry : ('a -> 'b -> 'c) -> 'a * 'b -> 'c
+
+val ## : ('a -> 'c) * ('b -> 'd) -> 'a * 'b -> 'c * 'd
+
+(* ------------------------------------------------------------------------- *)
+(* State transformers.                                                       *)
+(* ------------------------------------------------------------------------- *)
+
+val unit : 'a -> 's -> 'a * 's
+
+val bind : ('s -> 'a * 's) -> ('a -> 's -> 'b * 's) -> 's -> 'b * 's
+
+val mmap : ('a -> 'b) -> ('s -> 'a * 's) -> 's -> 'b * 's
+
+val mjoin : ('s -> ('s -> 'a * 's) * 's) -> 's -> 'a * 's
+
+val mwhile : ('a -> bool) -> ('a -> 's -> 'a * 's) -> 'a -> 's -> 'a * 's
+
+(* ------------------------------------------------------------------------- *)
+(* Equality.                                                                 *)
+(* ------------------------------------------------------------------------- *)
+
 val equal : ''a -> ''a -> bool
 
 val notEqual : ''a -> ''a -> bool
 
-(* ------------------------------------------------------------------------- *)
-(* Pairs.                                                                    *)
-(* ------------------------------------------------------------------------- *)
-
-val fst : 'a * 'b -> 'a
-
-val snd : 'a * 'b -> 'b
-
-val pair : 'a -> 'b -> 'a * 'b
-
-val swap : 'a * 'b -> 'b * 'a
-
-val curry : ('a * 'b -> 'c) -> 'a -> 'b -> 'c
-
-val uncurry : ('a -> 'b -> 'c) -> 'a * 'b -> 'c
-
-val ## : ('a -> 'c) * ('b -> 'd) -> 'a * 'b -> 'c * 'd
-
-(* ------------------------------------------------------------------------- *)
-(* State transformers.                                                       *)
-(* ------------------------------------------------------------------------- *)
-
-val unit : 'a -> 's -> 'a * 's
-
-val bind : ('s -> 'a * 's) -> ('a -> 's -> 'b * 's) -> 's -> 'b * 's
-
-val mmap : ('a -> 'b) -> ('s -> 'a * 's) -> 's -> 'b * 's
-
-val mjoin : ('s -> ('s -> 'a * 's) * 's) -> 's -> 'a * 's
-
-val mwhile : ('a -> bool) -> ('a -> 's -> 'a * 's) -> 'a -> 's -> 'a * 's
-
-(* ------------------------------------------------------------------------- *)
-(* Lists: note we count elements from 0.                                     *)
-(* ------------------------------------------------------------------------- *)
-
-val cons : 'a -> 'a list -> 'a list
-
-val hdTl : 'a list -> 'a * 'a list
-
-val append : 'a list -> 'a list -> 'a list
-
-val singleton : 'a -> 'a list
-
-val first : ('a -> 'b option) -> 'a list -> 'b option
-
-val index : ('a -> bool) -> 'a list -> int option
-
-val maps : ('a -> 's -> 'b * 's) -> 'a list -> 's -> 'b list * 's
-
-val mapsPartial : ('a -> 's -> 'b option * 's) -> 'a list -> 's -> 'b list * 's
-
-val enumerate : 'a list -> (int * 'a) list
-
-val zipwith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
-
-val zip : 'a list -> 'b list -> ('a * 'b) list
-
-val unzip : ('a * 'b) list -> 'a list * 'b list
-
-val cartwith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
-
-val cart : 'a list -> 'b list -> ('a * 'b) list
-
-val divide : 'a list -> int -> 'a list * 'a list  (* Subscript *)
-
-val revDivide : 'a list -> int -> 'a list * 'a list  (* Subscript *)
-
-val updateNth : int * 'a -> 'a list -> 'a list  (* Subscript *)
-
-val deleteNth : int -> 'a list -> 'a list  (* Subscript *)
-
-(* ------------------------------------------------------------------------- *)
-(* Sets implemented with lists.                                              *)
-(* ------------------------------------------------------------------------- *)
-
-val mem : ''a -> ''a list -> bool
-
-val insert : ''a -> ''a list -> ''a list
-
-val delete : ''a -> ''a list -> ''a list
-
-val setify : ''a list -> ''a list  (* removes duplicates *)
-
-val union : ''a list -> ''a list -> ''a list
-
-val intersect : ''a list -> ''a list -> ''a list
-
-val difference : ''a list -> ''a list -> ''a list
-
-val subset : ''a list -> ''a list -> bool
-
-val distinct : ''a list -> bool
+val listEqual : ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
 
 (* ------------------------------------------------------------------------- *)
 (* Comparisons.                                                              *)
 (* ------------------------------------------------------------------------- *)
 

 
 val lexCompare : ('a * 'a -> order) -> 'a list * 'a list -> order
 
 val optionCompare : ('a * 'a -> order) -> 'a option * 'a option -> order
 
-val boolCompare : bool * bool -> order  (* true < false *)
+val boolCompare : bool * bool -> order  (* false < true *)
+
+(* ------------------------------------------------------------------------- *)
+(* Lists: note we count elements from 0.                                     *)
+(* ------------------------------------------------------------------------- *)
+
+val cons : 'a -> 'a list -> 'a list
+
+val hdTl : 'a list -> 'a * 'a list
+
+val append : 'a list -> 'a list -> 'a list
+
+val singleton : 'a -> 'a list
+
+val first : ('a -> 'b option) -> 'a list -> 'b option
+
+val maps : ('a -> 's -> 'b * 's) -> 'a list -> 's -> 'b list * 's
+
+val mapsPartial : ('a -> 's -> 'b option * 's) -> 'a list -> 's -> 'b list * 's
+
+val zipWith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
+
+val zip : 'a list -> 'b list -> ('a * 'b) list
+
+val unzip : ('a * 'b) list -> 'a list * 'b list
+
+val cartwith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
+
+val cart : 'a list -> 'b list -> ('a * 'b) list
+
+val takeWhile : ('a -> bool) -> 'a list -> 'a list
+
+val dropWhile : ('a -> bool) -> 'a list -> 'a list
+
+val divideWhile : ('a -> bool) -> 'a list -> 'a list * 'a list
+
+val groups : ('a * 's -> bool * 's) -> 's -> 'a list -> 'a list list
+
+val groupsBy : ('a * 'a -> bool) -> 'a list -> 'a list list
+
+val groupsByFst : (''a * 'b) list -> (''a * 'b list) list
+
+val groupsOf : int -> 'a list -> 'a list list
+
+val index : ('a -> bool) -> 'a list -> int option
+
+val enumerate : 'a list -> (int * 'a) list
+
+val divide : 'a list -> int -> 'a list * 'a list  (* Subscript *)
+
+val revDivide : 'a list -> int -> 'a list * 'a list  (* Subscript *)
+
+val updateNth : int * 'a -> 'a list -> 'a list  (* Subscript *)
+
+val deleteNth : int -> 'a list -> 'a list  (* Subscript *)
+
+(* ------------------------------------------------------------------------- *)
+(* Sets implemented with lists.                                              *)
+(* ------------------------------------------------------------------------- *)
+
+val mem : ''a -> ''a list -> bool
+
+val insert : ''a -> ''a list -> ''a list
+
+val delete : ''a -> ''a list -> ''a list
+
+val setify : ''a list -> ''a list  (* removes duplicates *)
+
+val union : ''a list -> ''a list -> ''a list
+
+val intersect : ''a list -> ''a list -> ''a list
+
+val difference : ''a list -> ''a list -> ''a list
+
+val subset : ''a list -> ''a list -> bool
+
+val distinct : ''a list -> bool
 
 (* ------------------------------------------------------------------------- *)
 (* Sorting and searching.                                                    *)
 (* ------------------------------------------------------------------------- *)
 

 
 val join : string -> string list -> string
 
 val split : string -> string -> string list
 
+val capitalize : string -> string
+
 val mkPrefix : string -> string -> string
 
 val destPrefix : string -> string -> string
 
 val isPrefix : string -> string -> bool
 
+val stripPrefix : (char -> bool) -> string -> string
+
+val mkSuffix : string -> string -> string
+
+val destSuffix : string -> string -> string
+
+val isSuffix : string -> string -> bool
+
+val stripSuffix : (char -> bool) -> string -> string
+
 (* ------------------------------------------------------------------------- *)
 (* Tables.                                                                   *)
 (* ------------------------------------------------------------------------- *)
 
 type columnAlignment = {leftAlign : bool, padChar : char}

 
 val time : unit -> string
 
 val date : unit -> string
 
+val readDirectory : {directory : string} -> {filename : string} list
+
 val readTextFile : {filename : string} -> string
 
-val writeTextFile : {filename : string, contents : string} -> unit
+val writeTextFile : {contents : string, filename : string} -> unit
 
 (* ------------------------------------------------------------------------- *)
 (* Profiling and error reporting.                                            *)
 (* ------------------------------------------------------------------------- *)
 
 val try : ('a -> 'b) -> 'a -> 'b
 
+val chat : string -> unit
+
 val warn : string -> unit
 
 val die : string -> 'exit
 
 val timed : ('a -> 'b) -> 'a -> real * 'b