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