src/Pure/library.ML
author wenzelm
Thu Oct 04 20:29:42 2007 +0200 (2007-10-04)
changeset 24850 0cfd722ab579
parent 24846 d8ff870a11ff
child 24864 f33ff5fc1f7e
permissions -rw-r--r--
Name.uu, Name.aT;
wenzelm@41
     1
(*  Title:      Pure/library.ML
clasohm@0
     2
    ID:         $Id$
wenzelm@233
     3
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
wenzelm@16188
     4
    Author:     Markus Wenzel, TU Muenchen
clasohm@0
     5
wenzelm@233
     6
Basic library: functions, options, pairs, booleans, lists, integers,
wenzelm@23424
     7
strings, lists as sets, orders, current directory, misc.
wenzelm@21395
     8
wenzelm@21395
     9
See also General/basics.ML for the most fundamental concepts.
clasohm@0
    10
*)
clasohm@0
    11
wenzelm@21395
    12
infix 1 |>>>
wenzelm@21395
    13
infix 2 ?
wenzelm@21395
    14
infix 3 o oo ooo oooo
wenzelm@21395
    15
infix 4 ~~ upto downto
haftmann@20854
    16
infix orf andf \ \\ mem mem_int mem_string union union_int
wenzelm@21395
    17
  union_string inter inter_int inter_string subset subset_int subset_string
wenzelm@5893
    18
wenzelm@15745
    19
signature BASIC_LIBRARY =
wenzelm@4621
    20
sig
wenzelm@4621
    21
  (*functions*)
wenzelm@23860
    22
  val undefined: 'a -> 'b
wenzelm@16842
    23
  val I: 'a -> 'a
wenzelm@16842
    24
  val K: 'a -> 'b -> 'a
