39348
|
1 |
(* ========================================================================= *)
|
|
2 |
(* ML UTILITY FUNCTIONS *)
|
39349
|
3 |
(* Copyright (c) 2001 Joe Hurd, distributed under the BSD License *)
|
39348
|
4 |
(* ========================================================================= *)
|
|
5 |
|
|
6 |
signature Useful =
|
|
7 |
sig
|
|
8 |
|
|
9 |
(* ------------------------------------------------------------------------- *)
|
|
10 |
(* Exceptions. *)
|
|
11 |
(* ------------------------------------------------------------------------- *)
|
|
12 |
|
|
13 |
exception Error of string
|
|
14 |
|
|
15 |
exception Bug of string
|
|
16 |
|
|
17 |
val total : ('a -> 'b) -> 'a -> 'b option
|
|
18 |
|
|
19 |
val can : ('a -> 'b) -> 'a -> bool
|
|
20 |
|
|
21 |
(* ------------------------------------------------------------------------- *)
|
|
22 |
(* Tracing. *)
|
|
23 |
(* ------------------------------------------------------------------------- *)
|
|
24 |
|
|
25 |
val tracePrint : (string -> unit) ref
|
|
26 |
|
|
27 |
val trace : string -> unit
|
|
28 |
|
|
29 |
(* ------------------------------------------------------------------------- *)
|
|
30 |
(* Combinators. *)
|
|
31 |
(* ------------------------------------------------------------------------- *)
|
|
32 |
|
|
33 |
val C : ('a -> 'b -> 'c) -> 'b -> 'a -> 'c
|
|
34 |
|
|
35 |
val I : 'a -> 'a
|
|
36 |
|
|
37 |
val K : 'a -> 'b -> 'a
|
|
38 |
|
|
39 |
val S : ('a -> 'b -> 'c) -> ('a -> 'b) -> 'a -> 'c
|
|
40 |
|
|
41 |
val W : ('a -> 'a -> 'b) -> 'a -> 'b
|
|
42 |
|
|
43 |
val funpow : int -> ('a -> 'a) -> 'a -> 'a
|
|
44 |
|
|
45 |
val exp : ('a * 'a -> 'a) -> 'a -> int -> 'a -> 'a
|
|
46 |
|
|
47 |
(* ------------------------------------------------------------------------- *)
|
|
48 |
(* Pairs. *)
|
|
49 |
(* ------------------------------------------------------------------------- *)
|
|
50 |
|
|
51 |
val fst : 'a * 'b -> 'a
|
|
52 |
|
|
53 |
val snd : 'a * 'b -> 'b
|
|
54 |
|
|
55 |
val pair : 'a -> 'b -> 'a * 'b
|
|
56 |
|
|
57 |
val swap : 'a * 'b -> 'b * 'a
|
|
58 |
|
|
59 |
val curry : ('a * 'b -> 'c) -> 'a -> 'b -> 'c
|
|
60 |
|
|
61 |
val uncurry : ('a -> 'b -> 'c) -> 'a * 'b -> 'c
|
|
62 |
|
|
63 |
val ## : ('a -> 'c) * ('b -> 'd) -> 'a * 'b -> 'c * 'd
|
|
64 |
|
|
65 |
(* ------------------------------------------------------------------------- *)
|
|
66 |
(* State transformers. *)
|
|
67 |
(* ------------------------------------------------------------------------- *)
|
|
68 |
|
|
69 |
val unit : 'a -> 's -> 'a * 's
|
|
70 |
|
|
71 |
val bind : ('s -> 'a * 's) -> ('a -> 's -> 'b * 's) -> 's -> 'b * 's
|
|
72 |
|
|
73 |
val mmap : ('a -> 'b) -> ('s -> 'a * 's) -> 's -> 'b * 's
|
|
74 |
|
|
75 |
val mjoin : ('s -> ('s -> 'a * 's) * 's) -> 's -> 'a * 's
|
|
76 |
|
|
77 |
val mwhile : ('a -> bool) -> ('a -> 's -> 'a * 's) -> 'a -> 's -> 'a * 's
|
|
78 |
|
|
79 |
(* ------------------------------------------------------------------------- *)
|
|
80 |
(* Equality. *)
|
|
81 |
(* ------------------------------------------------------------------------- *)
|
|
82 |
|
|
83 |
val equal : ''a -> ''a -> bool
|
|
84 |
|
|
85 |
val notEqual : ''a -> ''a -> bool
|
|
86 |
|
|
87 |
val listEqual : ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
|
|
88 |
|
|
89 |
(* ------------------------------------------------------------------------- *)
|
|
90 |
(* Comparisons. *)
|
|
91 |
(* ------------------------------------------------------------------------- *)
|
|
92 |
|
|
93 |
val mapCompare : ('a -> 'b) -> ('b * 'b -> order) -> 'a * 'a -> order
|
|
94 |
|
|
95 |
val revCompare : ('a * 'a -> order) -> 'a * 'a -> order
|
|
96 |
|
|
97 |
val prodCompare :
|
|
98 |
('a * 'a -> order) -> ('b * 'b -> order) -> ('a * 'b) * ('a * 'b) -> order
|
|
99 |
|
|
100 |
val lexCompare : ('a * 'a -> order) -> 'a list * 'a list -> order
|
|
101 |
|
|
102 |
val optionCompare : ('a * 'a -> order) -> 'a option * 'a option -> order
|
|
103 |
|
|
104 |
val boolCompare : bool * bool -> order (* false < true *)
|
|
105 |
|
|
106 |
(* ------------------------------------------------------------------------- *)
|
|
107 |
(* Lists: note we count elements from 0. *)
|
|
108 |
(* ------------------------------------------------------------------------- *)
|
|
109 |
|
|
110 |
val cons : 'a -> 'a list -> 'a list
|
|
111 |
|
|
112 |
val hdTl : 'a list -> 'a * 'a list
|
|
113 |
|
|
114 |
val append : 'a list -> 'a list -> 'a list
|
|
115 |
|
|
116 |
val singleton : 'a -> 'a list
|
|
117 |
|
|
118 |
val first : ('a -> 'b option) -> 'a list -> 'b option
|
|
119 |
|
|
120 |
val maps : ('a -> 's -> 'b * 's) -> 'a list -> 's -> 'b list * 's
|
|
121 |
|
|
122 |
val mapsPartial : ('a -> 's -> 'b option * 's) -> 'a list -> 's -> 'b list * 's
|
|
123 |
|
|
124 |
val zipWith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
|
|
125 |
|
|
126 |
val zip : 'a list -> 'b list -> ('a * 'b) list
|
|
127 |
|
|
128 |
val unzip : ('a * 'b) list -> 'a list * 'b list
|
|
129 |
|
|
130 |
val cartwith : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
|
|
131 |
|
|
132 |
val cart : 'a list -> 'b list -> ('a * 'b) list
|
|
133 |
|
|
134 |
val takeWhile : ('a -> bool) -> 'a list -> 'a list
|
|
135 |
|
|
136 |
val dropWhile : ('a -> bool) -> 'a list -> 'a list
|
|
137 |
|
|
138 |
val divideWhile : ('a -> bool) -> 'a list -> 'a list * 'a list
|
|
139 |
|
|
140 |
val groups : ('a * 's -> bool * 's) -> 's -> 'a list -> 'a list list
|
|
141 |
|
|
142 |
val groupsBy : ('a * 'a -> bool) -> 'a list -> 'a list list
|
|
143 |
|
|
144 |
val groupsByFst : (''a * 'b) list -> (''a * 'b list) list
|
|
145 |
|
|
146 |
val groupsOf : int -> 'a list -> 'a list list
|
|
147 |
|
|
148 |
val index : ('a -> bool) -> 'a list -> int option
|
|
149 |
|
|
150 |
val enumerate : 'a list -> (int * 'a) list
|
|
151 |
|
|
152 |
val divide : 'a list -> int -> 'a list * 'a list (* Subscript *)
|
|
153 |
|
|
154 |
val revDivide : 'a list -> int -> 'a list * 'a list (* Subscript *)
|
|
155 |
|
|
156 |
val updateNth : int * 'a -> 'a list -> 'a list (* Subscript *)
|
|
157 |
|
|
158 |
val deleteNth : int -> 'a list -> 'a list (* Subscript *)
|
|
159 |
|
|
160 |
(* ------------------------------------------------------------------------- *)
|
|
161 |
(* Sets implemented with lists. *)
|
|
162 |
(* ------------------------------------------------------------------------- *)
|
|
163 |
|
|
164 |
val mem : ''a -> ''a list -> bool
|
|
165 |
|
|
166 |
val insert : ''a -> ''a list -> ''a list
|
|
167 |
|
|
168 |
val delete : ''a -> ''a list -> ''a list
|
|
169 |
|
|
170 |
val setify : ''a list -> ''a list (* removes duplicates *)
|
|
171 |
|
|
172 |
val union : ''a list -> ''a list -> ''a list
|
|
173 |
|
|
174 |
val intersect : ''a list -> ''a list -> ''a list
|
|
175 |
|
|
176 |
val difference : ''a list -> ''a list -> ''a list
|
|
177 |
|
|
178 |
val subset : ''a list -> ''a list -> bool
|
|
179 |
|
|
180 |
val distinct : ''a list -> bool
|
|
181 |
|
|
182 |
(* ------------------------------------------------------------------------- *)
|
|
183 |
(* Sorting and searching. *)
|
|
184 |
(* ------------------------------------------------------------------------- *)
|
|
185 |
|
|
186 |
val minimum : ('a * 'a -> order) -> 'a list -> 'a * 'a list (* Empty *)
|
|
187 |
|
|
188 |
val maximum : ('a * 'a -> order) -> 'a list -> 'a * 'a list (* Empty *)
|
|
189 |
|
|
190 |
val merge : ('a * 'a -> order) -> 'a list -> 'a list -> 'a list
|
|
191 |
|
|
192 |
val sort : ('a * 'a -> order) -> 'a list -> 'a list
|
|
193 |
|
|
194 |
val sortMap : ('a -> 'b) -> ('b * 'b -> order) -> 'a list -> 'a list
|
|
195 |
|
|
196 |
(* ------------------------------------------------------------------------- *)
|
|
197 |
(* Integers. *)
|
|
198 |
(* ------------------------------------------------------------------------- *)
|
|
199 |
|
|
200 |
val interval : int -> int -> int list
|
|
201 |
|
|
202 |
val divides : int -> int -> bool
|
|
203 |
|
|
204 |
val gcd : int -> int -> int
|
|
205 |
|
|
206 |
val primes : int -> int list
|
|
207 |
|
|
208 |
val primesUpTo : int -> int list
|
|
209 |
|
|
210 |
(* ------------------------------------------------------------------------- *)
|
|
211 |
(* Strings. *)
|
|
212 |
(* ------------------------------------------------------------------------- *)
|
|
213 |
|
|
214 |
val rot : int -> char -> char
|
|
215 |
|
|
216 |
val charToInt : char -> int option
|
|
217 |
|
|
218 |
val charFromInt : int -> char option
|
|
219 |
|
|
220 |
val nChars : char -> int -> string
|
|
221 |
|
|
222 |
val chomp : string -> string
|
|
223 |
|
|
224 |
val trim : string -> string
|
|
225 |
|
|
226 |
val join : string -> string list -> string
|
|
227 |
|
|
228 |
val split : string -> string -> string list
|
|
229 |
|
|
230 |
val capitalize : string -> string
|
|
231 |
|
|
232 |
val mkPrefix : string -> string -> string
|
|
233 |
|
|
234 |
val destPrefix : string -> string -> string
|
|
235 |
|
|
236 |
val isPrefix : string -> string -> bool
|
|
237 |
|
|
238 |
val stripPrefix : (char -> bool) -> string -> string
|
|
239 |
|
|
240 |
val mkSuffix : string -> string -> string
|
|
241 |
|
|
242 |
val destSuffix : string -> string -> string
|
|
243 |
|
|
244 |
val isSuffix : string -> string -> bool
|
|
245 |
|
|
246 |
val stripSuffix : (char -> bool) -> string -> string
|
|
247 |
|
|
248 |
(* ------------------------------------------------------------------------- *)
|
|
249 |
(* Tables. *)
|
|
250 |
(* ------------------------------------------------------------------------- *)
|
|
251 |
|
|
252 |
type columnAlignment = {leftAlign : bool, padChar : char}
|
|
253 |
|
|
254 |
val alignColumn : columnAlignment -> string list -> string list -> string list
|
|
255 |
|
|
256 |
val alignTable : columnAlignment list -> string list list -> string list
|
|
257 |
|
|
258 |
(* ------------------------------------------------------------------------- *)
|
|
259 |
(* Reals. *)
|
|
260 |
(* ------------------------------------------------------------------------- *)
|
|
261 |
|
|
262 |
val percentToString : real -> string
|
|
263 |
|
|
264 |
val pos : real -> real
|
|
265 |
|
|
266 |
val log2 : real -> real (* Domain *)
|
|
267 |
|
|
268 |
(* ------------------------------------------------------------------------- *)
|
|
269 |
(* Sum datatype. *)
|
|
270 |
(* ------------------------------------------------------------------------- *)
|
|
271 |
|
|
272 |
datatype ('a,'b) sum = Left of 'a | Right of 'b
|
|
273 |
|
|
274 |
val destLeft : ('a,'b) sum -> 'a
|
|
275 |
|
|
276 |
val isLeft : ('a,'b) sum -> bool
|
|
277 |
|
|
278 |
val destRight : ('a,'b) sum -> 'b
|
|
279 |
|
|
280 |
val isRight : ('a,'b) sum -> bool
|
|
281 |
|
|
282 |
(* ------------------------------------------------------------------------- *)
|
|
283 |
(* Useful impure features. *)
|
|
284 |
(* ------------------------------------------------------------------------- *)
|
|
285 |
|
|
286 |
val newInt : unit -> int
|
|
287 |
|
|
288 |
val newInts : int -> int list
|
|
289 |
|
|
290 |
val withRef : 'r ref * 'r -> ('a -> 'b) -> 'a -> 'b
|
|
291 |
|
|
292 |
val cloneArray : 'a Array.array -> 'a Array.array
|
|
293 |
|
|
294 |
(* ------------------------------------------------------------------------- *)
|
|
295 |
(* The environment. *)
|
|
296 |
(* ------------------------------------------------------------------------- *)
|
|
297 |
|
|
298 |
val host : unit -> string
|
|
299 |
|
|
300 |
val time : unit -> string
|
|
301 |
|
|
302 |
val date : unit -> string
|
|
303 |
|
|
304 |
val readDirectory : {directory : string} -> {filename : string} list
|
|
305 |
|
|
306 |
val readTextFile : {filename : string} -> string
|
|
307 |
|
|
308 |
val writeTextFile : {contents : string, filename : string} -> unit
|
|
309 |
|
|
310 |
(* ------------------------------------------------------------------------- *)
|
|
311 |
(* Profiling and error reporting. *)
|
|
312 |
(* ------------------------------------------------------------------------- *)
|
|
313 |
|
|
314 |
val try : ('a -> 'b) -> 'a -> 'b
|
|
315 |
|
|
316 |
val chat : string -> unit
|
|
317 |
|
|
318 |
val warn : string -> unit
|
|
319 |
|
|
320 |
val die : string -> 'exit
|
|
321 |
|
|
322 |
val timed : ('a -> 'b) -> 'a -> real * 'b
|
|
323 |
|
|
324 |
val timedMany : ('a -> 'b) -> 'a -> real * 'b
|
|
325 |
|
|
326 |
val executionTime : unit -> real (* Wall clock execution time *)
|
|
327 |
|
|
328 |
end
|