src/Pure/library.ML
author wenzelm
Mon Oct 17 15:46:51 2016 +0200 (2016-10-17)
changeset 64275 ac2abc987cf9
parent 63304 00a135c0a17f
child 65904 8411f1a2272c
permissions -rw-r--r--
accomodate Poly/ML repository version, which treats singleton strings as boxed;
wenzelm@41
     1
(*  Title:      Pure/library.ML
wenzelm@233
     2
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
wenzelm@16188
     3
    Author:     Markus Wenzel, TU Muenchen
clasohm@0
     4
haftmann@28732
     5
Basic library: functions, pairs, booleans, lists, integers,
wenzelm@23424
     6
strings, lists as sets, orders, current directory, misc.
wenzelm@21395
     7
wenzelm@21395
     8
See also General/basics.ML for the most fundamental concepts.
clasohm@0
     9
*)
clasohm@0
    10
wenzelm@21395
    11
infix 2 ?
wenzelm@21395
    12
infix 3 o oo ooo oooo
wenzelm@21395
    13
infix 4 ~~ upto downto
haftmann@36692
    14
infix orf andf
wenzelm@5893
    15
wenzelm@15745
    16
signature BASIC_LIBRARY =
wenzelm@4621
    17
sig
wenzelm@4621
    18
  (*functions*)
wenzelm@23860
    19
  val undefined: 'a -> 'b
wenzelm@16842
    20
  val I: 'a -> 'a
wenzelm@16842
    21
  val K: 'a -> 'b -> 'a