wenzelm@23220
    25
  val flip: ('a -> 'b -> 'c) -> 'b -> 'a -> 'c
wenzelm@4621
    26
  val curry: ('a * 'b -> 'c) -> 'a -> 'b -> 'c
wenzelm@4621
    27
  val uncurry: ('a -> 'b -> 'c) -> 'a * 'b -> 'c
haftmann@21335
    28
  val |>>> : ('a * 'c) * ('a -> 'b * 'd) -> 'b * ('c * 'd)
wenzelm@21565
    29
  val ? : bool * ('a -> 'a) -> 'a -> 'a
wenzelm@16721
    30
  val oo: ('a -> 'b) * ('c -> 'd -> 'a) -> 'c -> 'd -> 'b
wenzelm@16721
    31
  val ooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'a) -> 'c -> 'd -> 'e -> 'b
wenzelm@16721
    32
  val oooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'f -> 'a) -> 'c -> 'd -> 'e -> 'f -> 'b
wenzelm@16842
    33
  val funpow: int -> ('a -> 'a) -> 'a -> 'a
clasohm@1364
    34
wenzelm@18681
    35
  (*errors*)
wenzelm@19542
    36
  exception SYS_ERROR of string
wenzelm@19542
    37
  val sys_error: string -> 'a
wenzelm@18681
    38
  exception ERROR of string
wenzelm@18681
    39
  val error: string -> 'a
wenzelm@18681
    40
  val cat_error: string -> string -> 'a
wenzelm@18681
    41
  val assert_all: ('a -> bool) -> 'a list -> ('a -> string) -> unit
wenzelm@18681
    42
wenzelm@4621
    43
  (*pairs*)
wenzelm@4621
    44
  val pair: 'a -> 'b -> 'a * 'b
wenzelm@4621
    45
  val rpair: 'a -> 'b -> 'b * 'a
wenzelm@4621
    46
  val fst: 'a * 'b -> 'a
wenzelm@4621
    47
  val snd: 'a * 'b -> 'b
haftmann@17498
    48
  val eq_fst: ('a * 'c -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@17498
    49
  val eq_snd: ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@19454
    50
  val eq_pair: ('a * 'c -> bool) -> ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
wenzelm@4621
    51
  val swap: 'a * 'b -> 'b * 'a
wenzelm@4621
    52
  val apfst: ('a -> 'b) -> 'a * 'c -> 'b * 'c
wenzelm@4621
    53
  val apsnd: ('a -> 'b) -> 'c * 'a -> 'c * 'b
wenzelm@4621
    54
  val pairself: ('a -> 'b) -> 'a * 'a -> 'b * 'b
wenzelm@4621
    55
wenzelm@4621
    56
  (*booleans*)
wenzelm@4621
    57
  val equal: ''a -> ''a -> bool
wenzelm@4621
    58
  val not_equal: ''a -> ''a -> bool
wenzelm@4621
    59
  val orf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    60
  val andf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    61
  val exists: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    62
  val forall: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    63
  val set: bool ref -> bool
wenzelm@4621
    64
  val reset: bool ref -> bool
wenzelm@4621
    65
  val toggle: bool ref -> bool
wenzelm@9118
    66
  val change: 'a ref -> ('a -> 'a) -> unit
wenzelm@23932
    67
  val setmp_noncritical: 'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c
wenzelm@4621
    68
  val setmp: 'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c
wenzelm@4621
    69
wenzelm@4621
    70
  (*lists*)
skalberg@15570
    71
  exception UnequalLengths
wenzelm@5285
    72
  val single: 'a -> 'a list
wenzelm@20882
    73
  val the_single: 'a list -> 'a
wenzelm@19273
    74
  val singleton: ('a list -> 'b list) -> 'a -> 'b
wenzelm@5904
    75
  val apply: ('a -> 'a) list -> 'a -> 'a
wenzelm@15760
    76
  val foldr1: ('a * 'a -> 'a) -> 'a list -> 'a
haftmann@18278
    77
  val foldl_map: ('a * 'b -> 'a * 'c) -> 'a * 'b list -> 'a * 'c list
wenzelm@19461
    78
  val flat: 'a list list -> 'a list
wenzelm@19424
    79
  val unflat: 'a list list -> 'b list -> 'b list list
haftmann@18441
    80
  val burrow: ('a list -> 'b list) -> 'a list list -> 'b list list
haftmann@18549
    81
  val fold_burrow: ('a list -> 'c -> 'b list * 'd) -> 'a list list -> 'c -> 'b list list * 'd
wenzelm@21395
    82
  val maps: ('a -> 'b list) -> 'a list -> 'b list
wenzelm@19011
    83
  val chop: int -> 'a list -> 'a list * 'a list
nipkow@4713
    84
  val dropwhile: ('a -> bool) -> 'a list -> 'a list
haftmann@18278
    85
  val nth: 'a list -> int -> 'a
haftmann@18011
    86
  val nth_map: int -> ('a -> 'a) -> 'a list -> 'a list
haftmann@24846
    87
  val nth_drop: int -> 'a list -> 'a list
wenzelm@18286
    88
  val nth_list: 'a list list -> int -> 'a list
haftmann@18514
    89
  val map_index: (int * 'a -> 'b) -> 'a list -> 'b list
haftmann@18514
    90
  val fold_index: (int * 'a -> 'b -> 'b) -> 'a list -> 'b -> 'b
wenzelm@4621
    91
  val split_last: 'a list -> 'a list * 'a
wenzelm@4621
    92
  val find_index: ('a -> bool) -> 'a list -> int
wenzelm@4621
    93
  val find_index_eq: ''a -> ''a list -> int
wenzelm@4621
    94
  val find_first: ('a -> bool) -> 'a list -> 'a option
haftmann@19233
    95
  val get_index: ('a -> 'b option) -> 'a list -> (int * 'b) option
wenzelm@4916
    96
  val get_first: ('a -> 'b option) -> 'a list -> 'b option
haftmann@19454
    97
  val eq_list: ('a * 'b -> bool) -> 'a list * 'b list -> bool
haftmann@18330
    98
  val map2: ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
haftmann@18330
    99
  val fold2: ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
wenzelm@19799
   100
  val zip_options: 'a list -> 'b option list -> ('a * 'b) list
haftmann@18330
   101
  val ~~ : 'a list * 'b list -> ('a * 'b) list
haftmann@18330
   102
  val split_list: ('a * 'b) list -> 'a list * 'b list
wenzelm@4621
   103
  val separate: 'a -> 'a list -> 'a list
wenzelm@4621
   104
  val replicate: int -> 'a -> 'a list
wenzelm@18148
   105
  val multiply: 'a list -> 'a list list -> 'a list list
wenzelm@14792
   106
  val product: 'a list -> 'b list -> ('a * 'b) list
wenzelm@16129
   107
  val filter: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   108
  val filter_out: ('a -> bool) -> 'a list -> 'a list
wenzelm@19483
   109
  val map_filter: ('a -> 'b option) -> 'a list -> 'b list
haftmann@18441
   110
  val is_prefix: ('a * 'a -> bool) -> 'a list -> 'a list -> bool
wenzelm@4621
   111
  val take_prefix: ('a -> bool) -> 'a list -> 'a list * 'a list
haftmann@20108
   112
  val chop_prefix: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list * ('a list * 'b list)
wenzelm@4621
   113
  val take_suffix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@12249
   114
  val prefixes1: 'a list -> 'a list list
wenzelm@19011
   115
  val prefixes: 'a list -> 'a list list
wenzelm@12249
   116
  val suffixes1: 'a list -> 'a list list
wenzelm@19011
   117
  val suffixes: 'a list -> 'a list list
wenzelm@4621
   118
wenzelm@4621
   119
  (*integers*)
wenzelm@4621
   120
  val inc: int ref -> int
wenzelm@4621
   121
  val dec: int ref -> int
wenzelm@4621
   122
  val upto: int * int -> int list
wenzelm@4621
   123
  val downto: int * int -> int list
wenzelm@4621
   124
  val radixpand: int * int -> int list
wenzelm@4621
   125
  val radixstring: int * string * int -> string
wenzelm@4621
   126
  val string_of_int: int -> string
wenzelm@21942
   127
  val signed_string_of_int: int -> string
wenzelm@4621
   128
  val string_of_indexname: string * int -> string
wenzelm@24630
   129
  val read_radix_int: int -> string list -> int * string list
wenzelm@14826
   130
  val read_int: string list -> int * string list
wenzelm@14826
   131
  val oct_char: string -> string
wenzelm@4621
   132
wenzelm@4621
   133
  (*strings*)
haftmann@18011
   134
  val nth_string: string -> int -> string
wenzelm@16188
   135
  val fold_string: (string -> 'a -> 'a) -> string -> 'a -> 'a
wenzelm@6312
   136
  val exists_string: (string -> bool) -> string -> bool
wenzelm@16188
   137
  val forall_string: (string -> bool) -> string -> bool
wenzelm@4621
   138
  val enclose: string -> string -> string -> string
wenzelm@6642
   139
  val unenclose: string -> string
wenzelm@4621
   140
  val quote: string -> string
wenzelm@4621
   141
  val space_implode: string -> string list -> string
wenzelm@4621
   142
  val commas: string list -> string
wenzelm@4621
   143
  val commas_quote: string list -> string
wenzelm@4621
   144
  val cat_lines: string list -> string
wenzelm@4621
   145
  val space_explode: string -> string -> string list
wenzelm@14826
   146
  val split_lines: string -> string list
wenzelm@5942
   147
  val prefix_lines: string -> string -> string
wenzelm@7712
   148
  val untabify: string list -> string list
wenzelm@18681
   149
  val prefix: string -> string -> string
wenzelm@5285
   150
  val suffix: string -> string -> string
wenzelm@18681
   151
  val unprefix: string -> string -> string
wenzelm@5285
   152
  val unsuffix: string -> string -> string
wenzelm@10951
   153
  val replicate_string: int -> string -> string
wenzelm@14926
   154
  val translate_string: (string -> string) -> string -> string
wenzelm@4621
   155
wenzelm@16492
   156
  (*lists as sets -- see also Pure/General/ord_list.ML*)
wenzelm@18923
   157
  val member: ('b * 'a -> bool) -> 'a list -> 'b -> bool
wenzelm@18923
   158
  val insert: ('a * 'a -> bool) -> 'a -> 'a list -> 'a list
wenzelm@18923
   159
  val remove: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
wenzelm@24049
   160
  val update: ('a * 'a -> bool) -> 'a -> 'a list -> 'a list
wenzelm@19301
   161
  val subtract: ('b * 'a -> bool) -> 'b list -> 'a list -> 'a list
wenzelm@18923
   162
  val merge: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
wenzelm@4621
   163
  val mem: ''a * ''a list -> bool
wenzelm@4621
   164
  val mem_int: int * int list -> bool
wenzelm@4621
   165
  val mem_string: string * string list -> bool
wenzelm@4621
   166
  val union: ''a list * ''a list -> ''a list
wenzelm@4621
   167
  val union_int: int list * int list -> int list
wenzelm@4621
   168
  val union_string: string list * string list -> string list
wenzelm@4621
   169
  val gen_union: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
paulson@7090
   170
  val gen_inter: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   171
  val inter: ''a list * ''a list -> ''a list
wenzelm@4621
   172
  val inter_int: int list * int list -> int list
wenzelm@4621
   173
  val inter_string: string list * string list -> string list
wenzelm@4621
   174
  val subset: ''a list * ''a list -> bool
wenzelm@4621
   175
  val subset_int: int list * int list -> bool
wenzelm@4621
   176
  val subset_string: string list * string list -> bool
wenzelm@4621
   177
  val eq_set: ''a list * ''a list -> bool
wenzelm@4621
   178
  val eq_set_string: string list * string list -> bool
wenzelm@4621
   179
  val gen_subset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@19301
   180
  val gen_eq_set: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   181
  val \ : ''a list * ''a -> ''a list
wenzelm@4621
   182
  val \\ : ''a list * ''a list -> ''a list
wenzelm@19046
   183
  val distinct: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@18966
   184
  val duplicates: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@16878
   185
  val has_duplicates: ('a * 'a -> bool) -> 'a list -> bool
wenzelm@4621
   186
wenzelm@23220
   187
  (*lists as multisets*)
nipkow@22142
   188
  val remove1: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
wenzelm@23220
   189
  val submultiset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   190
wenzelm@4621
   191
  (*orders*)
wenzelm@18966
   192
  val is_equal: order -> bool
wenzelm@4621
   193
  val rev_order: order -> order
wenzelm@4621
   194
  val make_ord: ('a * 'a -> bool) -> 'a * 'a -> order
wenzelm@4621
   195
  val int_ord: int * int -> order
wenzelm@4621
   196
  val string_ord: string * string -> order
wenzelm@16676
   197
  val fast_string_ord: string * string -> order
wenzelm@16492
   198
  val option_ord: ('a * 'b -> order) -> 'a option * 'b option -> order
wenzelm@4621
   199
  val prod_ord: ('a * 'b -> order) -> ('c * 'd -> order) -> ('a * 'c) * ('b * 'd) -> order
wenzelm@4621
   200
  val dict_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   201
  val list_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   202
  val sort: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@18427
   203
  val sort_distinct: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@4621
   204
  val sort_strings: string list -> string list
wenzelm@4621
   205
  val sort_wrt: ('a -> string) -> 'a list -> 'a list
wenzelm@4621
   206
berghofe@14106
   207
  (*random numbers*)
berghofe@14106
   208
  exception RANDOM
berghofe@14106
   209
  val random: unit -> real
berghofe@14106
   210
  val random_range: int -> int -> int
berghofe@14106
   211
  val one_of: 'a list -> 'a
berghofe@14106
   212
  val frequency: (int * 'a) list -> 'a
berghofe@14106
   213
wenzelm@4621
   214
  (*misc*)
wenzelm@19644
   215
  val divide_and_conquer: ('a -> 'a list * ('b list -> 'b)) -> 'a -> 'b
wenzelm@4621
   216
  val partition_eq: ('a * 'a -> bool) -> 'a list -> 'a list list
wenzelm@4621
   217
  val partition_list: (int -> 'a -> bool) -> int -> int -> 'a list -> 'a list list
wenzelm@4621
   218
  val gensym: string -> string
wenzelm@16439
   219
  type stamp
wenzelm@16439
   220
  val stamp: unit -> stamp
wenzelm@16439
   221
  type serial
wenzelm@16439
   222
  val serial: unit -> serial
wenzelm@19512
   223
  val serial_string: unit -> string
wenzelm@16535
   224
  structure Object: sig type T end
wenzelm@4621
   225
end;
wenzelm@4621
   226
wenzelm@15745
   227
signature LIBRARY =
skalberg@15570
   228
sig
wenzelm@15745
   229
  include BASIC_LIBRARY
skalberg@15570
   230
  val foldl: ('a * 'b -> 'a) -> 'a * 'b list -> 'a
skalberg@15570
   231
  val foldr: ('a * 'b -> 'b) -> 'a list * 'b -> 'b
skalberg@15570
   232
  val take: int * 'a list -> 'a list
skalberg@15570
   233
  val drop: int * 'a list -> 'a list
skalberg@15570
   234
  val last_elem: 'a list -> 'a
skalberg@15570
   235
end;
skalberg@15570
   236
wenzelm@15745
   237
structure Library: LIBRARY =
clasohm@1364
   238
struct
clasohm@0
   239
wenzelm@21395
   240
(* functions *)
clasohm@0
   241
wenzelm@23860
   242
fun undefined _ = raise Match;
wenzelm@23860
   243
wenzelm@16842
   244
fun I x = x;
wenzelm@16842
   245
fun K x = fn _ => x;
wenzelm@23220
   246
fun flip f x y = f y x;
wenzelm@233
   247
fun curry f x y = f (x, y);
wenzelm@233
   248
fun uncurry f (x, y) = f x y;
clasohm@0
   249
wenzelm@21395
   250
(*application and structured results -- old version*)
wenzelm@16705
   251
fun (x, y) |>>> f = let val (x', z) = f x in (x', (y, z)) end;
wenzelm@16842
   252
haftmann@17141
   253
(*conditional application*)
wenzelm@21565
   254
fun b ? f = fn x => if b then f x else x;
haftmann@17141
   255
wenzelm@16721
   256
(*composition with multiple args*)
wenzelm@16721
   257
fun (f oo g) x y = f (g x y);
wenzelm@16721
   258
fun (f ooo g) x y z = f (g x y z);
wenzelm@16721
   259
fun (f oooo g) x y z w = f (g x y z w);
wenzelm@16721
   260
wenzelm@233
   261
(*function exponentiation: f(...(f x)...) with n applications of f*)
wenzelm@24593
   262
fun funpow (0: int) _ x = x
wenzelm@23718
   263
  | funpow n f x = funpow (n - 1) f (f x);
wenzelm@160
   264
wenzelm@160
   265
wenzelm@18681
   266
(* errors *)
wenzelm@18681
   267
wenzelm@19542
   268
exception SYS_ERROR of string;
wenzelm@19542
   269
fun sys_error msg = raise SYS_ERROR msg;
wenzelm@19542
   270
wenzelm@18681
   271
exception ERROR of string;
wenzelm@18681
   272
fun error msg = raise ERROR msg;
wenzelm@18681
   273
wenzelm@18681
   274
fun cat_error "" msg = error msg
wenzelm@18681
   275
  | cat_error msg1 msg2 = error (msg1 ^ "\n" ^ msg2);
wenzelm@18681
   276
wenzelm@18681
   277
fun assert_all pred list msg =
wenzelm@18681
   278
  let
wenzelm@18681
   279
    fun ass [] = ()
wenzelm@18681
   280
      | ass (x :: xs) = if pred x then ass xs else error (msg x);
wenzelm@18681
   281
  in ass list end;
wenzelm@18681
   282
wenzelm@18681
   283
wenzelm@21395
   284
(* pairs *)
wenzelm@233
   285
wenzelm@233
   286
fun pair x y = (x, y);
wenzelm@233
   287
fun rpair x y = (y, x);
wenzelm@233
   288
wenzelm@233
   289
fun fst (x, y) = x;
wenzelm@233
   290
fun snd (x, y) = y;
wenzelm@233
   291
haftmann@17498
   292
fun eq_fst eq ((x1, _), (x2, _)) = eq (x1, x2);
haftmann@17498
   293
fun eq_snd eq ((_, y1), (_, y2)) = eq (y1, y2);
haftmann@19454
   294
fun eq_pair eqx eqy ((x1, y1), (x2, y2)) = eqx (x1, x2) andalso eqy (y1, y2);
wenzelm@233
   295
wenzelm@233
   296
fun swap (x, y) = (y, x);
wenzelm@233
   297
wenzelm@233
   298
fun apfst f (x, y) = (f x, y);
wenzelm@233
   299
fun apsnd f (x, y) = (x, f y);
wenzelm@4212
   300
fun pairself f (x, y) = (f x, f y);
wenzelm@233
   301
wenzelm@233
   302
wenzelm@21395
   303
(* booleans *)
wenzelm@233
   304
wenzelm@21395
   305
(*polymorphic equality*)
wenzelm@233
   306
fun equal x y = x = y;
wenzelm@233
   307
fun not_equal x y = x <> y;
wenzelm@233
   308
wenzelm@21395
   309
(*combining predicates*)
wenzelm@16721
   310
fun p orf q = fn x => p x orelse q x;
wenzelm@16721
   311
fun p andf q = fn x => p x andalso q x;
wenzelm@233
   312
wenzelm@233
   313
(*exists pred [x1, ..., xn] ===> pred x1 orelse ... orelse pred xn*)
wenzelm@233
   314
fun exists (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   315
  let fun boolf [] = false
wenzelm@233
   316
        | boolf (x :: xs) = pred x orelse boolf xs
wenzelm@233
   317
  in boolf end;
wenzelm@233
   318
wenzelm@233
   319
(*forall pred [x1, ..., xn] ===> pred x1 andalso ... andalso pred xn*)
wenzelm@233
   320
fun forall (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   321
  let fun boolf [] = true
wenzelm@233
   322
        | boolf (x :: xs) = pred x andalso boolf xs
wenzelm@233
   323
  in boolf end;
clasohm@0
   324
wenzelm@19644
   325
wenzelm@380
   326
(* flags *)
wenzelm@380
   327
wenzelm@380
   328
fun set flag = (flag := true; true);
wenzelm@380
   329
fun reset flag = (flag := false; false);
wenzelm@380
   330
fun toggle flag = (flag := not (! flag); ! flag);
wenzelm@380
   331
wenzelm@9118
   332
fun change r f = r := f (! r);
wenzelm@9118
   333
wenzelm@18712
   334
(*temporarily set flag during execution*)
wenzelm@23932
   335
fun setmp_noncritical flag value f x =
wenzelm@2958
   336
  let
wenzelm@2958
   337
    val orig_value = ! flag;
wenzelm@18712
   338
    val _ = flag := value;
wenzelm@23963
   339
    val result = Exn.capture f x;
wenzelm@18712
   340
    val _ = flag := orig_value;
wenzelm@23963
   341
  in Exn.release result end;
wenzelm@2958
   342
wenzelm@24023
   343
fun setmp flag value f x = NAMED_CRITICAL "setmp" (fn () => setmp_noncritical flag value f x);
wenzelm@23932
   344
wenzelm@19644
   345
wenzelm@21395
   346
wenzelm@233
   347
(** lists **)
wenzelm@233
   348
skalberg@15570
   349
exception UnequalLengths;
wenzelm@233
   350
wenzelm@5285
   351
fun single x = [x];
wenzelm@233
   352
wenzelm@20882
   353
fun the_single [x] = x
wenzelm@20882
   354
  | the_single _ = raise Empty;
wenzelm@20882
   355
wenzelm@20882
   356
fun singleton f x = the_single (f [x]);
wenzelm@19273
   357
wenzelm@5904
   358
fun apply [] x = x
wenzelm@5904
   359
  | apply (f :: fs) x = apply fs (f x);
wenzelm@5904
   360
wenzelm@233
   361
wenzelm@21395
   362
(* fold -- old versions *)
haftmann@16691
   363
wenzelm@233
   364
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   365
wenzelm@233
   366
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   367
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   368
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   369
  let fun itl (e, [])  = e
wenzelm@233
   370
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   371
  in  itl end;
wenzelm@233
   372
wenzelm@233
   373
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   374
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   375
fun foldr f (l, e) =
wenzelm@233
   376
  let fun itr [] = e
wenzelm@233
   377
        | itr (a::l) = f(a, itr l)
wenzelm@233
   378
  in  itr l  end;
wenzelm@233
   379
wenzelm@233
   380
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   381
    for n > 0, operators that associate to the right (not tail recursive)*)
paulson@20443
   382
fun foldr1 f [] = raise Empty
wenzelm@20510
   383
  | foldr1 f l =
paulson@20443
   384
      let fun itr [x] = x
wenzelm@20510
   385
            | itr (x::l) = f(x, itr l)
paulson@20443
   386
      in  itr l  end;
wenzelm@233
   387
wenzelm@16705
   388
fun foldl_map f =
wenzelm@16705
   389
  let
wenzelm@16705
   390
    fun fold_aux (x, []) = (x, [])
wenzelm@16705
   391
      | fold_aux (x, y :: ys) =
wenzelm@16705
   392
          let
wenzelm@16705
   393
            val (x', y') = f (x, y);
wenzelm@16705
   394
            val (x'', ys') = fold_aux (x', ys);
wenzelm@16705
   395
          in (x'', y' :: ys') end;
wenzelm@16705
   396
  in fold_aux end;
wenzelm@16705
   397
wenzelm@233
   398
wenzelm@233
   399
(* basic list functions *)
wenzelm@233
   400
wenzelm@20510
   401
fun eq_list eq (list1, list2) =
haftmann@20348
   402
  let
wenzelm@20510
   403
    fun eq_lst (x :: xs, y :: ys) = eq (x, y) andalso eq_lst (xs, ys)
wenzelm@20510
   404
      | eq_lst _ = true;
wenzelm@20510
   405
  in length list1 = length list2 andalso eq_lst (list1, list2) end;
haftmann@20348
   406
wenzelm@19483
   407
fun maps f [] = []
wenzelm@19483
   408
  | maps f (x :: xs) = f x @ maps f xs;
wenzelm@19483
   409
wenzelm@24593
   410
fun chop (0: int) xs = ([], xs)
wenzelm@23220
   411
  | chop _ [] = ([], [])
wenzelm@23220
   412
  | chop n (x :: xs) = chop (n - 1) xs |>> cons x;
wenzelm@19011
   413
wenzelm@233
   414
(*take the first n elements from a list*)
wenzelm@24593
   415
fun take (n: int, []) = []
wenzelm@233
   416
  | take (n, x :: xs) =
wenzelm@233
   417
      if n > 0 then x :: take (n - 1, xs) else [];
wenzelm@233
   418
wenzelm@233
   419
(*drop the first n elements from a list*)
wenzelm@24593
   420
fun drop (n: int, []) = []
wenzelm@233
   421
  | drop (n, x :: xs) =
wenzelm@233
   422
      if n > 0 then drop (n - 1, xs) else x :: xs;
clasohm@0
   423
nipkow@4713
   424
fun dropwhile P [] = []
nipkow@4713
   425
  | dropwhile P (ys as x::xs) = if P x then dropwhile P xs else ys;
nipkow@4713
   426
wenzelm@233
   427
(*return nth element of a list, where 0 designates the first element;
wenzelm@18461
   428
  raise Subscript if list too short*)
haftmann@18011
   429
fun nth xs i = List.nth (xs, i);
wenzelm@233
   430
wenzelm@18461
   431
fun nth_list xss i = nth xss i handle Subscript => [];
wenzelm@18461
   432
haftmann@18011
   433
fun nth_map 0 f (x :: xs) = f x :: xs
haftmann@18011
   434
  | nth_map n f (x :: xs) = x :: nth_map (n - 1) f xs
wenzelm@24593
   435
  | nth_map (_: int) _ [] = raise Subscript;
wenzelm@11773
   436
haftmann@24846
   437
fun nth_drop n xs =
haftmann@24846
   438
  List.take (xs, n) @ List.drop (xs, n + 1);
haftmann@24846
   439
haftmann@18514
   440
fun map_index f =
haftmann@18514
   441
  let
wenzelm@24593
   442
    fun mapp (_: int) [] = []
wenzelm@24593
   443
      | mapp i (x :: xs) = f (i, x) :: mapp (i + 1) xs
haftmann@18514
   444
  in mapp 0 end;
haftmann@18514
   445
haftmann@21118
   446
fun fold_index f =
haftmann@21118
   447
  let
wenzelm@24593
   448
    fun fold_aux (_: int) [] y = y
wenzelm@24593
   449
      | fold_aux i (x :: xs) y = fold_aux (i + 1) xs (f (i, x) y);
haftmann@21118
   450
  in fold_aux 0 end;
haftmann@21118
   451
skalberg@15570
   452
val last_elem = List.last;
wenzelm@233
   453
wenzelm@3762
   454
(*rear decomposition*)
skalberg@15570
   455
fun split_last [] = raise Empty
wenzelm@3762
   456
  | split_last [x] = ([], x)
wenzelm@3762
   457
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   458
wenzelm@4212
   459
(*find the position of an element in a list*)
wenzelm@4212
   460
fun find_index pred =
wenzelm@24593
   461
  let fun find (_: int) [] = ~1
wenzelm@4212
   462
        | find n (x :: xs) = if pred x then n else find (n + 1) xs;
wenzelm@4212
   463
  in find 0 end;
wenzelm@3762
   464
wenzelm@4224
   465
fun find_index_eq x = find_index (equal x);
wenzelm@4212
   466
wenzelm@4212
   467
(*find first element satisfying predicate*)
paulson@22593
   468
val find_first = List.find;
wenzelm@233
   469
wenzelm@4916
   470
(*get first element by lookup function*)
skalberg@15531
   471
fun get_first _ [] = NONE
wenzelm@4916
   472
  | get_first f (x :: xs) =
wenzelm@4916
   473
      (case f x of
skalberg@15531
   474
        NONE => get_first f xs
wenzelm@4916
   475
      | some => some);
wenzelm@4916
   476
haftmann@19233
   477
fun get_index f =
haftmann@19233
   478
  let
wenzelm@24593
   479
    fun get (_: int) [] = NONE
wenzelm@19461
   480
      | get i (x :: xs) =
haftmann@19233
   481
          case f x
wenzelm@19461
   482
           of NONE => get (i + 1) xs
haftmann@19233
   483
            | SOME y => SOME (i, y)
haftmann@19233
   484
  in get 0 end;
haftmann@19233
   485
skalberg@15531
   486
val flat = List.concat;
wenzelm@233
   487
wenzelm@12136
   488
fun unflat (xs :: xss) ys =
wenzelm@19424
   489
      let val (ps, qs) = chop (length xs) ys
nipkow@13629
   490
      in ps :: unflat xss qs end
wenzelm@12136
   491
  | unflat [] [] = []
skalberg@15570
   492
  | unflat _ _ = raise UnequalLengths;
wenzelm@12136
   493
wenzelm@21479
   494
fun burrow f xss = unflat xss (f (flat xss));
haftmann@18359
   495
haftmann@18549
   496
fun fold_burrow f xss s =
haftmann@18549
   497
  apfst (unflat xss) (f (flat xss) s);
haftmann@18359
   498
wenzelm@233
   499
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   500
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   501
  | separate _ xs = xs;
wenzelm@233
   502
wenzelm@233
   503
(*make the list [x, x, ..., x] of length n*)
wenzelm@24593
   504
fun replicate (n: int) x =
wenzelm@233
   505
  let fun rep (0, xs) = xs
wenzelm@233
   506
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   507
  in
skalberg@15570
   508
    if n < 0 then raise Subscript
wenzelm@233
   509
    else rep (n, [])
wenzelm@233
   510
  end;
wenzelm@233
   511
wenzelm@14926
   512
fun translate_string f = String.translate (f o String.str);
wenzelm@14926
   513
wenzelm@4248
   514
(*multiply [a, b, c, ...] * [xs, ys, zs, ...]*)
wenzelm@18148
   515
fun multiply [] _ = []
wenzelm@18148
   516
  | multiply (x :: xs) yss = map (cons x) yss @ multiply xs yss;
wenzelm@4248
   517
wenzelm@14792
   518
(*direct product*)
wenzelm@14792
   519
fun product _ [] = []
wenzelm@14792
   520
  | product [] _ = []
wenzelm@14792
   521
  | product (x :: xs) ys = map (pair x) ys @ product xs ys;
wenzelm@14792
   522
wenzelm@233
   523
wenzelm@233
   524
(* filter *)
wenzelm@233
   525
wenzelm@233
   526
(*copy the list preserving elements that satisfy the predicate*)
skalberg@15531
   527
val filter = List.filter;
clasohm@0
   528
fun filter_out f = filter (not o f);
wenzelm@19483
   529
val map_filter = List.mapPartial;
wenzelm@233
   530
wenzelm@233
   531
wenzelm@233
   532
(* lists of pairs *)
wenzelm@233
   533
skalberg@15570
   534
exception UnequalLengths;
skalberg@15570
   535
haftmann@18330
   536
fun map2 _ [] [] = []
haftmann@18330
   537
  | map2 f (x :: xs) (y :: ys) = f x y :: map2 f xs ys
haftmann@18330
   538
  | map2 _ _ _ = raise UnequalLengths;
wenzelm@380
   539
wenzelm@23220
   540
fun fold2 f [] [] z = z
wenzelm@23220
   541
  | fold2 f (x :: xs) (y :: ys) z = fold2 f xs ys (f x y z)
wenzelm@23220
   542
  | fold2 f _ _ _ = raise UnequalLengths;
wenzelm@380
   543
wenzelm@19799
   544
fun zip_options (x :: xs) (SOME y :: ys) = (x, y) :: zip_options xs ys
wenzelm@19799
   545
  | zip_options (_ :: xs) (NONE :: ys) = zip_options xs ys
wenzelm@19799
   546
  | zip_options _ [] = []
wenzelm@19799
   547
  | zip_options [] _ = raise UnequalLengths;
wenzelm@4956
   548
wenzelm@233
   549
(*combine two lists forming a list of pairs:
wenzelm@233
   550
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   551
fun [] ~~ [] = []
wenzelm@233
   552
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
skalberg@15570
   553
  | _ ~~ _ = raise UnequalLengths;
wenzelm@233
   554
wenzelm@233
   555
(*inverse of ~~; the old 'split':
wenzelm@233
   556
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
skalberg@15570
   557
val split_list = ListPair.unzip;
wenzelm@233
   558
wenzelm@233
   559
wenzelm@233
   560
(* prefixes, suffixes *)
wenzelm@233
   561
haftmann@18441
   562
fun is_prefix _ [] _ = true
haftmann@18441
   563
  | is_prefix eq (x :: xs) (y :: ys) = eq (x, y) andalso is_prefix eq xs ys
haftmann@18441
   564
  | is_prefix eq _ _ = false;
wenzelm@233
   565
wenzelm@233
   566
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   567
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   568
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   569
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   570
        | take (rxs, x :: xs) =
wenzelm@255
   571
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   572
  in  take([], xs)  end;
wenzelm@233
   573
haftmann@20108
   574
fun chop_prefix eq ([], ys) = ([], ([], ys))
haftmann@20108
   575
  | chop_prefix eq (xs, []) = ([], (xs, []))
wenzelm@23220
   576
  | chop_prefix eq (xs as x :: xs', ys as y :: ys') =
haftmann@20108
   577
      if eq (x, y) then
haftmann@20108
   578
        let val (ps', xys'') = chop_prefix eq (xs', ys')
wenzelm@23220
   579
        in (x :: ps', xys'') end
haftmann@20108
   580
      else ([], (xs, ys));
haftmann@20108
   581
wenzelm@233
   582
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   583
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   584
fun take_suffix _ [] = ([], [])
wenzelm@233
   585
  | take_suffix pred (x :: xs) =
wenzelm@233
   586
      (case take_suffix pred xs of
wenzelm@233
   587
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   588
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   589
wenzelm@12249
   590
fun prefixes1 [] = []
wenzelm@12249
   591
  | prefixes1 (x :: xs) = map (cons x) ([] :: prefixes1 xs);
wenzelm@12249
   592
wenzelm@19011
   593
fun prefixes xs = [] :: prefixes1 xs;
wenzelm@19011
   594
wenzelm@12249
   595
fun suffixes1 xs = map rev (prefixes1 (rev xs));
wenzelm@19011
   596
fun suffixes xs = [] :: suffixes1 xs;
wenzelm@233
   597
wenzelm@23220
   598
wenzelm@23220
   599
wenzelm@233
   600
(** integers **)
wenzelm@233
   601
wenzelm@24593
   602
fun inc i = (i := ! i + (1: int); ! i);
wenzelm@24593
   603
fun dec i = (i := ! i - (1: int); ! i);
wenzelm@233
   604
wenzelm@233
   605
wenzelm@233
   606
(* lists of integers *)
wenzelm@233
   607
wenzelm@233
   608
(*make the list [from, from + 1, ..., to]*)
wenzelm@24593
   609
fun ((i: int) upto j) =
wenzelm@21859
   610
  if i > j then [] else i :: (i + 1 upto j);
wenzelm@233
   611
wenzelm@233
   612
(*make the list [from, from - 1, ..., to]*)
wenzelm@24593
   613
fun ((i: int) downto j) =
wenzelm@21859
   614
  if i < j then [] else i :: (i - 1 downto j);
wenzelm@233
   615
wenzelm@233
   616
wenzelm@233
   617
(* convert integers to strings *)
wenzelm@233
   618
wenzelm@233
   619
(*expand the number in the given base;
wenzelm@233
   620
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   621
fun radixpand (base, num) : int list =
wenzelm@233
   622
  let
wenzelm@233
   623
    fun radix (n, tail) =
wenzelm@233
   624
      if n < base then n :: tail
wenzelm@233
   625
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   626
  in radix (num, []) end;
wenzelm@233
   627
wenzelm@233
   628
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   629
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   630
fun radixstring (base, zerochar, num) =
wenzelm@233
   631
  let val offset = ord zerochar;
wenzelm@233
   632
      fun chrof n = chr (offset + n)
wenzelm@233
   633
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   634
wenzelm@233
   635
paulson@3407
   636
val string_of_int = Int.toString;
wenzelm@233
   637
wenzelm@21942
   638
fun signed_string_of_int i =
wenzelm@21942
   639
  if i < 0 then "-" ^ string_of_int (~ i) else string_of_int i;
wenzelm@21942
   640
wenzelm@23220
   641
fun string_of_indexname (a, 0) = a
wenzelm@23220
   642
  | string_of_indexname (a, i) = a ^ "_" ^ string_of_int i;
wenzelm@233
   643
wenzelm@233
   644
wenzelm@14826
   645
(* read integers *)
wenzelm@14826
   646
wenzelm@24630
   647
fun read_radix_int radix cs =
wenzelm@20095
   648
  let
wenzelm@20095
   649
    val zero = ord "0";
wenzelm@20095
   650
    val limit = zero + radix;
wenzelm@20095
   651
    fun scan (num, []) = (num, [])
wenzelm@20095
   652
      | scan (num, c :: cs) =
wenzelm@20095
   653
        if zero <= ord c andalso ord c < limit then
wenzelm@24630
   654
          scan (radix * num + (ord c - zero), cs)
wenzelm@20095
   655
        else (num, c :: cs);
wenzelm@24630
   656
  in scan (0, cs) end;
wenzelm@14826
   657
wenzelm@24630
   658
val read_int = read_radix_int 10;
wenzelm@14826
   659
wenzelm@24630
   660
fun oct_char s = chr (#1 (read_radix_int 8 (explode s)));
wenzelm@14826
   661
wenzelm@14826
   662
wenzelm@14826
   663
wenzelm@233
   664
(** strings **)
wenzelm@233
   665
wenzelm@16188
   666
(* functions tuned for strings, avoiding explode *)
wenzelm@6312
   667
haftmann@18011
   668
fun nth_string str i =
wenzelm@6959
   669
  (case try String.substring (str, i, 1) of
skalberg@15531
   670
    SOME s => s
skalberg@15570
   671
  | NONE => raise Subscript);
wenzelm@6312
   672
wenzelm@16188
   673
fun fold_string f str x0 =
wenzelm@6282
   674
  let
wenzelm@6282
   675
    val n = size str;
wenzelm@16188
   676
    fun iter (x, i) =
wenzelm@16188
   677
      if i < n then iter (f (String.substring (str, i, 1)) x, i + 1) else x;
wenzelm@16188
   678
  in iter (x0, 0) end;
wenzelm@6282
   679
wenzelm@14968
   680
fun exists_string pred str =
wenzelm@14968
   681
  let
wenzelm@14968
   682
    val n = size str;
wenzelm@14968
   683
    fun ex i = i < n andalso (pred (String.substring (str, i, 1)) orelse ex (i + 1));
wenzelm@14968
   684
  in ex 0 end;
wenzelm@6312
   685
wenzelm@16188
   686
fun forall_string pred = not o exists_string (not o pred);
wenzelm@16188
   687
lcp@512
   688
(*enclose in brackets*)
lcp@512
   689
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@6642
   690
fun unenclose str = String.substring (str, 1, size str - 2);
wenzelm@255
   691
wenzelm@233
   692
(*simple quoting (does not escape special chars)*)
lcp@512
   693
val quote = enclose "\"" "\"";
wenzelm@233
   694
wenzelm@4212
   695
(*space_implode "..." (explode "hello") = "h...e...l...l...o"*)
wenzelm@233
   696
fun space_implode a bs = implode (separate a bs);
wenzelm@233
   697
wenzelm@255
   698
val commas = space_implode ", ";
wenzelm@380
   699
val commas_quote = commas o map quote;
wenzelm@255
   700
wenzelm@233
   701
(*concatenate messages, one per line, into a string*)
wenzelm@255
   702
val cat_lines = space_implode "\n";
wenzelm@233
   703
wenzelm@4212
   704
(*space_explode "." "h.e..l.lo" = ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   705
fun space_explode _ "" = []
paulson@21899
   706
  | space_explode sep s = String.fields (fn c => str c = sep) s;
wenzelm@3832
   707
wenzelm@3832
   708
val split_lines = space_explode "\n";
wenzelm@3832
   709
wenzelm@14826
   710
fun prefix_lines "" txt = txt
wenzelm@14826
   711
  | prefix_lines prfx txt = txt |> split_lines |> map (fn s => prfx ^ s) |> cat_lines;
wenzelm@14826
   712
wenzelm@7712
   713
fun untabify chs =
wenzelm@7712
   714
  let
wenzelm@7712
   715
    val tab_width = 8;
wenzelm@7712
   716
wenzelm@22582
   717
    fun untab pos [] ys = rev ys
berghofe@22256
   718
      | untab pos ("\n" :: xs) ys = untab 0 xs ("\n" :: ys)
berghofe@22256
   719
      | untab pos ("\t" :: xs) ys =
wenzelm@22582
   720
          let val d = tab_width - (pos mod tab_width)
wenzelm@23718
   721
          in untab (pos + d) xs (funpow d (cons " ") ys) end
berghofe@22256
   722
      | untab pos (c :: xs) ys = untab (pos + 1) xs (c :: ys);
wenzelm@7712
   723
  in
wenzelm@19301
   724
    if not (exists (fn c => c = "\t") chs) then chs
berghofe@22256
   725
    else untab 0 chs []
wenzelm@7712
   726
  end;
wenzelm@7712
   727
wenzelm@18681
   728
fun prefix prfx s = prfx ^ s;
wenzelm@16188
   729
fun suffix sffx s = s ^ sffx;
wenzelm@5285
   730
wenzelm@18681
   731
fun unprefix prfx s =
wenzelm@18681
   732
  if String.isPrefix prfx s then String.substring (s, size prfx, size s - size prfx)
wenzelm@18681
   733
  else raise Fail "unprefix";
wenzelm@18681
   734
wenzelm@16188
   735
fun unsuffix sffx s =
wenzelm@17061
   736
  if String.isSuffix sffx s then String.substring (s, 0, size s - size sffx)
wenzelm@17061
   737
  else raise Fail "unsuffix";
wenzelm@5285
   738
wenzelm@24593
   739
fun replicate_string (0: int) _ = ""
wenzelm@10951
   740
  | replicate_string 1 a = a
wenzelm@10951
   741
  | replicate_string k a =
wenzelm@10951
   742
      if k mod 2 = 0 then replicate_string (k div 2) (a ^ a)
wenzelm@10951
   743
      else replicate_string (k div 2) (a ^ a) ^ a;
wenzelm@10951
   744
wenzelm@233
   745
wenzelm@23220
   746
wenzelm@16492
   747
(** lists as sets -- see also Pure/General/ord_list.ML **)
wenzelm@233
   748
wenzelm@18923
   749
(*canonical member, insert, remove*)
wenzelm@18923
   750
fun member eq list x =
wenzelm@18923
   751
  let
wenzelm@18923
   752
    fun memb [] = false
wenzelm@18923
   753
      | memb (y :: ys) = eq (x, y) orelse memb ys;
wenzelm@18923
   754
  in memb list end;
berghofe@1576
   755
wenzelm@18923
   756
fun insert eq x xs = if member eq xs x then xs else x :: xs;
wenzelm@18923
   757
fun remove eq x xs = if member eq xs x then filter_out (fn y => eq (x, y)) xs else xs;
wenzelm@24049
   758
fun update eq x xs = cons x (remove eq x xs);
wenzelm@233
   759
wenzelm@19301
   760
fun subtract eq = fold (remove eq);
wenzelm@19301
   761
wenzelm@18923
   762
fun merge _ ([], ys) = ys
wenzelm@18923
   763
  | merge eq (xs, ys) = fold_rev (insert eq) ys xs;
clasohm@0
   764
wenzelm@18923
   765
(*old-style infixes*)
wenzelm@18923
   766
fun x mem xs = member (op =) xs x;
wenzelm@18923
   767
fun (x: int) mem_int xs = member (op =) xs x;
wenzelm@18923
   768
fun (x: string) mem_string xs = member (op =) xs x;
berghofe@1576
   769
wenzelm@233
   770
wenzelm@233
   771
(*union of sets represented as lists: no repetitions*)
wenzelm@233
   772
fun xs union [] = xs
wenzelm@233
   773
  | [] union ys = ys
haftmann@20854
   774
  | (x :: xs) union ys = xs union (insert (op =) x ys);
clasohm@0
   775
paulson@2175
   776
(*union of sets, optimized version for ints*)
berghofe@1576
   777
fun (xs:int list) union_int [] = xs
berghofe@1576
   778
  | [] union_int ys = ys
haftmann@20854
   779
  | (x :: xs) union_int ys = xs union_int (insert (op =) x ys);
berghofe@1576
   780
paulson@2175
   781
(*union of sets, optimized version for strings*)
berghofe@1576
   782
fun (xs:string list) union_string [] = xs
berghofe@1576
   783
  | [] union_string ys = ys
haftmann@20854
   784
  | (x :: xs) union_string ys = xs union_string (insert (op =) x ys);
berghofe@1576
   785
clasohm@0
   786
(*generalized union*)
wenzelm@233
   787
fun gen_union eq (xs, []) = xs
wenzelm@233
   788
  | gen_union eq ([], ys) = ys
wenzelm@18923
   789
  | gen_union eq (x :: xs, ys) = gen_union eq (xs, insert eq x ys);
wenzelm@233
   790
wenzelm@233
   791
wenzelm@233
   792
(*intersection*)
wenzelm@233
   793
fun [] inter ys = []
wenzelm@233
   794
  | (x :: xs) inter ys =
wenzelm@233
   795
      if x mem ys then x :: (xs inter ys) else xs inter ys;
wenzelm@233
   796
paulson@2175
   797
(*intersection, optimized version for ints*)
berghofe@1576
   798
fun ([]:int list) inter_int ys = []
berghofe@1576
   799
  | (x :: xs) inter_int ys =
berghofe@1576
   800
      if x mem_int ys then x :: (xs inter_int ys) else xs inter_int ys;
berghofe@1576
   801
paulson@2175
   802
(*intersection, optimized version for strings *)
berghofe@1576
   803
fun ([]:string list) inter_string ys = []
berghofe@1576
   804
  | (x :: xs) inter_string ys =
berghofe@1576
   805
      if x mem_string ys then x :: (xs inter_string ys) else xs inter_string ys;
berghofe@1576
   806
paulson@7090
   807
(*generalized intersection*)
paulson@7090
   808
fun gen_inter eq ([], ys) = []
wenzelm@12284
   809
  | gen_inter eq (x::xs, ys) =
wenzelm@18923
   810
      if member eq ys x then x :: gen_inter eq (xs, ys)
wenzelm@18923
   811
      else gen_inter eq (xs, ys);
paulson@7090
   812
wenzelm@233
   813
wenzelm@233
   814
(*subset*)
wenzelm@233
   815
fun [] subset ys = true
wenzelm@233
   816
  | (x :: xs) subset ys = x mem ys andalso xs subset ys;
wenzelm@233
   817
paulson@2175
   818
(*subset, optimized version for ints*)
wenzelm@16439
   819
fun ([]: int list) subset_int ys = true
berghofe@1576
   820
  | (x :: xs) subset_int ys = x mem_int ys andalso xs subset_int ys;
berghofe@1576
   821
paulson@2175
   822
(*subset, optimized version for strings*)
wenzelm@16439
   823
fun ([]: string list) subset_string ys = true
berghofe@1576
   824
  | (x :: xs) subset_string ys = x mem_string ys andalso xs subset_string ys;
berghofe@1576
   825
wenzelm@4363
   826
(*set equality*)
wenzelm@4363
   827
fun eq_set (xs, ys) =
wenzelm@4363
   828
  xs = ys orelse (xs subset ys andalso ys subset xs);
wenzelm@4363
   829
paulson@2182
   830
(*set equality for strings*)
wenzelm@16439
   831
fun eq_set_string ((xs: string list), ys) =
berghofe@1576
   832
  xs = ys orelse (xs subset_string ys andalso ys subset_string xs);
berghofe@1576
   833
wenzelm@18923
   834
fun gen_subset eq (xs, ys) = forall (member eq ys) xs;
paulson@2182
   835
wenzelm@19301
   836
fun gen_eq_set eq (xs, ys) =
haftmann@20348
   837
  eq_list eq (xs, ys) orelse
wenzelm@19301
   838
    (gen_subset eq (xs, ys) andalso gen_subset (eq o swap) (ys, xs));
wenzelm@19301
   839
wenzelm@265
   840
wenzelm@233
   841
(*removing an element from a list WITHOUT duplicates*)
wenzelm@233
   842
fun (y :: ys) \ x = if x = y then ys else y :: (ys \ x)
wenzelm@233
   843
  | [] \ x = [];
paulson@2243
   844
fun ys \\ xs = foldl (op \) (ys,xs);
clasohm@0
   845
wenzelm@233
   846
wenzelm@233
   847
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
   848
  first of equal elements*)
wenzelm@19046
   849
fun distinct eq lst =
wenzelm@233
   850
  let
wenzelm@233
   851
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
   852
      | dist (rev_seen, x :: xs) =
wenzelm@18923
   853
          if member eq rev_seen x then dist (rev_seen, xs)
wenzelm@233
   854
          else dist (x :: rev_seen, xs);
wenzelm@19046
   855
  in dist ([], lst) end;
wenzelm@233
   856
wenzelm@255
   857
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
   858
  order, takes first of equal elements*)
wenzelm@18966
   859
fun duplicates eq lst =
wenzelm@255
   860
  let
wenzelm@255
   861
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
   862
      | dups (rev_dups, x :: xs) =
wenzelm@18923
   863
          if member eq rev_dups x orelse not (member eq xs x) then
wenzelm@255
   864
            dups (rev_dups, xs)
wenzelm@255
   865
          else dups (x :: rev_dups, xs);
wenzelm@18966
   866
  in dups ([], lst) end;
wenzelm@255
   867
wenzelm@16878
   868
fun has_duplicates eq =
wenzelm@16878
   869
  let
wenzelm@16878
   870
    fun dups [] = false
wenzelm@16878
   871
      | dups (x :: xs) = member eq xs x orelse dups xs;
wenzelm@16878
   872
  in dups end;
wenzelm@16878
   873
wenzelm@255
   874
wenzelm@23220
   875
nipkow@22142
   876
(** lists as multisets **)
nipkow@22142
   877
nipkow@22142
   878
fun remove1 _ _ [] = raise Empty
wenzelm@23220
   879
  | remove1 eq y (x::xs) = if eq (y, x) then xs else x :: remove1 eq y xs;
nipkow@22142
   880
wenzelm@23220
   881
fun submultiset _ ([], _)  = true
wenzelm@23220
   882
  | submultiset eq (x :: xs, ys) = member eq ys x andalso submultiset eq (xs, remove1 eq x ys);
wenzelm@233
   883
clasohm@0
   884
clasohm@0
   885
wenzelm@2506
   886
(** orders **)
wenzelm@2506
   887
wenzelm@18966
   888
fun is_equal EQUAL = true
wenzelm@18966
   889
  | is_equal _ = false;
wenzelm@18966
   890
wenzelm@4445
   891
fun rev_order LESS = GREATER
wenzelm@4445
   892
  | rev_order EQUAL = EQUAL
wenzelm@4445
   893
  | rev_order GREATER = LESS;
wenzelm@4445
   894
wenzelm@4479
   895
(*assume rel is a linear strict order*)
wenzelm@4445
   896
fun make_ord rel (x, y) =
wenzelm@4445
   897
  if rel (x, y) then LESS
wenzelm@4445
   898
  else if rel (y, x) then GREATER
wenzelm@4445
   899
  else EQUAL;
wenzelm@4445
   900
wenzelm@15051
   901
val int_ord = Int.compare;
wenzelm@15051
   902
val string_ord = String.compare;
wenzelm@2506
   903
wenzelm@16676
   904
fun fast_string_ord (s1, s2) =
wenzelm@16676
   905
  (case int_ord (size s1, size s2) of EQUAL => string_ord (s1, s2) | ord => ord);
wenzelm@16676
   906
wenzelm@16492
   907
fun option_ord ord (SOME x, SOME y) = ord (x, y)
wenzelm@16492
   908
  | option_ord _ (NONE, NONE) = EQUAL
wenzelm@16492
   909
  | option_ord _ (NONE, SOME _) = LESS
wenzelm@16492
   910
  | option_ord _ (SOME _, NONE) = GREATER;
wenzelm@16492
   911
wenzelm@4343
   912
(*lexicographic product*)
wenzelm@4343
   913
fun prod_ord a_ord b_ord ((x, y), (x', y')) =
wenzelm@4343
   914
  (case a_ord (x, x') of EQUAL => b_ord (y, y') | ord => ord);
wenzelm@4343
   915
wenzelm@4343
   916
(*dictionary order -- in general NOT well-founded!*)
wenzelm@16984
   917
fun dict_ord elem_ord (x :: xs, y :: ys) =
wenzelm@16984
   918
      (case elem_ord (x, y) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord)
wenzelm@16984
   919
  | dict_ord _ ([], []) = EQUAL
wenzelm@4343
   920
  | dict_ord _ ([], _ :: _) = LESS
wenzelm@16984
   921
  | dict_ord _ (_ :: _, []) = GREATER;
wenzelm@4343
   922
wenzelm@4343
   923
(*lexicographic product of lists*)
wenzelm@4343
   924
fun list_ord elem_ord (xs, ys) =
wenzelm@16676
   925
  (case int_ord (length xs, length ys) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord);
wenzelm@4343
   926
wenzelm@2506
   927
wenzelm@4621
   928
(* sorting *)
wenzelm@4621
   929
wenzelm@18427
   930
(*quicksort -- stable, i.e. does not reorder equal elements*)
wenzelm@18427
   931
fun quicksort unique ord =
wenzelm@4621
   932
  let
wenzelm@16878
   933
    fun qsort [] = []
wenzelm@16878
   934
      | qsort (xs as [_]) = xs
wenzelm@18427
   935
      | qsort (xs as [x, y]) =
wenzelm@18427
   936
          (case ord (x, y) of
wenzelm@18427
   937
            LESS => xs
wenzelm@18427
   938
          | EQUAL => if unique then [x] else xs
wenzelm@18427
   939
          | GREATER => [y, x])
wenzelm@16878
   940
      | qsort xs =
haftmann@18011
   941
          let val (lts, eqs, gts) = part (nth xs (length xs div 2)) xs
wenzelm@16878
   942
          in qsort lts @ eqs @ qsort gts end
wenzelm@4621
   943
    and part _ [] = ([], [], [])
wenzelm@4621
   944
      | part pivot (x :: xs) = add (ord (x, pivot)) x (part pivot xs)
wenzelm@4621
   945
    and add LESS x (lts, eqs, gts) = (x :: lts, eqs, gts)
wenzelm@18427
   946
      | add EQUAL x (lts, [], gts) = (lts, [x], gts)
wenzelm@18427
   947
      | add EQUAL x (res as (lts, eqs, gts)) = if unique then res else (lts, x :: eqs, gts)
wenzelm@4621
   948
      | add GREATER x (lts, eqs, gts) = (lts, eqs, x :: gts);
wenzelm@4621
   949
  in qsort end;
wenzelm@4621
   950
wenzelm@18427
   951
fun sort ord = quicksort false ord;
wenzelm@18427
   952
fun sort_distinct ord = quicksort true ord;
wenzelm@18427
   953
wenzelm@4621
   954
val sort_strings = sort string_ord;
wenzelm@4621
   955
fun sort_wrt sel xs = sort (string_ord o pairself sel) xs;
wenzelm@4621
   956
wenzelm@4621
   957
wenzelm@2506
   958
berghofe@14106
   959
(** random numbers **)
berghofe@14106
   960
berghofe@14106
   961
exception RANDOM;
berghofe@14106
   962
berghofe@14618
   963
fun rmod x y = x - y * Real.realFloor (x / y);
berghofe@14106
   964
berghofe@14106
   965
local
berghofe@14106
   966
  val a = 16807.0;
berghofe@14106
   967
  val m = 2147483647.0;
berghofe@14106
   968
  val random_seed = ref 1.0;
berghofe@14106
   969
in
berghofe@14106
   970
wenzelm@23922
   971
fun random () = CRITICAL (fn () =>
wenzelm@23922
   972
  let val r = rmod (a * ! random_seed) m
wenzelm@23922
   973
  in (random_seed := r; r) end);
berghofe@14106
   974
berghofe@14106
   975
end;
berghofe@14106
   976
berghofe@14106
   977
fun random_range l h =
berghofe@14106
   978
  if h < l orelse l < 0 then raise RANDOM
berghofe@14106
   979
  else l + Real.floor (rmod (random ()) (real (h - l + 1)));
berghofe@14106
   980
haftmann@18011
   981
fun one_of xs = nth xs (random_range 0 (length xs - 1));
berghofe@14106
   982
berghofe@14106
   983
fun frequency xs =
berghofe@14106
   984
  let
berghofe@14106
   985
    val sum = foldl op + (0, map fst xs);
wenzelm@17756
   986
    fun pick n ((k: int, x) :: xs) =
berghofe@14106
   987
      if n <= k then x else pick (n - k) xs
berghofe@14106
   988
  in pick (random_range 1 sum) xs end;
berghofe@14106
   989
berghofe@14106
   990
wenzelm@23220
   991
wenzelm@4621
   992
(** misc **)
wenzelm@233
   993
wenzelm@19644
   994
fun divide_and_conquer decomp x =
wenzelm@19644
   995
  let val (ys, recomb) = decomp x
wenzelm@19644
   996
  in recomb (map (divide_and_conquer decomp) ys) end;
wenzelm@19644
   997
clasohm@0
   998
wenzelm@233
   999
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
  1000
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
  1001
fun partition_list p i j =
wenzelm@233
  1002
  let fun part k xs =
wenzelm@233
  1003
            if k>j then
clasohm@0
  1004
              (case xs of [] => []
skalberg@15570
  1005
                         | _ => raise Fail "partition_list")
clasohm@0
  1006
            else
wenzelm@19691
  1007
            let val (ns, rest) = List.partition (p k) xs;
wenzelm@233
  1008
            in  ns :: part(k+1)rest  end
wenzelm@24593
  1009
  in  part (i: int) end;
clasohm@0
  1010
wenzelm@19691
  1011
fun partition_eq (eq:'a * 'a -> bool) =
wenzelm@19691
  1012
  let
wenzelm@19691
  1013
    fun part [] = []
wenzelm@19691
  1014
      | part (x :: ys) =
wenzelm@19691
  1015
          let val (xs, xs') = List.partition (fn y => eq (x, y)) ys
wenzelm@19691
  1016
          in (x::xs)::(part xs') end
wenzelm@19691
  1017
  in part end;
wenzelm@19691
  1018
wenzelm@19691
  1019
clasohm@0
  1020
wenzelm@233
  1021
(* generating identifiers *)
clasohm@0
  1022
paulson@4063
  1023
(** Freshly generated identifiers; supplied prefix MUST start with a letter **)
wenzelm@22369
  1024
local
wenzelm@22369
  1025
(*Maps 0-61 to A-Z, a-z, 0-9; exclude _ or ' to avoid clash with internal/unusual indentifiers*)
wenzelm@22582
  1026
fun gensym_char i =
paulson@22368
  1027
  if i<26 then chr (ord "A" + i)
paulson@22368
  1028
  else if i<52 then chr (ord "a" + i - 26)
wenzelm@22369
  1029
  else chr (ord "0" + i - 52);
paulson@4063
  1030
wenzelm@22369
  1031
val char_vec = Vector.tabulate (62, gensym_char);
wenzelm@22369
  1032
fun newid n = implode (map (fn i => Vector.sub (char_vec, i)) (radixpand (62, n)));
wenzelm@4284
  1033
wenzelm@24593
  1034
val gensym_seed = ref (0: int);
paulson@2003
  1035
wenzelm@22369
  1036
in
wenzelm@24148
  1037
  fun gensym pre = pre ^ newid (NAMED_CRITICAL "gensym" (fn () => inc gensym_seed));
wenzelm@22369
  1038
end;
paulson@4063
  1039
paulson@4063
  1040
wenzelm@16439
  1041
(* stamps and serial numbers *)
wenzelm@16439
  1042
wenzelm@16439
  1043
type stamp = unit ref;
wenzelm@16439
  1044
val stamp: unit -> stamp = ref;
wenzelm@16439
  1045
wenzelm@16439
  1046
type serial = int;
wenzelm@24593
  1047
local val count = ref (0: int)
wenzelm@24148
  1048
in fun serial () = NAMED_CRITICAL "serial" (fn () => inc count) end;
wenzelm@16439
  1049
wenzelm@19512
  1050
val serial_string = string_of_int o serial;
wenzelm@19512
  1051
wenzelm@16535
  1052
wenzelm@16535
  1053
(* generic objects *)
wenzelm@16535
  1054
wenzelm@16535
  1055
(*note that the builtin exception datatype may be extended by new
wenzelm@16535
  1056
  constructors at any time*)
wenzelm@16535
  1057
structure Object = struct type T = exn end;
wenzelm@16535
  1058
clasohm@1364
  1059
end;
clasohm@1364
  1060
wenzelm@15745
  1061
structure BasicLibrary: BASIC_LIBRARY = Library;
wenzelm@15745
  1062
open BasicLibrary;