wenzelm@4621
    22
  val curry: ('a * 'b -> 'c) -> 'a -> 'b -> 'c
wenzelm@4621
    23
  val uncurry: ('a -> 'b -> 'c) -> 'a * 'b -> 'c
wenzelm@21565
    24
  val ? : bool * ('a -> 'a) -> 'a -> 'a
wenzelm@16721
    25
  val oo: ('a -> 'b) * ('c -> 'd -> 'a) -> 'c -> 'd -> 'b
wenzelm@16721
    26
  val ooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'a) -> 'c -> 'd -> 'e -> 'b
wenzelm@16721
    27
  val oooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'f -> 'a) -> 'c -> 'd -> 'e -> 'f -> 'b
wenzelm@16842
    28
  val funpow: int -> ('a -> 'a) -> 'a -> 'a
haftmann@31250
    29
  val funpow_yield: int -> ('a -> 'b * 'a) -> 'a -> 'b list * 'a
clasohm@1364
    30
wenzelm@4621
    31
  (*pairs*)
wenzelm@4621
    32
  val pair: 'a -> 'b -> 'a * 'b
wenzelm@4621
    33
  val rpair: 'a -> 'b -> 'b * 'a
wenzelm@4621
    34
  val fst: 'a * 'b -> 'a
wenzelm@4621
    35
  val snd: 'a * 'b -> 'b
haftmann@17498
    36
  val eq_fst: ('a * 'c -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@17498
    37
  val eq_snd: ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@19454
    38
  val eq_pair: ('a * 'c -> bool) -> ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
wenzelm@4621
    39
  val swap: 'a * 'b -> 'b * 'a
wenzelm@4621
    40
  val apfst: ('a -> 'b) -> 'a * 'c -> 'b * 'c
wenzelm@4621
    41
  val apsnd: ('a -> 'b) -> 'c * 'a -> 'c * 'b
wenzelm@59058
    42
  val apply2: ('a -> 'b) -> 'a * 'a -> 'b * 'b
wenzelm@4621
    43
wenzelm@4621
    44
  (*booleans*)
wenzelm@4621
    45
  val equal: ''a -> ''a -> bool
wenzelm@4621
    46
  val not_equal: ''a -> ''a -> bool
wenzelm@4621
    47
  val orf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    48
  val andf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    49
  val exists: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    50
  val forall: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    51
wenzelm@4621
    52
  (*lists*)
wenzelm@5285
    53
  val single: 'a -> 'a list
wenzelm@20882
    54
  val the_single: 'a list -> 'a
wenzelm@19273
    55
  val singleton: ('a list -> 'b list) -> 'a -> 'b
haftmann@25061
    56
  val yield_singleton: ('a list -> 'c -> 'b list * 'c) -> 'a -> 'c -> 'b * 'c
wenzelm@25058
    57
  val perhaps_apply: ('a -> 'a option) list -> 'a -> 'a option
wenzelm@25058
    58
  val perhaps_loop: ('a -> 'a option) -> 'a -> 'a option
berghofe@25681
    59
  val foldl1: ('a * 'a -> 'a) -> 'a list -> 'a
wenzelm@15760
    60
  val foldr1: ('a * 'a -> 'a) -> 'a list -> 'a
wenzelm@46891
    61
  val eq_list: ('a * 'a -> bool) -> 'a list * 'a list -> bool
wenzelm@21395
    62
  val maps: ('a -> 'b list) -> 'a list -> 'b list
wenzelm@25549
    63
  val filter: ('a -> bool) -> 'a list -> 'a list
wenzelm@25549
    64
  val filter_out: ('a -> bool) -> 'a list -> 'a list
wenzelm@25549
    65
  val map_filter: ('a -> 'b option) -> 'a list -> 'b list
haftmann@33955
    66
  val take: int -> 'a list -> 'a list
haftmann@33955
    67
  val drop: int -> 'a list -> 'a list
wenzelm@19011
    68
  val chop: int -> 'a list -> 'a list * 'a list
wenzelm@46891
    69
  val chop_groups: int -> 'a list -> 'a list list
haftmann@18278
    70
  val nth: 'a list -> int -> 'a
wenzelm@46891
    71
  val nth_list: 'a list list -> int -> 'a list
haftmann@18011
    72
  val nth_map: int -> ('a -> 'a) -> 'a list -> 'a list
haftmann@24846
    73
  val nth_drop: int -> 'a list -> 'a list
haftmann@18514
    74
  val map_index: (int * 'a -> 'b) -> 'a list -> 'b list
haftmann@18514
    75
  val fold_index: (int * 'a -> 'b -> 'b) -> 'a list -> 'b -> 'b
haftmann@33063
    76
  val map_range: (int -> 'a) -> int -> 'a list
haftmann@52271
    77
  val fold_range: (int -> 'a -> 'a) -> int -> 'a -> 'a
wenzelm@4621
    78
  val split_last: 'a list -> 'a list * 'a
wenzelm@46891
    79
  val find_first: ('a -> bool) -> 'a list -> 'a option
wenzelm@4621
    80
  val find_index: ('a -> bool) -> 'a list -> int
wenzelm@46891
    81
  val get_first: ('a -> 'b option) -> 'a list -> 'b option
haftmann@19233
    82
  val get_index: ('a -> 'b option) -> 'a list -> (int * 'b) option
wenzelm@46891
    83
  val flat: 'a list list -> 'a list
wenzelm@46891
    84
  val unflat: 'a list list -> 'b list -> 'b list list
wenzelm@46891
    85
  val grouped: int -> (('a list -> 'b list) -> 'c list list -> 'd list list) ->
wenzelm@46891
    86
    ('a -> 'b) -> 'c list -> 'd list
wenzelm@46891
    87
  val burrow: ('a list -> 'b list) -> 'a list list -> 'b list list
wenzelm@46891
    88
  val burrow_options: ('a list -> 'b list) -> 'a option list -> 'b option list
wenzelm@46891
    89
  val fold_burrow: ('a list -> 'c -> 'b list * 'd) -> 'a list list -> 'c -> 'b list list * 'd
wenzelm@46891
    90
  val separate: 'a -> 'a list -> 'a list
wenzelm@46891
    91
  val surround: 'a -> 'a list -> 'a list
wenzelm@46891
    92
  val replicate: int -> 'a -> 'a list
wenzelm@46891
    93
  val map_product: ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
wenzelm@46891
    94
  val fold_product: ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
haftmann@18330
    95
  val map2: ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
haftmann@18330
    96
  val fold2: ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
wenzelm@46891
    97
  val map_split: ('a -> 'b * 'c) -> 'a list -> 'b list * 'c list
wenzelm@19799
    98
  val zip_options: 'a list -> 'b option list -> ('a * 'b) list
haftmann@18330
    99
  val ~~ : 'a list * 'b list -> ('a * 'b) list
haftmann@18330
   100
  val split_list: ('a * 'b) list -> 'a list * 'b list
wenzelm@46891
   101
  val burrow_fst: ('a list -> 'b list) -> ('a * 'c) list -> ('b * 'c) list
haftmann@18441
   102
  val is_prefix: ('a * 'a -> bool) -> 'a list -> 'a list -> bool
wenzelm@4621
   103
  val take_prefix: ('a -> bool) -> 'a list -> 'a list * 'a list
haftmann@20108
   104
  val chop_prefix: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list * ('a list * 'b list)
wenzelm@4621
   105
  val take_suffix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@12249
   106
  val prefixes1: 'a list -> 'a list list
wenzelm@19011
   107
  val prefixes: 'a list -> 'a list list
wenzelm@12249
   108
  val suffixes1: 'a list -> 'a list list
wenzelm@19011
   109
  val suffixes: 'a list -> 'a list list
wenzelm@61707
   110
  val trim: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   111
wenzelm@4621
   112
  (*integers*)
wenzelm@4621
   113
  val upto: int * int -> int list
wenzelm@4621
   114
  val downto: int * int -> int list
wenzelm@4621
   115
  val radixpand: int * int -> int list
wenzelm@4621
   116
  val radixstring: int * string * int -> string
wenzelm@4621
   117
  val string_of_int: int -> string
wenzelm@21942
   118
  val signed_string_of_int: int -> string
wenzelm@4621
   119
  val string_of_indexname: string * int -> string
wenzelm@24630
   120
  val read_radix_int: int -> string list -> int * string list
wenzelm@14826
   121
  val read_int: string list -> int * string list
wenzelm@14826
   122
  val oct_char: string -> string
wenzelm@4621
   123
wenzelm@4621
   124
  (*strings*)
haftmann@18011
   125
  val nth_string: string -> int -> string
wenzelm@16188
   126
  val fold_string: (string -> 'a -> 'a) -> string -> 'a -> 'a
wenzelm@6312
   127
  val exists_string: (string -> bool) -> string -> bool
wenzelm@16188
   128
  val forall_string: (string -> bool) -> string -> bool
wenzelm@28025
   129
  val first_field: string -> string -> (string * string) option
wenzelm@4621
   130
  val enclose: string -> string -> string -> string
wenzelm@6642
   131
  val unenclose: string -> string
wenzelm@4621
   132
  val quote: string -> string
wenzelm@55033
   133
  val cartouche: string -> string
wenzelm@4621
   134
  val space_implode: string -> string list -> string
wenzelm@4621
   135
  val commas: string list -> string
wenzelm@4621
   136
  val commas_quote: string list -> string
wenzelm@4621
   137
  val cat_lines: string list -> string
wenzelm@4621
   138
  val space_explode: string -> string -> string list
wenzelm@14826
   139
  val split_lines: string -> string list
wenzelm@56038
   140
  val plain_words: string -> string
wenzelm@5942
   141
  val prefix_lines: string -> string -> string
wenzelm@18681
   142
  val prefix: string -> string -> string
wenzelm@5285
   143
  val suffix: string -> string -> string
wenzelm@18681
   144
  val unprefix: string -> string -> string
wenzelm@5285
   145
  val unsuffix: string -> string -> string
wenzelm@47499
   146
  val trim_line: string -> string
wenzelm@10951
   147
  val replicate_string: int -> string -> string
wenzelm@14926
   148
  val translate_string: (string -> string) -> string -> string
haftmann@63304
   149
  val align_right: string -> int -> string -> string
kleing@29882
   150
  val match_string: string -> string -> bool
wenzelm@4621
   151
wenzelm@41516
   152
  (*reals*)
wenzelm@41516
   153
  val string_of_real: real -> string
wenzelm@41516
   154
  val signed_string_of_real: real -> string
wenzelm@41516
   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
haftmann@33042
   161
  val union: ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
wenzelm@19301
   162
  val subtract: ('b * 'a -> bool) -> 'b list -> 'a list -> 'a list
haftmann@33049
   163
  val inter: ('a * 'b -> bool) -> 'b list -> 'a list -> 'a list
wenzelm@18923
   164
  val merge: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
haftmann@33038
   165
  val subset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@42403
   166
  val eq_set: ('a * 'a -> bool) -> 'a list * 'a list -> bool
wenzelm@19046
   167
  val distinct: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@18966
   168
  val duplicates: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@16878
   169
  val has_duplicates: ('a * 'a -> bool) -> 'a list -> bool
wenzelm@46891
   170
  val map_transpose: ('a list -> 'b) -> 'a list list -> 'b list
wenzelm@4621
   171
wenzelm@23220
   172
  (*lists as multisets*)
nipkow@22142
   173
  val remove1: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
haftmann@33078
   174
  val combine: ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
haftmann@33079
   175
  val submultiset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   176
wenzelm@4621
   177
  (*orders*)
wenzelm@18966
   178
  val is_equal: order -> bool
wenzelm@4621
   179
  val rev_order: order -> order
wenzelm@4621
   180
  val make_ord: ('a * 'a -> bool) -> 'a * 'a -> order
wenzelm@25224
   181
  val bool_ord: bool * bool -> order
wenzelm@4621
   182
  val int_ord: int * int -> order
wenzelm@4621
   183
  val string_ord: string * string -> order
wenzelm@16676
   184
  val fast_string_ord: string * string -> order
wenzelm@16492
   185
  val option_ord: ('a * 'b -> order) -> 'a option * 'b option -> order
wenzelm@4621
   186
  val prod_ord: ('a * 'b -> order) -> ('c * 'd -> order) -> ('a * 'c) * ('b * 'd) -> order
wenzelm@4621
   187
  val dict_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   188
  val list_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   189
  val sort: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@18427
   190
  val sort_distinct: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@4621
   191
  val sort_strings: string list -> string list
wenzelm@60924
   192
  val sort_by: ('a -> string) -> 'a list -> 'a list
wenzelm@30558
   193
  val tag_list: int -> 'a list -> (int * 'a) list
wenzelm@30558
   194
  val untag_list: (int * 'a) list -> 'a list
wenzelm@30558
   195
  val order_list: (int * 'a) list -> 'a list
wenzelm@4621
   196
wenzelm@4621
   197
  (*misc*)
wenzelm@19644
   198
  val divide_and_conquer: ('a -> 'a list * ('b list -> 'b)) -> 'a -> 'b
wenzelm@32978
   199
  val divide_and_conquer': ('a -> 'b -> ('a list * ('c list * 'b -> 'c * 'b)) * 'b) ->
wenzelm@32978
   200
    'a -> 'b -> 'c * 'b
wenzelm@4621
   201
  val partition_eq: ('a * 'a -> bool) -> 'a list -> 'a list list
wenzelm@4621
   202
  val partition_list: (int -> 'a -> bool) -> int -> int -> 'a list -> 'a list list
wenzelm@40509
   203
  type serial = int
wenzelm@16439
   204
  val serial: unit -> serial
wenzelm@19512
   205
  val serial_string: unit -> string
wenzelm@45626
   206
  eqtype stamp
wenzelm@45626
   207
  val stamp: unit -> stamp
wenzelm@51368
   208
  structure Any: sig type T = exn end
wenzelm@43603
   209
  val getenv: string -> string
wenzelm@43603
   210
  val getenv_strict: string -> string
wenzelm@4621
   211
end;
wenzelm@4621
   212
wenzelm@15745
   213
signature LIBRARY =
skalberg@15570
   214
sig
wenzelm@15745
   215
  include BASIC_LIBRARY
skalberg@15570
   216
  val foldl: ('a * 'b -> 'a) -> 'a * 'b list -> 'a
skalberg@15570
   217
  val foldr: ('a * 'b -> 'b) -> 'a list * 'b -> 'b
skalberg@15570
   218
end;
skalberg@15570
   219
wenzelm@15745
   220
structure Library: LIBRARY =
clasohm@1364
   221
struct
clasohm@0
   222
wenzelm@21395
   223
(* functions *)
clasohm@0
   224
wenzelm@23860
   225
fun undefined _ = raise Match;
wenzelm@23860
   226
wenzelm@16842
   227
fun I x = x;
wenzelm@16842
   228
fun K x = fn _ => x;
wenzelm@233
   229
fun curry f x y = f (x, y);
wenzelm@233
   230
fun uncurry f (x, y) = f x y;
clasohm@0
   231
haftmann@17141
   232
(*conditional application*)
wenzelm@21565
   233
fun b ? f = fn x => if b then f x else x;
haftmann@17141
   234
wenzelm@16721
   235
(*composition with multiple args*)
wenzelm@16721
   236
fun (f oo g) x y = f (g x y);
wenzelm@16721
   237
fun (f ooo g) x y z = f (g x y z);
wenzelm@16721
   238
fun (f oooo g) x y z w = f (g x y z w);
wenzelm@16721
   239
haftmann@31250
   240
(*function exponentiation: f (... (f x) ...) with n applications of f*)
haftmann@31250
   241
fun funpow (0 : int) _ = I
haftmann@31250
   242
  | funpow n f = f #> funpow (n - 1) f;
wenzelm@160
   243
haftmann@31250
   244
fun funpow_yield (0 : int) _ x = ([], x)
haftmann@31250
   245
  | funpow_yield n f x = x |> f ||>> funpow_yield (n - 1) f |>> op ::;
wenzelm@160
   246
wenzelm@40318
   247
wenzelm@21395
   248
(* pairs *)
wenzelm@233
   249
wenzelm@233
   250
fun pair x y = (x, y);
wenzelm@233
   251
fun rpair x y = (y, x);
wenzelm@233
   252
wenzelm@233
   253
fun fst (x, y) = x;
wenzelm@233
   254
fun snd (x, y) = y;
wenzelm@233
   255
haftmann@17498
   256
fun eq_fst eq ((x1, _), (x2, _)) = eq (x1, x2);
haftmann@17498
   257
fun eq_snd eq ((_, y1), (_, y2)) = eq (y1, y2);
haftmann@19454
   258
fun eq_pair eqx eqy ((x1, y1), (x2, y2)) = eqx (x1, x2) andalso eqy (y1, y2);
wenzelm@233
   259
wenzelm@233
   260
fun swap (x, y) = (y, x);
wenzelm@233
   261
wenzelm@233
   262
fun apfst f (x, y) = (f x, y);
wenzelm@233
   263
fun apsnd f (x, y) = (x, f y);
wenzelm@59058
   264
fun apply2 f (x, y) = (f x, f y);
wenzelm@233
   265
wenzelm@233
   266
wenzelm@21395
   267
(* booleans *)
wenzelm@233
   268
wenzelm@21395
   269
(*polymorphic equality*)
wenzelm@233
   270
fun equal x y = x = y;
wenzelm@233
   271
fun not_equal x y = x <> y;
wenzelm@233
   272
wenzelm@21395
   273
(*combining predicates*)
wenzelm@16721
   274
fun p orf q = fn x => p x orelse q x;
wenzelm@16721
   275
fun p andf q = fn x => p x andalso q x;
wenzelm@233
   276
wenzelm@25752
   277
val exists = List.exists;
wenzelm@25752
   278
val forall = List.all;
clasohm@0
   279
wenzelm@19644
   280
wenzelm@21395
   281
wenzelm@233
   282
(** lists **)
wenzelm@233
   283
wenzelm@5285
   284
fun single x = [x];
wenzelm@233
   285
wenzelm@20882
   286
fun the_single [x] = x
wenzelm@47060
   287
  | the_single _ = raise List.Empty;
wenzelm@20882
   288
wenzelm@20882
   289
fun singleton f x = the_single (f [x]);
wenzelm@19273
   290
haftmann@25061
   291
fun yield_singleton f x = f [x] #>> the_single;
haftmann@25061
   292
wenzelm@25058
   293
fun perhaps_apply funs arg =
wenzelm@25058
   294
  let
wenzelm@25058
   295
    fun app [] res = res
wenzelm@25058
   296
      | app (f :: fs) (changed, x) =
wenzelm@25058
   297
          (case f x of
wenzelm@25058
   298
            NONE => app fs (changed, x)
wenzelm@25058
   299
          | SOME x' => app fs (true, x'));
wenzelm@25058
   300
  in (case app funs (false, arg) of (false, _) => NONE | (true, arg') => SOME arg') end;
wenzelm@25058
   301
wenzelm@25058
   302
fun perhaps_loop f arg =
wenzelm@25058
   303
  let
wenzelm@25058
   304
    fun loop (changed, x) =
wenzelm@25058
   305
      (case f x of
wenzelm@25058
   306
        NONE => (changed, x)
wenzelm@25058
   307
      | SOME x' => loop (true, x'));
wenzelm@25058
   308
  in (case loop (false, arg) of (false, _) => NONE | (true, arg') => SOME arg') end;
wenzelm@25058
   309
wenzelm@233
   310
wenzelm@21395
   311
(* fold -- old versions *)
haftmann@16691
   312
wenzelm@233
   313
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   314
wenzelm@233
   315
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   316
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   317
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   318
  let fun itl (e, [])  = e
wenzelm@233
   319
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   320
  in  itl end;
wenzelm@233
   321
wenzelm@233
   322
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   323
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   324
fun foldr f (l, e) =
wenzelm@233
   325
  let fun itr [] = e
wenzelm@233
   326
        | itr (a::l) = f(a, itr l)
wenzelm@233
   327
  in  itr l  end;
wenzelm@233
   328
berghofe@25681
   329
(*  (op @) [x1, ..., xn]  ===>  ((x1 @ x2) @ x3) ... @ xn
berghofe@25681
   330
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@47060
   331
fun foldl1 f [] = raise List.Empty
berghofe@25681
   332
  | foldl1 f (x :: xs) = foldl f (x, xs);
berghofe@25681
   333
wenzelm@233
   334
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   335
    for n > 0, operators that associate to the right (not tail recursive)*)
wenzelm@47060
   336
fun foldr1 f [] = raise List.Empty
wenzelm@20510
   337
  | foldr1 f l =
paulson@20443
   338
      let fun itr [x] = x
wenzelm@20510
   339
            | itr (x::l) = f(x, itr l)
paulson@20443
   340
      in  itr l  end;
wenzelm@233
   341
wenzelm@233
   342
wenzelm@233
   343
(* basic list functions *)
wenzelm@233
   344
wenzelm@20510
   345
fun eq_list eq (list1, list2) =
wenzelm@42403
   346
  pointer_eq (list1, list2) orelse
wenzelm@42403
   347
    let
wenzelm@42403
   348
      fun eq_lst (x :: xs, y :: ys) = eq (x, y) andalso eq_lst (xs, ys)
wenzelm@42403
   349
        | eq_lst _ = true;
wenzelm@42403
   350
    in length list1 = length list2 andalso eq_lst (list1, list2) end;
haftmann@20348
   351
wenzelm@19483
   352
fun maps f [] = []
wenzelm@19483
   353
  | maps f (x :: xs) = f x @ maps f xs;
wenzelm@19483
   354
haftmann@25538
   355
val filter = List.filter;
haftmann@25538
   356
fun filter_out f = filter (not o f);
haftmann@25538
   357
val map_filter = List.mapPartial;
haftmann@25538
   358
haftmann@33955
   359
fun take (0: int) xs = []
haftmann@33955
   360
  | take _ [] = []
haftmann@34059
   361
  | take n (x :: xs) = x :: take (n - 1) xs;
haftmann@33955
   362
haftmann@33955
   363
fun drop (0: int) xs = xs
haftmann@33955
   364
  | drop _ [] = []
haftmann@34059
   365
  | drop n (x :: xs) = drop (n - 1) xs;
haftmann@33955
   366
wenzelm@24593
   367
fun chop (0: int) xs = ([], xs)
wenzelm@23220
   368
  | chop _ [] = ([], [])
wenzelm@23220
   369
  | chop n (x :: xs) = chop (n - 1) xs |>> cons x;
wenzelm@19011
   370
wenzelm@46891
   371
fun chop_groups n list =
wenzelm@46891
   372
  (case chop (Int.max (n, 1)) list of
wenzelm@46891
   373
    ([], _) => []
wenzelm@46891
   374
  | (g, rest) => g :: chop_groups n rest);
wenzelm@46891
   375
wenzelm@46891
   376
wenzelm@233
   377
(*return nth element of a list, where 0 designates the first element;
wenzelm@18461
   378
  raise Subscript if list too short*)
haftmann@18011
   379
fun nth xs i = List.nth (xs, i);
wenzelm@233
   380
wenzelm@43278
   381
fun nth_list xss i = nth xss i handle General.Subscript => [];
wenzelm@18461
   382
haftmann@18011
   383
fun nth_map 0 f (x :: xs) = f x :: xs
haftmann@18011
   384
  | nth_map n f (x :: xs) = x :: nth_map (n - 1) f xs
wenzelm@24593
   385
  | nth_map (_: int) _ [] = raise Subscript;
wenzelm@11773
   386
haftmann@24846
   387
fun nth_drop n xs =
haftmann@24846
   388
  List.take (xs, n) @ List.drop (xs, n + 1);
haftmann@24846
   389
haftmann@18514
   390
fun map_index f =
haftmann@18514
   391
  let
haftmann@52271
   392
    fun map_aux (_: int) [] = []
haftmann@52271
   393
      | map_aux i (x :: xs) = f (i, x) :: map_aux (i + 1) xs
haftmann@52271
   394
  in map_aux 0 end;
haftmann@18514
   395
haftmann@21118
   396
fun fold_index f =
haftmann@21118
   397
  let
wenzelm@24593
   398
    fun fold_aux (_: int) [] y = y
haftmann@52271
   399
      | fold_aux i (x :: xs) y = fold_aux (i + 1) xs (f (i, x) y)
haftmann@21118
   400
  in fold_aux 0 end;
haftmann@21118
   401
haftmann@33063
   402
fun map_range f i =
haftmann@33063
   403
  let
haftmann@52271
   404
    fun map_aux (k: int) =
haftmann@52271
   405
      if k < i then f k :: map_aux (k + 1) else []
haftmann@52271
   406
  in map_aux 0 end;
haftmann@52271
   407
haftmann@52271
   408
fun fold_range f i =
haftmann@52271
   409
  let
haftmann@52271
   410
    fun fold_aux (k: int) y =
haftmann@52271
   411
      if k < i then fold_aux (k + 1) (f k y) else y
haftmann@52271
   412
  in fold_aux 0 end;
haftmann@52271
   413
haftmann@33063
   414
wenzelm@3762
   415
(*rear decomposition*)
wenzelm@47060
   416
fun split_last [] = raise List.Empty
wenzelm@3762
   417
  | split_last [x] = ([], x)
wenzelm@3762
   418
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   419
wenzelm@46891
   420
(*find first element satisfying predicate*)
wenzelm@46891
   421
val find_first = List.find;
wenzelm@46891
   422
ballarin@29209
   423
(*find position of first element satisfying a predicate*)
wenzelm@4212
   424
fun find_index pred =
wenzelm@24593
   425
  let fun find (_: int) [] = ~1
wenzelm@4212
   426
        | find n (x :: xs) = if pred x then n else find (n + 1) xs;
wenzelm@4212
   427
  in find 0 end;
wenzelm@3762
   428
wenzelm@4916
   429
(*get first element by lookup function*)
skalberg@15531
   430
fun get_first _ [] = NONE
wenzelm@4916
   431
  | get_first f (x :: xs) =
wenzelm@4916
   432
      (case f x of
skalberg@15531
   433
        NONE => get_first f xs
wenzelm@4916
   434
      | some => some);
wenzelm@4916
   435
haftmann@19233
   436
fun get_index f =
haftmann@19233
   437
  let
wenzelm@24593
   438
    fun get (_: int) [] = NONE
wenzelm@19461
   439
      | get i (x :: xs) =
wenzelm@46838
   440
          (case f x of
wenzelm@46838
   441
            NONE => get (i + 1) xs
wenzelm@46838
   442
          | SOME y => SOME (i, y))
haftmann@19233
   443
  in get 0 end;
haftmann@19233
   444
skalberg@15531
   445
val flat = List.concat;
wenzelm@233
   446
wenzelm@12136
   447
fun unflat (xs :: xss) ys =
wenzelm@19424
   448
      let val (ps, qs) = chop (length xs) ys
nipkow@13629
   449
      in ps :: unflat xss qs end
wenzelm@12136
   450
  | unflat [] [] = []
wenzelm@40722
   451
  | unflat _ _ = raise ListPair.UnequalLengths;
wenzelm@12136
   452
wenzelm@46891
   453
fun grouped n comb f = chop_groups n #> comb (map f) #> flat;
wenzelm@46891
   454
wenzelm@21479
   455
fun burrow f xss = unflat xss (f (flat xss));
haftmann@18359
   456
wenzelm@24864
   457
fun burrow_options f os = map (try hd) (burrow f (map the_list os));
wenzelm@24864
   458
haftmann@18549
   459
fun fold_burrow f xss s =
haftmann@18549
   460
  apfst (unflat xss) (f (flat xss) s);
haftmann@18359
   461
wenzelm@233
   462
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   463
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   464
  | separate _ xs = xs;
wenzelm@233
   465
wenzelm@25980
   466
fun surround s (x :: xs) = s :: x :: surround s xs
wenzelm@25980
   467
  | surround s [] = [s];
wenzelm@25980
   468
wenzelm@233
   469
(*make the list [x, x, ..., x] of length n*)
wenzelm@24593
   470
fun replicate (n: int) x =
wenzelm@233
   471
  let fun rep (0, xs) = xs
wenzelm@233
   472
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   473
  in
skalberg@15570
   474
    if n < 0 then raise Subscript
wenzelm@233
   475
    else rep (n, [])
wenzelm@233
   476
  end;
wenzelm@233
   477
wenzelm@4248
   478
wenzelm@25549
   479
(* direct product *)
wenzelm@25549
   480
haftmann@25538
   481
fun map_product f _ [] = []
haftmann@25538
   482
  | map_product f [] _ = []
haftmann@25538
   483
  | map_product f (x :: xs) ys = map (f x) ys @ map_product f xs ys;
wenzelm@233
   484
haftmann@25538
   485
fun fold_product f _ [] z = z
haftmann@25538
   486
  | fold_product f [] _ z = z
haftmann@25538
   487
  | fold_product f (x :: xs) ys z = z |> fold (f x) ys |> fold_product f xs ys;
wenzelm@233
   488
wenzelm@25549
   489
wenzelm@25549
   490
(* lists of pairs *)
wenzelm@233
   491
haftmann@18330
   492
fun map2 _ [] [] = []
haftmann@18330
   493
  | map2 f (x :: xs) (y :: ys) = f x y :: map2 f xs ys
wenzelm@40722
   494
  | map2 _ _ _ = raise ListPair.UnequalLengths;
wenzelm@380
   495
wenzelm@58633
   496
fun fold2 _ [] [] z = z
wenzelm@23220
   497
  | fold2 f (x :: xs) (y :: ys) z = fold2 f xs ys (f x y z)
wenzelm@58633
   498
  | fold2 _ _ _ _ = raise ListPair.UnequalLengths;
wenzelm@380
   499
wenzelm@58633
   500
fun map_split _ [] = ([], [])
haftmann@25943
   501
  | map_split f (x :: xs) =
haftmann@25943
   502
      let
haftmann@25943
   503
        val (y, w) = f x;
haftmann@25943
   504
        val (ys, ws) = map_split f xs;
haftmann@25943
   505
      in (y :: ys, w :: ws) end;
haftmann@25943
   506
wenzelm@19799
   507
fun zip_options (x :: xs) (SOME y :: ys) = (x, y) :: zip_options xs ys
wenzelm@19799
   508
  | zip_options (_ :: xs) (NONE :: ys) = zip_options xs ys
wenzelm@19799
   509
  | zip_options _ [] = []
wenzelm@40722
   510
  | zip_options [] _ = raise ListPair.UnequalLengths;
wenzelm@4956
   511
wenzelm@233
   512
(*combine two lists forming a list of pairs:
wenzelm@233
   513
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   514
fun [] ~~ [] = []
wenzelm@233
   515
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
wenzelm@40722
   516
  | _ ~~ _ = raise ListPair.UnequalLengths;
wenzelm@233
   517
wenzelm@233
   518
(*inverse of ~~; the old 'split':
wenzelm@233
   519
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
skalberg@15570
   520
val split_list = ListPair.unzip;
wenzelm@233
   521
haftmann@28347
   522
fun burrow_fst f xs = split_list xs |>> f |> op ~~;
haftmann@28347
   523
wenzelm@233
   524
wenzelm@233
   525
(* prefixes, suffixes *)
wenzelm@233
   526
haftmann@18441
   527
fun is_prefix _ [] _ = true
haftmann@18441
   528
  | is_prefix eq (x :: xs) (y :: ys) = eq (x, y) andalso is_prefix eq xs ys
haftmann@18441
   529
  | is_prefix eq _ _ = false;
wenzelm@233
   530
wenzelm@233
   531
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   532
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   533
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   534
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   535
        | take (rxs, x :: xs) =
wenzelm@255
   536
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   537
  in  take([], xs)  end;
wenzelm@233
   538
haftmann@20108
   539
fun chop_prefix eq ([], ys) = ([], ([], ys))
haftmann@20108
   540
  | chop_prefix eq (xs, []) = ([], (xs, []))
wenzelm@23220
   541
  | chop_prefix eq (xs as x :: xs', ys as y :: ys') =
haftmann@20108
   542
      if eq (x, y) then
haftmann@20108
   543
        let val (ps', xys'') = chop_prefix eq (xs', ys')
wenzelm@23220
   544
        in (x :: ps', xys'') end
haftmann@20108
   545
      else ([], (xs, ys));
haftmann@20108
   546
wenzelm@233
   547
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   548
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   549
fun take_suffix _ [] = ([], [])
wenzelm@233
   550
  | take_suffix pred (x :: xs) =
wenzelm@233
   551
      (case take_suffix pred xs of
wenzelm@233
   552
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   553
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   554
wenzelm@12249
   555
fun prefixes1 [] = []
wenzelm@12249
   556
  | prefixes1 (x :: xs) = map (cons x) ([] :: prefixes1 xs);
wenzelm@12249
   557
wenzelm@19011
   558
fun prefixes xs = [] :: prefixes1 xs;
wenzelm@19011
   559
wenzelm@12249
   560
fun suffixes1 xs = map rev (prefixes1 (rev xs));
wenzelm@19011
   561
fun suffixes xs = [] :: suffixes1 xs;
wenzelm@233
   562
wenzelm@61707
   563
fun trim pred = take_prefix pred #> #2 #> take_suffix pred #> #1;
wenzelm@23220
   564
wenzelm@23220
   565
wenzelm@233
   566
(** integers **)
wenzelm@233
   567
wenzelm@233
   568
(* lists of integers *)
wenzelm@233
   569
wenzelm@233
   570
(*make the list [from, from + 1, ..., to]*)
wenzelm@24593
   571
fun ((i: int) upto j) =
wenzelm@21859
   572
  if i > j then [] else i :: (i + 1 upto j);
wenzelm@233
   573
wenzelm@233
   574
(*make the list [from, from - 1, ..., to]*)
wenzelm@24593
   575
fun ((i: int) downto j) =
wenzelm@21859
   576
  if i < j then [] else i :: (i - 1 downto j);
wenzelm@233
   577
wenzelm@233
   578
wenzelm@233
   579
(* convert integers to strings *)
wenzelm@233
   580
wenzelm@233
   581
(*expand the number in the given base;
wenzelm@233
   582
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   583
fun radixpand (base, num) : int list =
wenzelm@233
   584
  let
wenzelm@233
   585
    fun radix (n, tail) =
wenzelm@233
   586
      if n < base then n :: tail
wenzelm@233
   587
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   588
  in radix (num, []) end;
wenzelm@233
   589
wenzelm@233
   590
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   591
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   592
fun radixstring (base, zerochar, num) =
wenzelm@233
   593
  let val offset = ord zerochar;
wenzelm@233
   594
      fun chrof n = chr (offset + n)
wenzelm@233
   595
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   596
wenzelm@233
   597
wenzelm@41492
   598
local
wenzelm@64275
   599
  val zero = Char.ord #"0";
wenzelm@57909
   600
  val small_int = 10000: int;
wenzelm@57909
   601
  val small_int_table = Vector.tabulate (small_int, Int.toString);
wenzelm@41492
   602
in
wenzelm@41492
   603
wenzelm@41492
   604
fun string_of_int i =
wenzelm@41492
   605
  if i < 0 then Int.toString i
wenzelm@41492
   606
  else if i < 10 then chr (zero + i)
wenzelm@57909
   607
  else if i < small_int then Vector.sub (small_int_table, i)
wenzelm@41492
   608
  else Int.toString i;
wenzelm@41492
   609
wenzelm@41492
   610
end;
wenzelm@233
   611
wenzelm@21942
   612
fun signed_string_of_int i =
wenzelm@21942
   613
  if i < 0 then "-" ^ string_of_int (~ i) else string_of_int i;
wenzelm@21942
   614
wenzelm@23220
   615
fun string_of_indexname (a, 0) = a
wenzelm@23220
   616
  | string_of_indexname (a, i) = a ^ "_" ^ string_of_int i;
wenzelm@233
   617
wenzelm@233
   618
wenzelm@14826
   619
(* read integers *)
wenzelm@14826
   620
wenzelm@24630
   621
fun read_radix_int radix cs =
wenzelm@20095
   622
  let
wenzelm@64275
   623
    val zero = Char.ord #"0";
wenzelm@20095
   624
    val limit = zero + radix;
wenzelm@20095
   625
    fun scan (num, []) = (num, [])
wenzelm@20095
   626
      | scan (num, c :: cs) =
wenzelm@50637
   627
          if zero <= ord c andalso ord c < limit then
wenzelm@50637
   628
            scan (radix * num + (ord c - zero), cs)
wenzelm@50637
   629
          else (num, c :: cs);
wenzelm@24630
   630
  in scan (0, cs) end;
wenzelm@14826
   631
wenzelm@24630
   632
val read_int = read_radix_int 10;
wenzelm@14826
   633
wenzelm@40627
   634
fun oct_char s = chr (#1 (read_radix_int 8 (raw_explode s)));
wenzelm@14826
   635
wenzelm@14826
   636
wenzelm@14826
   637
wenzelm@233
   638
(** strings **)
wenzelm@233
   639
wenzelm@16188
   640
(* functions tuned for strings, avoiding explode *)
wenzelm@6312
   641
haftmann@18011
   642
fun nth_string str i =
wenzelm@6959
   643
  (case try String.substring (str, i, 1) of
skalberg@15531
   644
    SOME s => s
skalberg@15570
   645
  | NONE => raise Subscript);
wenzelm@6312
   646
wenzelm@16188
   647
fun fold_string f str x0 =
wenzelm@6282
   648
  let
wenzelm@6282
   649
    val n = size str;
wenzelm@16188
   650
    fun iter (x, i) =
wenzelm@16188
   651
      if i < n then iter (f (String.substring (str, i, 1)) x, i + 1) else x;
wenzelm@16188
   652
  in iter (x0, 0) end;
wenzelm@6282
   653
wenzelm@14968
   654
fun exists_string pred str =
wenzelm@14968
   655
  let
wenzelm@14968
   656
    val n = size str;
wenzelm@14968
   657
    fun ex i = i < n andalso (pred (String.substring (str, i, 1)) orelse ex (i + 1));
wenzelm@14968
   658
  in ex 0 end;
wenzelm@6312
   659
wenzelm@16188
   660
fun forall_string pred = not o exists_string (not o pred);
wenzelm@16188
   661
wenzelm@28025
   662
fun first_field sep str =
wenzelm@28022
   663
  let
wenzelm@28025
   664
    val n = size sep;
wenzelm@28022
   665
    val len = size str;
wenzelm@28022
   666
    fun find i =
wenzelm@28022
   667
      if i + n > len then NONE
wenzelm@28025
   668
      else if String.substring (str, i, n) = sep then SOME i
wenzelm@28022
   669
      else find (i + 1);
wenzelm@28025
   670
  in
wenzelm@28025
   671
    (case find 0 of
wenzelm@28025
   672
      NONE => NONE
wenzelm@28025
   673
    | SOME i => SOME (String.substring (str, 0, i), String.extract (str, i + n, NONE)))
wenzelm@28025
   674
  end;
wenzelm@28022
   675
lcp@512
   676
(*enclose in brackets*)
lcp@512
   677
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@6642
   678
fun unenclose str = String.substring (str, 1, size str - 2);
wenzelm@255
   679
wenzelm@233
   680
(*simple quoting (does not escape special chars)*)
lcp@512
   681
val quote = enclose "\"" "\"";
wenzelm@233
   682
wenzelm@62529
   683
val cartouche = enclose "\<open>" "\<close>";
wenzelm@55033
   684
wenzelm@59469
   685
val space_implode = String.concatWith;
wenzelm@233
   686
wenzelm@255
   687
val commas = space_implode ", ";
wenzelm@380
   688
val commas_quote = commas o map quote;
wenzelm@255
   689
wenzelm@255
   690
val cat_lines = space_implode "\n";
wenzelm@233
   691
wenzelm@4212
   692
(*space_explode "." "h.e..l.lo" = ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   693
fun space_explode _ "" = []
paulson@21899
   694
  | space_explode sep s = String.fields (fn c => str c = sep) s;
wenzelm@3832
   695
wenzelm@3832
   696
val split_lines = space_explode "\n";
wenzelm@3832
   697
wenzelm@56038
   698
fun plain_words s = space_explode "_" s |> space_implode " ";
wenzelm@56038
   699
wenzelm@14826
   700
fun prefix_lines "" txt = txt
wenzelm@14826
   701
  | prefix_lines prfx txt = txt |> split_lines |> map (fn s => prfx ^ s) |> cat_lines;
wenzelm@14826
   702
wenzelm@18681
   703
fun prefix prfx s = prfx ^ s;
wenzelm@16188
   704
fun suffix sffx s = s ^ sffx;
wenzelm@5285
   705
wenzelm@18681
   706
fun unprefix prfx s =
wenzelm@18681
   707
  if String.isPrefix prfx s then String.substring (s, size prfx, size s - size prfx)
wenzelm@18681
   708
  else raise Fail "unprefix";
wenzelm@18681
   709
wenzelm@16188
   710
fun unsuffix sffx s =
wenzelm@17061
   711
  if String.isSuffix sffx s then String.substring (s, 0, size s - size sffx)
wenzelm@17061
   712
  else raise Fail "unsuffix";
wenzelm@5285
   713
wenzelm@47499
   714
val trim_line = perhaps (try (unsuffix "\n"));
wenzelm@47499
   715
wenzelm@24593
   716
fun replicate_string (0: int) _ = ""
wenzelm@10951
   717
  | replicate_string 1 a = a
wenzelm@10951
   718
  | replicate_string k a =
wenzelm@10951
   719
      if k mod 2 = 0 then replicate_string (k div 2) (a ^ a)
wenzelm@10951
   720
      else replicate_string (k div 2) (a ^ a) ^ a;
wenzelm@10951
   721
haftmann@31250
   722
fun translate_string f = String.translate (f o String.str);
haftmann@31250
   723
haftmann@63304
   724
fun align_right c k s =
haftmann@63304
   725
  let
haftmann@63304
   726
    val _ = if size c <> 1 orelse size s > k
haftmann@63304
   727
      then raise Fail "align_right" else ()
haftmann@63304
   728
  in replicate_string (k - size s) c ^ s end;
haftmann@63304
   729
kleing@29882
   730
(*crude matching of str against simple glob pat*)
kleing@29882
   731
fun match_string pat str =
kleing@29882
   732
  let
kleing@29882
   733
    fun match [] _ = true
kleing@29882
   734
      | match (p :: ps) s =
kleing@29882
   735
          size p <= size s andalso
kleing@29882
   736
            (case try (unprefix p) s of
kleing@29882
   737
              SOME s' => match ps s'
kleing@29882
   738
            | NONE => match (p :: ps) (String.substring (s, 1, size s - 1)));
kleing@29882
   739
  in match (space_explode "*" pat) str end;
wenzelm@23220
   740
wenzelm@35976
   741
wenzelm@41516
   742
(** reals **)
wenzelm@41516
   743
wenzelm@41516
   744
val string_of_real = Real.fmt (StringCvt.GEN NONE);
wenzelm@41516
   745
wenzelm@41516
   746
fun signed_string_of_real x =
wenzelm@41516
   747
  if x < 0.0 then "-" ^ string_of_real (~ x) else string_of_real x;
wenzelm@41516
   748
wenzelm@41516
   749
wenzelm@35976
   750
wenzelm@16492
   751
(** lists as sets -- see also Pure/General/ord_list.ML **)
wenzelm@233
   752
wenzelm@26439
   753
(* canonical operations *)
wenzelm@26439
   754
wenzelm@18923
   755
fun member eq list x =
wenzelm@18923
   756
  let
wenzelm@18923
   757
    fun memb [] = false
wenzelm@18923
   758
      | memb (y :: ys) = eq (x, y) orelse memb ys;
wenzelm@18923
   759
  in memb list end;
berghofe@1576
   760
wenzelm@18923
   761
fun insert eq x xs = if member eq xs x then xs else x :: xs;
wenzelm@18923
   762
fun remove eq x xs = if member eq xs x then filter_out (fn y => eq (x, y)) xs else xs;
wenzelm@24049
   763
fun update eq x xs = cons x (remove eq x xs);
wenzelm@233
   764
haftmann@33049
   765
fun inter eq xs = filter (member eq xs);
haftmann@33049
   766
haftmann@33042
   767
fun union eq = fold (insert eq);
wenzelm@19301
   768
fun subtract eq = fold (remove eq);
wenzelm@19301
   769
wenzelm@30572
   770
fun merge eq (xs, ys) =
wenzelm@30572
   771
  if pointer_eq (xs, ys) then xs
wenzelm@30572
   772
  else if null xs then ys
wenzelm@30572
   773
  else fold_rev (insert eq) ys xs;
clasohm@0
   774
wenzelm@26439
   775
haftmann@33050
   776
(* subset and set equality *)
haftmann@33050
   777
haftmann@33038
   778
fun subset eq (xs, ys) = forall (member eq ys) xs;
berghofe@1576
   779
haftmann@33038
   780
fun eq_set eq (xs, ys) =
haftmann@20348
   781
  eq_list eq (xs, ys) orelse
haftmann@33038
   782
    (subset eq (xs, ys) andalso subset (eq o swap) (ys, xs));
wenzelm@19301
   783
wenzelm@265
   784
wenzelm@233
   785
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
   786
  first of equal elements*)
wenzelm@19046
   787
fun distinct eq lst =
wenzelm@233
   788
  let
wenzelm@233
   789
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
   790
      | dist (rev_seen, x :: xs) =
wenzelm@18923
   791
          if member eq rev_seen x then dist (rev_seen, xs)
wenzelm@233
   792
          else dist (x :: rev_seen, xs);
wenzelm@19046
   793
  in dist ([], lst) end;
wenzelm@233
   794
wenzelm@255
   795
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
   796
  order, takes first of equal elements*)
wenzelm@18966
   797
fun duplicates eq lst =
wenzelm@255
   798
  let
wenzelm@255
   799
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
   800
      | dups (rev_dups, x :: xs) =
wenzelm@18923
   801
          if member eq rev_dups x orelse not (member eq xs x) then
wenzelm@255
   802
            dups (rev_dups, xs)
wenzelm@255
   803
          else dups (x :: rev_dups, xs);
wenzelm@18966
   804
  in dups ([], lst) end;
wenzelm@255
   805
wenzelm@16878
   806
fun has_duplicates eq =
wenzelm@16878
   807
  let
wenzelm@16878
   808
    fun dups [] = false
wenzelm@16878
   809
      | dups (x :: xs) = member eq xs x orelse dups xs;
wenzelm@16878
   810
  in dups end;
wenzelm@16878
   811
wenzelm@255
   812
haftmann@32352
   813
(* matrices *)
haftmann@32352
   814
haftmann@32352
   815
fun map_transpose f xss =
haftmann@32352
   816
  let
wenzelm@40722
   817
    val n =
wenzelm@40722
   818
      (case distinct (op =) (map length xss) of
wenzelm@40722
   819
        [] => 0
haftmann@32352
   820
      | [n] => n
wenzelm@40722
   821
      | _ => raise ListPair.UnequalLengths);
haftmann@33206
   822
  in map_range (fn m => f (map (fn xs => nth xs m) xss)) n end;
haftmann@32352
   823
haftmann@32352
   824
wenzelm@23220
   825
nipkow@22142
   826
(** lists as multisets **)
nipkow@22142
   827
haftmann@33078
   828
fun remove1 eq x [] = []
haftmann@33078
   829
  | remove1 eq x (y :: ys) = if eq (x, y) then ys else y :: remove1 eq x ys;
nipkow@22142
   830
haftmann@33078
   831
fun combine eq xs ys = fold (remove1 eq) ys xs @ ys;
wenzelm@233
   832
haftmann@33079
   833
fun submultiset _ ([], _)  = true
haftmann@33079
   834
  | submultiset eq (x :: xs, ys) = member eq ys x andalso submultiset eq (xs, remove1 eq x ys);
haftmann@33079
   835
clasohm@0
   836
clasohm@0
   837
wenzelm@2506
   838
(** orders **)
wenzelm@2506
   839
wenzelm@18966
   840
fun is_equal EQUAL = true
wenzelm@18966
   841
  | is_equal _ = false;
wenzelm@18966
   842
wenzelm@4445
   843
fun rev_order LESS = GREATER
wenzelm@4445
   844
  | rev_order EQUAL = EQUAL
wenzelm@4445
   845
  | rev_order GREATER = LESS;
wenzelm@4445
   846
wenzelm@4479
   847
(*assume rel is a linear strict order*)
wenzelm@4445
   848
fun make_ord rel (x, y) =
wenzelm@4445
   849
  if rel (x, y) then LESS
wenzelm@4445
   850
  else if rel (y, x) then GREATER
wenzelm@4445
   851
  else EQUAL;
wenzelm@4445
   852
wenzelm@25224
   853
fun bool_ord (false, true) = LESS
wenzelm@25224
   854
  | bool_ord (true, false) = GREATER
wenzelm@25224
   855
  | bool_ord _ = EQUAL;
wenzelm@25224
   856
wenzelm@15051
   857
val int_ord = Int.compare;
wenzelm@15051
   858
val string_ord = String.compare;
wenzelm@2506
   859
wenzelm@16676
   860
fun fast_string_ord (s1, s2) =
wenzelm@43793
   861
  if pointer_eq (s1, s2) then EQUAL
wenzelm@43793
   862
  else (case int_ord (size s1, size s2) of EQUAL => string_ord (s1, s2) | ord => ord);
wenzelm@16676
   863
wenzelm@16492
   864
fun option_ord ord (SOME x, SOME y) = ord (x, y)
wenzelm@16492
   865
  | option_ord _ (NONE, NONE) = EQUAL
wenzelm@16492
   866
  | option_ord _ (NONE, SOME _) = LESS
wenzelm@16492
   867
  | option_ord _ (SOME _, NONE) = GREATER;
wenzelm@16492
   868
wenzelm@4343
   869
(*lexicographic product*)
wenzelm@4343
   870
fun prod_ord a_ord b_ord ((x, y), (x', y')) =
wenzelm@4343
   871
  (case a_ord (x, x') of EQUAL => b_ord (y, y') | ord => ord);
wenzelm@4343
   872
wenzelm@4343
   873
(*dictionary order -- in general NOT well-founded!*)
wenzelm@16984
   874
fun dict_ord elem_ord (x :: xs, y :: ys) =
wenzelm@16984
   875
      (case elem_ord (x, y) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord)
wenzelm@16984
   876
  | dict_ord _ ([], []) = EQUAL
wenzelm@4343
   877
  | dict_ord _ ([], _ :: _) = LESS
wenzelm@16984
   878
  | dict_ord _ (_ :: _, []) = GREATER;
wenzelm@4343
   879
wenzelm@4343
   880
(*lexicographic product of lists*)
wenzelm@4343
   881
fun list_ord elem_ord (xs, ys) =
wenzelm@16676
   882
  (case int_ord (length xs, length ys) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord);
wenzelm@4343
   883
wenzelm@2506
   884
wenzelm@4621
   885
(* sorting *)
wenzelm@4621
   886
wenzelm@48271
   887
(*stable mergesort -- preserves order of equal elements*)
wenzelm@48271
   888
fun mergesort unique ord =
wenzelm@4621
   889
  let
wenzelm@48271
   890
    fun merge (xs as x :: xs') (ys as y :: ys') =
wenzelm@48271
   891
          (case ord (x, y) of
wenzelm@48271
   892
            LESS => x :: merge xs' ys
wenzelm@48271
   893
          | EQUAL =>
wenzelm@48271
   894
              if unique then merge xs ys'
wenzelm@48271
   895
              else x :: merge xs' ys
wenzelm@48271
   896
          | GREATER => y :: merge xs ys')
wenzelm@48271
   897
      | merge [] ys = ys
wenzelm@48271
   898
      | merge xs [] = xs;
wenzelm@48271
   899
wenzelm@48271
   900
    fun merge_all [xs] = xs
wenzelm@48271
   901
      | merge_all xss = merge_all (merge_pairs xss)
wenzelm@48271
   902
    and merge_pairs (xs :: ys :: xss) = merge xs ys :: merge_pairs xss
wenzelm@48271
   903
      | merge_pairs xss = xss;
wenzelm@48271
   904
wenzelm@48271
   905
    fun runs (x :: y :: xs) =
wenzelm@18427
   906
          (case ord (x, y) of
wenzelm@48271
   907
             LESS => ascending y [x] xs
wenzelm@48271
   908
           | EQUAL =>
wenzelm@48271
   909
               if unique then runs (x :: xs)
wenzelm@48271
   910
               else ascending y [x] xs
wenzelm@48271
   911
           | GREATER => descending y [x] xs)
wenzelm@48271
   912
      | runs xs = [xs]
wenzelm@4621
   913
wenzelm@48271
   914
    and ascending x xs (zs as y :: ys) =
wenzelm@48271
   915
          (case ord (x, y) of
wenzelm@48271
   916
             LESS => ascending y (x :: xs) ys
wenzelm@48271
   917
           | EQUAL =>
wenzelm@48271
   918
               if unique then ascending x xs ys
wenzelm@48271
   919
               else ascending y (x :: xs) ys
wenzelm@48271
   920
           | GREATER => rev (x :: xs) :: runs zs)
wenzelm@48271
   921
      | ascending x xs [] = [rev (x :: xs)]
wenzelm@48271
   922
wenzelm@48271
   923
    and descending x xs (zs as y :: ys) =
wenzelm@48271
   924
          (case ord (x, y) of
wenzelm@48271
   925
             GREATER => descending y (x :: xs) ys
wenzelm@48271
   926
           | EQUAL =>
wenzelm@48271
   927
               if unique then descending x xs ys
wenzelm@48271
   928
               else (x :: xs) :: runs zs
wenzelm@48271
   929
           | LESS => (x :: xs) :: runs zs)
wenzelm@48271
   930
      | descending x xs [] = [x :: xs];
wenzelm@48271
   931
wenzelm@48271
   932
  in merge_all o runs end;
wenzelm@48271
   933
wenzelm@48271
   934
fun sort ord = mergesort false ord;
wenzelm@48271
   935
fun sort_distinct ord = mergesort true ord;
wenzelm@18427
   936
wenzelm@4621
   937
val sort_strings = sort string_ord;
wenzelm@60924
   938
fun sort_by key xs = sort (string_ord o apply2 key) xs;
wenzelm@4621
   939
wenzelm@4621
   940
wenzelm@30558
   941
(* items tagged by integer index *)
wenzelm@30558
   942
wenzelm@30558
   943
(*insert tags*)
wenzelm@30558
   944
fun tag_list k [] = []
haftmann@30570
   945
  | tag_list k (x :: xs) = (k:int, x) :: tag_list (k + 1) xs;
wenzelm@30558
   946
wenzelm@30558
   947
(*remove tags and suppress duplicates -- list is assumed sorted!*)
wenzelm@30558
   948
fun untag_list [] = []
wenzelm@30558
   949
  | untag_list [(k: int, x)] = [x]
wenzelm@30558
   950
  | untag_list ((k, x) :: (rest as (k', x') :: _)) =
wenzelm@30558
   951
      if k = k' then untag_list rest
wenzelm@30558
   952
      else x :: untag_list rest;
wenzelm@30558
   953
wenzelm@30558
   954
(*return list elements in original order*)
wenzelm@59058
   955
fun order_list list = untag_list (sort (int_ord o apply2 fst) list);
wenzelm@30558
   956
wenzelm@30558
   957
wenzelm@2506
   958
wenzelm@4621
   959
(** misc **)
wenzelm@233
   960
wenzelm@19644
   961
fun divide_and_conquer decomp x =
wenzelm@19644
   962
  let val (ys, recomb) = decomp x
wenzelm@19644
   963
  in recomb (map (divide_and_conquer decomp) ys) end;
wenzelm@19644
   964
wenzelm@32978
   965
fun divide_and_conquer' decomp x s =
wenzelm@32978
   966
  let val ((ys, recomb), s') = decomp x s
wenzelm@32978
   967
  in recomb (fold_map (divide_and_conquer' decomp) ys s') end;
wenzelm@32978
   968
clasohm@0
   969
wenzelm@233
   970
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
   971
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
   972
fun partition_list p i j =
wenzelm@37851
   973
  let
wenzelm@37851
   974
    fun part (k: int) xs =
wenzelm@37851
   975
      if k > j then
wenzelm@37851
   976
        (case xs of
wenzelm@37851
   977
          [] => []
wenzelm@37851
   978
        | _ => raise Fail "partition_list")
wenzelm@37851
   979
      else
wenzelm@37851
   980
        let val (ns, rest) = List.partition (p k) xs
wenzelm@37851
   981
        in ns :: part (k + 1) rest end;
wenzelm@37851
   982
  in part (i: int) end;
clasohm@0
   983
wenzelm@37851
   984
fun partition_eq (eq: 'a * 'a -> bool) =
wenzelm@19691
   985
  let
wenzelm@19691
   986
    fun part [] = []
wenzelm@19691
   987
      | part (x :: ys) =
wenzelm@19691
   988
          let val (xs, xs') = List.partition (fn y => eq (x, y)) ys
wenzelm@37851
   989
          in (x :: xs) :: part xs' end;
wenzelm@19691
   990
  in part end;
wenzelm@19691
   991
wenzelm@19691
   992
wenzelm@45626
   993
(* serial numbers and abstract stamps *)
wenzelm@16439
   994
wenzelm@16439
   995
type serial = int;
wenzelm@62918
   996
val serial = Counter.make ();
wenzelm@19512
   997
val serial_string = string_of_int o serial;
wenzelm@19512
   998
wenzelm@45626
   999
datatype stamp = Stamp of serial;
wenzelm@45626
  1000
fun stamp () = Stamp (serial ());
wenzelm@45626
  1001
wenzelm@16535
  1002
wenzelm@51368
  1003
(* values of any type *)
wenzelm@16535
  1004
wenzelm@16535
  1005
(*note that the builtin exception datatype may be extended by new
wenzelm@16535
  1006
  constructors at any time*)
wenzelm@51368
  1007
structure Any = struct type T = exn end;
wenzelm@16535
  1008
wenzelm@43603
  1009
wenzelm@43603
  1010
(* getenv *)
wenzelm@43603
  1011
wenzelm@43603
  1012
fun getenv x =
wenzelm@43603
  1013
  (case OS.Process.getEnv x of
wenzelm@43603
  1014
    NONE => ""
wenzelm@43603
  1015
  | SOME y => y);
wenzelm@43603
  1016
wenzelm@43603
  1017
fun getenv_strict x =
wenzelm@43603
  1018
  (case getenv x of
wenzelm@43603
  1019
    "" => error ("Undefined Isabelle environment variable: " ^ quote x)
wenzelm@43603
  1020
  | y => y);
wenzelm@43603
  1021
clasohm@1364
  1022
end;
clasohm@1364
  1023
wenzelm@32188
  1024
structure Basic_Library: BASIC_LIBRARY = Library;
wenzelm@32188
  1025
open Basic_Library;
wenzelm@40722
  1026