src/Pure/library.ML
author wenzelm
Tue Feb 07 19:56:48 2006 +0100 (2006-02-07)
changeset 18966 dc49d8b18886
parent 18923 34f9df073ad9
child 18989 a5c3bc6fd6b6
permissions -rw-r--r--
removed eq-polymorphic duplicates;
renamed gen_duplicates to duplicates;
added is_equal;
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,
haftmann@17952
     7
strings, lists as sets, association lists, generic
wenzelm@14826
     8
tables, balanced trees, orders, current directory, misc.
clasohm@0
     9
*)
clasohm@0
    10
haftmann@17257
    11
infix 1 |> |-> ||> ||>> |>> |>>> #> #->;
haftmann@17257
    12
infix 2 ?;
haftmann@17257
    13
infix 3 o oo ooo oooo;
clasohm@1364
    14
haftmann@17257
    15
infix 4 ~~ upto downto;
haftmann@18441
    16
infix orf andf \ \\ ins ins_string ins_int mem mem_int mem_string union union_int
haftmann@17257
    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@16842
    22
  val I: 'a -> 'a
wenzelm@16842
    23
  val K: 'a -> 'b -> 'a
wenzelm@4621
    24
  val curry: ('a * 'b -> 'c) -> 'a -> 'b -> 'c
wenzelm@4621
    25
  val uncurry: ('a -> 'b -> 'c) -> 'a * 'b -> 'c
wenzelm@4621
    26
  val |> : 'a * ('a -> 'b) -> 'b
haftmann@16691
    27
  val |-> : ('c * 'a) * ('c -> 'a -> 'b) -> 'b
haftmann@16780
    28
  val ||> : ('c * 'a) * ('a -> 'b) -> 'c * 'b
haftmann@16780
    29
  val ||>> : ('c * 'a) * ('a -> 'd * 'b) -> ('c * 'd) * 'b
haftmann@16691
    30
  val |>> : ('a * 'c) * ('a -> 'b) -> 'b * 'c
haftmann@16691
    31
  val |>>> : ('a * 'c) * ('a -> 'b * 'd) -> 'b * ('c * 'd)
haftmann@16780
    32
  val #> : ('a -> 'b) * ('b -> 'c) -> 'a -> 'c
haftmann@16780
    33
  val #-> : ('a -> 'c * 'b) * ('c -> 'b -> 'd) -> 'a -> 'd
haftmann@17141
    34
  val ? : ('a -> bool) * ('a -> 'a) -> 'a -> 'a
haftmann@16825
    35
  val ` : ('b -> 'a) -> 'b -> 'a * 'b
wenzelm@17101
    36
  val tap: ('b -> 'a) -> 'b -> 'b
wenzelm@16721
    37
  val oo: ('a -> 'b) * ('c -> 'd -> 'a) -> 'c -> 'd -> 'b
wenzelm@16721
    38
  val ooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'a) -> 'c -> 'd -> 'e -> 'b
wenzelm@16721
    39
  val oooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'f -> 'a) -> 'c -> 'd -> 'e -> 'f -> 'b
wenzelm@16842
    40
  val funpow: int -> ('a -> 'a) -> 'a -> 'a
clasohm@1364
    41
wenzelm@15670
    42
  (*old options -- invalidated*)
wenzelm@15670
    43
  datatype invalid = None of invalid
wenzelm@15670
    44
  exception OPTION of invalid
wenzelm@15670
    45
wenzelm@15970
    46
  (*options*)
wenzelm@15970
    47
  val the: 'a option -> 'a
haftmann@17153
    48
  val these: 'a list option -> 'a list
haftmann@17313
    49
  val the_default: 'a -> 'a option -> 'a
haftmann@17313
    50
  val the_list: 'a option -> 'a list
wenzelm@15970
    51
  val if_none: 'a option -> 'a -> 'a
wenzelm@15970
    52
  val is_some: 'a option -> bool
wenzelm@15970
    53
  val is_none: 'a option -> bool
haftmann@18333
    54
  val perhaps: ('a -> 'a option) -> 'a -> 'a
wenzelm@15970
    55
wenzelm@18681
    56
  (*exceptions*)
wenzelm@6959
    57
  val try: ('a -> 'b) -> 'a -> 'b option
wenzelm@4621
    58
  val can: ('a -> 'b) -> 'a -> bool
wenzelm@18681
    59
  exception EXCEPTION of exn * string
wenzelm@18681
    60
  val do_transform_failure: bool ref
wenzelm@18681
    61
  val transform_failure: (exn -> exn) -> ('a -> 'b) -> 'a -> 'b
wenzelm@14868
    62
  datatype 'a result = Result of 'a | Exn of exn
wenzelm@14868
    63
  val capture: ('a -> 'b) -> 'a -> 'b result
wenzelm@14868
    64
  val release: 'a result -> 'a
wenzelm@14868
    65
  val get_result: 'a result -> 'a option
wenzelm@14868
    66
  val get_exn: 'a result -> exn option
wenzelm@4621
    67
wenzelm@18681
    68
  (*errors*)
wenzelm@18681
    69
  exception ERROR of string
wenzelm@18681
    70
  val error: string -> 'a
wenzelm@18681
    71
  val cat_error: string -> string -> 'a
wenzelm@18681
    72
  val sys_error: string -> 'a
wenzelm@18681
    73
  val assert: bool -> string -> unit
wenzelm@18681
    74
  val deny: bool -> string -> unit
wenzelm@18681
    75
  val assert_all: ('a -> bool) -> 'a list -> ('a -> string) -> unit
wenzelm@18681
    76
wenzelm@4621
    77
  (*pairs*)
wenzelm@4621
    78
  val pair: 'a -> 'b -> 'a * 'b
wenzelm@4621
    79
  val rpair: 'a -> 'b -> 'b * 'a
wenzelm@4621
    80
  val fst: 'a * 'b -> 'a
wenzelm@4621
    81
  val snd: 'a * 'b -> 'b
haftmann@17498
    82
  val eq_fst: ('a * 'c -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@17498
    83
  val eq_snd: ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
wenzelm@4621
    84
  val swap: 'a * 'b -> 'b * 'a
wenzelm@4621
    85
  val apfst: ('a -> 'b) -> 'a * 'c -> 'b * 'c
wenzelm@4621
    86
  val apsnd: ('a -> 'b) -> 'c * 'a -> 'c * 'b
wenzelm@4621
    87
  val pairself: ('a -> 'b) -> 'a * 'a -> 'b * 'b
wenzelm@4621
    88
wenzelm@4621
    89
  (*booleans*)
wenzelm@4621
    90
  val equal: ''a -> ''a -> bool
wenzelm@4621
    91
  val not_equal: ''a -> ''a -> bool
wenzelm@4621
    92
  val orf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    93
  val andf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    94
  val exists: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    95
  val forall: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    96
  val set: bool ref -> bool
wenzelm@4621
    97
  val reset: bool ref -> bool
wenzelm@4621
    98
  val toggle: bool ref -> bool
wenzelm@9118
    99
  val change: 'a ref -> ('a -> 'a) -> unit
wenzelm@4621
   100
  val setmp: 'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c
wenzelm@11853
   101
  val conditional: bool -> (unit -> unit) -> unit
wenzelm@4621
   102
wenzelm@4621
   103
  (*lists*)
skalberg@15570
   104
  exception UnequalLengths
wenzelm@4621
   105
  val cons: 'a -> 'a list -> 'a list
wenzelm@5285
   106
  val single: 'a -> 'a list
wenzelm@4629
   107
  val append: 'a list -> 'a list -> 'a list
wenzelm@5904
   108
  val apply: ('a -> 'a) list -> 'a -> 'a
wenzelm@14792
   109
  val fold: ('a -> 'b -> 'b) -> 'a list -> 'b -> 'b
wenzelm@15035
   110
  val fold_rev: ('a -> 'b -> 'b) -> 'a list -> 'b -> 'b
haftmann@16869
   111
  val fold_map: ('a -> 'b -> 'c * 'b) -> 'a list -> 'b -> 'c list * 'b
wenzelm@15760
   112
  val foldr1: ('a * 'a -> 'a) -> 'a list -> 'a
haftmann@18278
   113
  val foldl_map: ('a * 'b -> 'a * 'c) -> 'a * 'b list -> 'a * 'c list
haftmann@18441
   114
  val burrow: ('a list -> 'b list) -> 'a list list -> 'b list list
haftmann@18549
   115
  val fold_burrow: ('a list -> 'c -> 'b list * 'd) -> 'a list list -> 'c -> 'b list list * 'd
nipkow@13629
   116
  val splitAt: int * 'a list -> 'a list * 'a list
nipkow@4713
   117
  val dropwhile: ('a -> bool) -> 'a list -> 'a list
haftmann@18278
   118
  val nth: 'a list -> int -> 'a
haftmann@18011
   119
  val nth_update: int * 'a -> 'a list -> 'a list
haftmann@18011
   120
  val nth_map: int -> ('a -> 'a) -> 'a list -> 'a list
wenzelm@18286
   121
  val nth_list: 'a list list -> int -> 'a list
haftmann@18514
   122
  val map_index: (int * 'a -> 'b) -> 'a list -> 'b list
haftmann@18514
   123
  val fold_index: (int * 'a -> 'b -> 'b) -> 'a list -> 'b -> 'b
wenzelm@4621
   124
  val split_last: 'a list -> 'a list * 'a
wenzelm@4621
   125
  val find_index: ('a -> bool) -> 'a list -> int
wenzelm@4621
   126
  val find_index_eq: ''a -> ''a list -> int
wenzelm@4621
   127
  val find_first: ('a -> bool) -> 'a list -> 'a option
wenzelm@4916
   128
  val get_first: ('a -> 'b option) -> 'a list -> 'b option
haftmann@18330
   129
  val map2: ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
haftmann@18330
   130
  val fold2: ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
haftmann@18330
   131
  val ~~ : 'a list * 'b list -> ('a * 'b) list
haftmann@18330
   132
  val split_list: ('a * 'b) list -> 'a list * 'b list
wenzelm@4621
   133
  val separate: 'a -> 'a list -> 'a list
wenzelm@4621
   134
  val replicate: int -> 'a -> 'a list
wenzelm@18148
   135
  val multiply: 'a list -> 'a list list -> 'a list list
wenzelm@14792
   136
  val product: 'a list -> 'b list -> ('a * 'b) list
wenzelm@16129
   137
  val filter: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   138
  val filter_out: ('a -> bool) -> 'a list -> 'a list
wenzelm@7468
   139
  val equal_lists: ('a * 'b -> bool) -> 'a list * 'b list -> bool
haftmann@18441
   140
  val is_prefix: ('a * 'a -> bool) -> 'a list -> 'a list -> bool
wenzelm@4621
   141
  val take_prefix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@4621
   142
  val take_suffix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@12249
   143
  val prefixes1: 'a list -> 'a list list
wenzelm@12249
   144
  val suffixes1: 'a list -> 'a list list
wenzelm@4621
   145
wenzelm@4621
   146
  (*integers*)
paulson@15965
   147
  val gcd: IntInf.int * IntInf.int -> IntInf.int
paulson@15965
   148
  val lcm: IntInf.int * IntInf.int -> IntInf.int
wenzelm@4621
   149
  val inc: int ref -> int
wenzelm@4621
   150
  val dec: int ref -> int
wenzelm@4621
   151
  val upto: int * int -> int list
wenzelm@4621
   152
  val downto: int * int -> int list
wenzelm@4621
   153
  val downto0: int list * int -> bool
wenzelm@4621
   154
  val radixpand: int * int -> int list
wenzelm@4621
   155
  val radixstring: int * string * int -> string
wenzelm@4621
   156
  val string_of_int: int -> string
wenzelm@4621
   157
  val string_of_indexname: string * int -> string
wenzelm@14826
   158
  val read_radixint: int * string list -> int * string list
wenzelm@14826
   159
  val read_int: string list -> int * string list
wenzelm@14826
   160
  val oct_char: string -> string
wenzelm@4621
   161
wenzelm@4621
   162
  (*strings*)
haftmann@18011
   163
  val nth_string: string -> int -> string
wenzelm@16188
   164
  val fold_string: (string -> 'a -> 'a) -> string -> 'a -> 'a
wenzelm@6312
   165
  val exists_string: (string -> bool) -> string -> bool
wenzelm@16188
   166
  val forall_string: (string -> bool) -> string -> bool
wenzelm@4621
   167
  val enclose: string -> string -> string -> string
wenzelm@6642
   168
  val unenclose: string -> string
wenzelm@4621
   169
  val quote: string -> string
wenzelm@4621
   170
  val space_implode: string -> string list -> string
wenzelm@4621
   171
  val commas: string list -> string
wenzelm@4621
   172
  val commas_quote: string list -> string
wenzelm@4621
   173
  val cat_lines: string list -> string
wenzelm@4621
   174
  val space_explode: string -> string -> string list
wenzelm@14826
   175
  val split_lines: string -> string list
wenzelm@5942
   176
  val prefix_lines: string -> string -> string
wenzelm@7712
   177
  val untabify: string list -> string list
wenzelm@18681
   178
  val prefix: string -> string -> string
wenzelm@5285
   179
  val suffix: string -> string -> string
wenzelm@18681
   180
  val unprefix: string -> string -> string
wenzelm@5285
   181
  val unsuffix: string -> string -> string
wenzelm@10951
   182
  val replicate_string: int -> string -> string
wenzelm@14926
   183
  val translate_string: (string -> string) -> string -> string
wenzelm@4621
   184
wenzelm@16492
   185
  (*lists as sets -- see also Pure/General/ord_list.ML*)
wenzelm@18923
   186
  val member: ('b * 'a -> bool) -> 'a list -> 'b -> bool
wenzelm@18923
   187
  val insert: ('a * 'a -> bool) -> 'a -> 'a list -> 'a list
wenzelm@18923
   188
  val remove: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
wenzelm@18923
   189
  val merge: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
wenzelm@4621
   190
  val mem: ''a * ''a list -> bool
wenzelm@4621
   191
  val mem_int: int * int list -> bool
wenzelm@4621
   192
  val mem_string: string * string list -> bool
wenzelm@4621
   193
  val ins: ''a * ''a list -> ''a list
wenzelm@4621
   194
  val ins_int: int * int list -> int list
wenzelm@4621
   195
  val ins_string: string * string list -> string list
wenzelm@4621
   196
  val union: ''a list * ''a list -> ''a list
wenzelm@4621
   197
  val union_int: int list * int list -> int list
wenzelm@4621
   198
  val union_string: string list * string list -> string list
wenzelm@4621
   199
  val gen_union: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
paulson@7090
   200
  val gen_inter: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   201
  val inter: ''a list * ''a list -> ''a list
wenzelm@4621
   202
  val inter_int: int list * int list -> int list
wenzelm@4621
   203
  val inter_string: string list * string list -> string list
wenzelm@4621
   204
  val subset: ''a list * ''a list -> bool
wenzelm@4621
   205
  val subset_int: int list * int list -> bool
wenzelm@4621
   206
  val subset_string: string list * string list -> bool
wenzelm@4621
   207
  val eq_set: ''a list * ''a list -> bool
wenzelm@4621
   208
  val eq_set_string: string list * string list -> bool
wenzelm@4621
   209
  val gen_subset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   210
  val \ : ''a list * ''a -> ''a list
wenzelm@4621
   211
  val \\ : ''a list * ''a list -> ''a list
wenzelm@4621
   212
  val gen_rem: ('a * 'b -> bool) -> 'a list * 'b -> 'a list
wenzelm@4621
   213
  val gen_rems: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   214
  val gen_distinct: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@4621
   215
  val distinct: ''a list -> ''a list
wenzelm@4621
   216
  val findrep: ''a list -> ''a list
wenzelm@18966
   217
  val duplicates: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@16878
   218
  val has_duplicates: ('a * 'a -> bool) -> 'a list -> bool
wenzelm@4621
   219
haftmann@17540
   220
  (*lists as tables -- see also Pure/General/alist.ML*)
wenzelm@12284
   221
  val gen_merge_lists: ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
wenzelm@12284
   222
  val gen_merge_lists': ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
wenzelm@4621
   223
  val merge_lists: ''a list -> ''a list -> ''a list
wenzelm@12284
   224
  val merge_lists': ''a list -> ''a list -> ''a list
wenzelm@4692
   225
  val merge_alists: (''a * 'b) list -> (''a * 'b) list -> (''a * 'b) list
berghofe@15263
   226
  val merge_alists': (''a * 'b) list -> (''a * 'b) list -> (''a * 'b) list
wenzelm@4621
   227
wenzelm@4621
   228
  (*balanced trees*)
wenzelm@4621
   229
  exception Balance
wenzelm@4621
   230
  val fold_bal: ('a * 'a -> 'a) -> 'a list -> 'a
wenzelm@4621
   231
  val access_bal: ('a -> 'a) * ('a -> 'a) * 'a -> int -> int -> 'a
wenzelm@4621
   232
  val accesses_bal: ('a -> 'a) * ('a -> 'a) * 'a -> int -> 'a list
wenzelm@4621
   233
wenzelm@4621
   234
  (*orders*)
wenzelm@18966
   235
  val is_equal: order -> bool
wenzelm@4621
   236
  val rev_order: order -> order
wenzelm@4621
   237
  val make_ord: ('a * 'a -> bool) -> 'a * 'a -> order
haftmann@18452
   238
  val eq_ord: ('a -> order) -> 'a -> bool
wenzelm@4621
   239
  val int_ord: int * int -> order
wenzelm@4621
   240
  val string_ord: string * string -> order
wenzelm@16676
   241
  val fast_string_ord: string * string -> order
wenzelm@16492
   242
  val option_ord: ('a * 'b -> order) -> 'a option * 'b option -> order
wenzelm@4621
   243
  val prod_ord: ('a * 'b -> order) -> ('c * 'd -> order) -> ('a * 'c) * ('b * 'd) -> order
wenzelm@4621
   244
  val dict_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   245
  val list_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   246
  val sort: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@18427
   247
  val sort_distinct: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@4621
   248
  val sort_strings: string list -> string list
wenzelm@4621
   249
  val sort_wrt: ('a -> string) -> 'a list -> 'a list
wenzelm@4621
   250
berghofe@14106
   251
  (*random numbers*)
berghofe@14106
   252
  exception RANDOM
berghofe@14106
   253
  val random: unit -> real
berghofe@14106
   254
  val random_range: int -> int -> int
berghofe@14106
   255
  val one_of: 'a list -> 'a
berghofe@14106
   256
  val frequency: (int * 'a) list -> 'a
berghofe@14106
   257
wenzelm@14826
   258
  (*current directory*)
wenzelm@4621
   259
  val cd: string -> unit
wenzelm@4621
   260
  val pwd: unit -> string
wenzelm@4621
   261
wenzelm@4621
   262
  (*misc*)
wenzelm@4621
   263
  val partition_eq: ('a * 'a -> bool) -> 'a list -> 'a list list
wenzelm@4621
   264
  val partition_list: (int -> 'a -> bool) -> int -> int -> 'a list -> 'a list list
wenzelm@4621
   265
  val gensym: string -> string
wenzelm@4621
   266
  val scanwords: (string -> bool) -> string list -> string list
wenzelm@16439
   267
  type stamp
wenzelm@16439
   268
  val stamp: unit -> stamp
wenzelm@16439
   269
  type serial
wenzelm@16439
   270
  val serial: unit -> serial
wenzelm@16535
   271
  structure Object: sig type T end
wenzelm@4621
   272
end;
wenzelm@4621
   273
wenzelm@15745
   274
signature LIBRARY =
skalberg@15570
   275
sig
wenzelm@15745
   276
  include BASIC_LIBRARY
skalberg@15570
   277
  val foldl: ('a * 'b -> 'a) -> 'a * 'b list -> 'a
skalberg@15570
   278
  val foldr: ('a * 'b -> 'b) -> 'a list * 'b -> 'b
skalberg@15570
   279
  val take: int * 'a list -> 'a list
skalberg@15570
   280
  val drop: int * 'a list -> 'a list
skalberg@15570
   281
  val last_elem: 'a list -> 'a
skalberg@15570
   282
  val flat: 'a list list -> 'a list
skalberg@15570
   283
  val seq: ('a -> unit) -> 'a list -> unit
skalberg@15570
   284
  val partition: ('a -> bool) -> 'a list -> 'a list * 'a list
skalberg@15570
   285
  val mapfilter: ('a -> 'b option) -> 'a list -> 'b list
skalberg@15570
   286
end;
skalberg@15570
   287
wenzelm@15745
   288
structure Library: LIBRARY =
clasohm@1364
   289
struct
clasohm@0
   290
wenzelm@4995
   291
wenzelm@233
   292
(** functions **)
clasohm@0
   293
wenzelm@16842
   294
fun I x = x;
wenzelm@16842
   295
fun K x = fn _ => x;
wenzelm@233
   296
fun curry f x y = f (x, y);
wenzelm@233
   297
fun uncurry f (x, y) = f x y;
clasohm@0
   298
wenzelm@16705
   299
(*reverse application and structured results*)
wenzelm@16705
   300
fun x |> f = f x;
wenzelm@16705
   301
fun (x, y) |-> f = f x y;
wenzelm@16705
   302
fun (x, y) |>> f = (f x, y);
wenzelm@16705
   303
fun (x, y) ||> f = (x, f y);
wenzelm@16705
   304
fun (x, y) |>>> f = let val (x', z) = f x in (x', (y, z)) end;
wenzelm@16705
   305
fun (x, y) ||>> f = let val (z, y') = f y in ((x, z), y') end;
wenzelm@16842
   306
wenzelm@16842
   307
(*reverse composition*)
haftmann@16780
   308
fun f #> g = g o f;
wenzelm@16842
   309
fun f #-> g = uncurry g o f;
wenzelm@16842
   310
haftmann@17141
   311
(*conditional application*)
wenzelm@17545
   312
fun b ? f = fn x => if b x then f x else x;
haftmann@17141
   313
wenzelm@16842
   314
(*view results*)
wenzelm@16842
   315
fun `f = fn x => (f x, x);
wenzelm@17545
   316
fun tap f = fn x => (f x; x);
wenzelm@380
   317
wenzelm@16721
   318
(*composition with multiple args*)
wenzelm@16721
   319
fun (f oo g) x y = f (g x y);
wenzelm@16721
   320
fun (f ooo g) x y z = f (g x y z);
wenzelm@16721
   321
fun (f oooo g) x y z w = f (g x y z w);
wenzelm@16721
   322
wenzelm@233
   323
(*function exponentiation: f(...(f x)...) with n applications of f*)
wenzelm@233
   324
fun funpow n f x =
wenzelm@233
   325
  let fun rep (0, x) = x
wenzelm@233
   326
        | rep (n, x) = rep (n - 1, f x)
wenzelm@233
   327
  in rep (n, x) end;
wenzelm@160
   328
wenzelm@160
   329
wenzelm@233
   330
(** options **)
clasohm@0
   331
wenzelm@15670
   332
(*invalidate former constructors to prevent accidental use as match-all patterns!*)
wenzelm@15670
   333
datatype invalid = None of invalid;
wenzelm@15670
   334
exception OPTION of invalid;
clasohm@0
   335
wenzelm@15970
   336
val the = Option.valOf;
wenzelm@17341
   337
haftmann@17153
   338
fun these (SOME x) = x
haftmann@17313
   339
  | these _ = [];
wenzelm@17341
   340
haftmann@17313
   341
fun the_default x (SOME y) = y
haftmann@17313
   342
  | the_default x _ = x;
wenzelm@17341
   343
haftmann@17313
   344
fun the_list (SOME x) = [x]
haftmann@17313
   345
  | the_list _ = []
wenzelm@15970
   346
wenzelm@15970
   347
(*strict!*)
wenzelm@15970
   348
fun if_none NONE y = y
wenzelm@15970
   349
  | if_none (SOME x) _ = x;
wenzelm@15970
   350
wenzelm@15970
   351
fun is_some (SOME _) = true
wenzelm@15970
   352
  | is_some NONE = false;
wenzelm@15970
   353
wenzelm@15970
   354
fun is_none (SOME _) = false
wenzelm@15970
   355
  | is_none NONE = true;
wenzelm@15970
   356
wenzelm@18376
   357
fun perhaps f x = the_default x (f x);
wenzelm@18376
   358
wenzelm@6959
   359
wenzelm@17341
   360
(* exceptions *)
wenzelm@17341
   361
wenzelm@18681
   362
val do_transform_failure = ref true;
wenzelm@18681
   363
wenzelm@18681
   364
fun transform_failure exn f x =
wenzelm@18681
   365
  if ! do_transform_failure then
wenzelm@18681
   366
    f x handle Interrupt => raise Interrupt | e => raise exn e
wenzelm@18681
   367
  else f x;
wenzelm@18681
   368
wenzelm@17341
   369
exception EXCEPTION of exn * string;
wenzelm@6959
   370
wenzelm@6959
   371
skalberg@15531
   372
fun try f x = SOME (f x)
wenzelm@18681
   373
  handle Interrupt => raise Interrupt | _ => NONE;
wenzelm@6959
   374
wenzelm@6959
   375
fun can f x = is_some (try f x);
wenzelm@4139
   376
wenzelm@4139
   377
wenzelm@14868
   378
datatype 'a result =
wenzelm@14868
   379
  Result of 'a |
wenzelm@14868
   380
  Exn of exn;
wenzelm@14868
   381
wenzelm@14868
   382
fun capture f x = Result (f x) handle e => Exn e;
wenzelm@14868
   383
wenzelm@14868
   384
fun release (Result y) = y
wenzelm@14868
   385
  | release (Exn e) = raise e;
wenzelm@14868
   386
skalberg@15531
   387
fun get_result (Result x) = SOME x
skalberg@15531
   388
  | get_result _ = NONE;
wenzelm@14868
   389
skalberg@15531
   390
fun get_exn (Exn exn) = SOME exn
skalberg@15531
   391
  | get_exn _ = NONE;
wenzelm@14868
   392
wenzelm@14868
   393
wenzelm@18681
   394
(* errors *)
wenzelm@18681
   395
wenzelm@18681
   396
exception ERROR of string;
wenzelm@18681
   397
wenzelm@18681
   398
fun error msg = raise ERROR msg;
wenzelm@18681
   399
wenzelm@18681
   400
fun cat_error "" msg = error msg
wenzelm@18681
   401
  | cat_error msg1 msg2 = error (msg1 ^ "\n" ^ msg2);
wenzelm@18681
   402
wenzelm@18681
   403
fun sys_error msg = error ("## SYSTEM ERROR ##\n" ^ msg);
wenzelm@18681
   404
wenzelm@18681
   405
fun assert p msg = if p then () else error msg;
wenzelm@18681
   406
fun deny p msg = if p then error msg else ();
wenzelm@18681
   407
wenzelm@18681
   408
fun assert_all pred list msg =
wenzelm@18681
   409
  let
wenzelm@18681
   410
    fun ass [] = ()
wenzelm@18681
   411
      | ass (x :: xs) = if pred x then ass xs else error (msg x);
wenzelm@18681
   412
  in ass list end;
wenzelm@18681
   413
wenzelm@18681
   414
wenzelm@4139
   415
wenzelm@233
   416
(** pairs **)
wenzelm@233
   417
wenzelm@233
   418
fun pair x y = (x, y);
wenzelm@233
   419
fun rpair x y = (y, x);
wenzelm@233
   420
wenzelm@233
   421
fun fst (x, y) = x;
wenzelm@233
   422
fun snd (x, y) = y;
wenzelm@233
   423
haftmann@17498
   424
fun eq_fst eq ((x1, _), (x2, _)) = eq (x1, x2);
haftmann@17498
   425
fun eq_snd eq ((_, y1), (_, y2)) = eq (y1, y2);
wenzelm@233
   426
wenzelm@233
   427
fun swap (x, y) = (y, x);
wenzelm@233
   428
wenzelm@4212
   429
(*apply function to components*)
wenzelm@233
   430
fun apfst f (x, y) = (f x, y);
wenzelm@233
   431
fun apsnd f (x, y) = (x, f y);
wenzelm@4212
   432
fun pairself f (x, y) = (f x, f y);
wenzelm@233
   433
wenzelm@233
   434
wenzelm@233
   435
wenzelm@233
   436
(** booleans **)
wenzelm@233
   437
wenzelm@233
   438
(* equality *)
wenzelm@233
   439
wenzelm@233
   440
fun equal x y = x = y;
wenzelm@233
   441
fun not_equal x y = x <> y;
wenzelm@233
   442
wenzelm@233
   443
wenzelm@233
   444
(* operators for combining predicates *)
wenzelm@233
   445
wenzelm@16721
   446
fun p orf q = fn x => p x orelse q x;
wenzelm@16721
   447
fun p andf q = fn x => p x andalso q x;
wenzelm@233
   448
wenzelm@233
   449
wenzelm@233
   450
(* predicates on lists *)
wenzelm@233
   451
wenzelm@233
   452
(*exists pred [x1, ..., xn] ===> pred x1 orelse ... orelse pred xn*)
wenzelm@233
   453
fun exists (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   454
  let fun boolf [] = false
wenzelm@233
   455
        | boolf (x :: xs) = pred x orelse boolf xs
wenzelm@233
   456
  in boolf end;
wenzelm@233
   457
wenzelm@233
   458
(*forall pred [x1, ..., xn] ===> pred x1 andalso ... andalso pred xn*)
wenzelm@233
   459
fun forall (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   460
  let fun boolf [] = true
wenzelm@233
   461
        | boolf (x :: xs) = pred x andalso boolf xs
wenzelm@233
   462
  in boolf end;
clasohm@0
   463
wenzelm@233
   464
wenzelm@380
   465
(* flags *)
wenzelm@380
   466
wenzelm@380
   467
fun set flag = (flag := true; true);
wenzelm@380
   468
fun reset flag = (flag := false; false);
wenzelm@380
   469
fun toggle flag = (flag := not (! flag); ! flag);
wenzelm@380
   470
wenzelm@9118
   471
fun change r f = r := f (! r);
wenzelm@9118
   472
wenzelm@18712
   473
(*temporarily set flag during execution*)
wenzelm@2978
   474
fun setmp flag value f x =
wenzelm@2958
   475
  let
wenzelm@2958
   476
    val orig_value = ! flag;
wenzelm@18712
   477
    val _ = flag := value;
wenzelm@18712
   478
    val result = capture f x;
wenzelm@18712
   479
    val _ = flag := orig_value;
wenzelm@18712
   480
  in release result end;
wenzelm@2958
   481
wenzelm@380
   482
wenzelm@11853
   483
(* conditional execution *)
wenzelm@11853
   484
wenzelm@11853
   485
fun conditional b f = if b then f () else ();
wenzelm@11853
   486
wenzelm@11853
   487
wenzelm@233
   488
wenzelm@233
   489
(** lists **)
wenzelm@233
   490
skalberg@15570
   491
exception UnequalLengths;
wenzelm@233
   492
wenzelm@233
   493
fun cons x xs = x :: xs;
wenzelm@5285
   494
fun single x = [x];
wenzelm@233
   495
wenzelm@4629
   496
fun append xs ys = xs @ ys;
wenzelm@4629
   497
wenzelm@5904
   498
fun apply [] x = x
wenzelm@5904
   499
  | apply (f :: fs) x = apply fs (f x);
wenzelm@5904
   500
wenzelm@233
   501
wenzelm@233
   502
(* fold *)
wenzelm@233
   503
wenzelm@16654
   504
fun fold f =
wenzelm@16654
   505
  let
wenzelm@16654
   506
    fun fold_aux [] y = y
wenzelm@16654
   507
      | fold_aux (x :: xs) y = fold_aux xs (f x y);
wenzelm@16654
   508
  in fold_aux end;
wenzelm@15760
   509
wenzelm@16654
   510
fun fold_rev f =
wenzelm@16654
   511
  let
wenzelm@16654
   512
    fun fold_aux [] y = y
wenzelm@16654
   513
      | fold_aux (x :: xs) y = f x (fold_aux xs y);
wenzelm@16654
   514
  in fold_aux end;
wenzelm@16654
   515
haftmann@16869
   516
fun fold_map f =
haftmann@16691
   517
  let
haftmann@16691
   518
    fun fold_aux [] y = ([], y)
haftmann@16691
   519
      | fold_aux (x :: xs) y =
haftmann@16691
   520
          let
wenzelm@16705
   521
            val (x', y') = f x y;
wenzelm@16705
   522
            val (xs', y'') = fold_aux xs y';
haftmann@16691
   523
          in (x' :: xs', y'') end;
haftmann@16691
   524
  in fold_aux end;
haftmann@16691
   525
wenzelm@233
   526
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   527
wenzelm@233
   528
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   529
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   530
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   531
  let fun itl (e, [])  = e
wenzelm@233
   532
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   533
  in  itl end;
wenzelm@233
   534
wenzelm@233
   535
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   536
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   537
fun foldr f (l, e) =
wenzelm@233
   538
  let fun itr [] = e
wenzelm@233
   539
        | itr (a::l) = f(a, itr l)
wenzelm@233
   540
  in  itr l  end;
wenzelm@233
   541
wenzelm@233
   542
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   543
    for n > 0, operators that associate to the right (not tail recursive)*)
wenzelm@233
   544
fun foldr1 f l =
wenzelm@4181
   545
  let fun itr [x] = x
wenzelm@233
   546
        | itr (x::l) = f(x, itr l)
wenzelm@233
   547
  in  itr l  end;
wenzelm@233
   548
haftmann@18050
   549
fun fold_index f =
haftmann@18050
   550
  let
haftmann@18514
   551
    fun fold_aux _ [] y = y
haftmann@18050
   552
      | fold_aux i (x :: xs) y = fold_aux (i+1) xs (f (i, x) y);
haftmann@18050
   553
  in fold_aux 0 end;
wenzelm@14792
   554
wenzelm@16705
   555
fun foldl_map f =
wenzelm@16705
   556
  let
wenzelm@16705
   557
    fun fold_aux (x, []) = (x, [])
wenzelm@16705
   558
      | fold_aux (x, y :: ys) =
wenzelm@16705
   559
          let
wenzelm@16705
   560
            val (x', y') = f (x, y);
wenzelm@16705
   561
            val (x'', ys') = fold_aux (x', ys);
wenzelm@16705
   562
          in (x'', y' :: ys') end;
wenzelm@16705
   563
  in fold_aux end;
wenzelm@16705
   564
wenzelm@233
   565
wenzelm@233
   566
(* basic list functions *)
wenzelm@233
   567
wenzelm@233
   568
(*take the first n elements from a list*)
wenzelm@233
   569
fun take (n, []) = []
wenzelm@233
   570
  | take (n, x :: xs) =
wenzelm@233
   571
      if n > 0 then x :: take (n - 1, xs) else [];
wenzelm@233
   572
wenzelm@233
   573
(*drop the first n elements from a list*)
wenzelm@233
   574
fun drop (n, []) = []
wenzelm@233
   575
  | drop (n, x :: xs) =
wenzelm@233
   576
      if n > 0 then drop (n - 1, xs) else x :: xs;
clasohm@0
   577
nipkow@13629
   578
fun splitAt(n,[]) = ([],[])
nipkow@13629
   579
  | splitAt(n,xs as x::ys) =
nipkow@13629
   580
      if n>0 then let val (ps,qs) = splitAt(n-1,ys) in (x::ps,qs) end
nipkow@13629
   581
      else ([],xs)
nipkow@13629
   582
nipkow@4713
   583
fun dropwhile P [] = []
nipkow@4713
   584
  | dropwhile P (ys as x::xs) = if P x then dropwhile P xs else ys;
nipkow@4713
   585
wenzelm@233
   586
(*return nth element of a list, where 0 designates the first element;
wenzelm@18461
   587
  raise Subscript if list too short*)
haftmann@18011
   588
fun nth xs i = List.nth (xs, i);
wenzelm@233
   589
wenzelm@18461
   590
fun nth_list xss i = nth xss i handle Subscript => [];
wenzelm@18461
   591
haftmann@18011
   592
(*update nth element*)
haftmann@18011
   593
fun nth_update (n, x) xs =
haftmann@18011
   594
    (case splitAt (n, xs) of
haftmann@18011
   595
      (_, []) => raise Subscript
haftmann@18011
   596
    | (prfx, _ :: sffx') => prfx @ (x :: sffx'))
haftmann@18011
   597
haftmann@18011
   598
fun nth_map 0 f (x :: xs) = f x :: xs
haftmann@18011
   599
  | nth_map n f (x :: xs) = x :: nth_map (n - 1) f xs
haftmann@18011
   600
  | nth_map _ _ [] = raise Subscript;
wenzelm@11773
   601
haftmann@18514
   602
fun map_index f =
haftmann@18514
   603
  let
haftmann@18514
   604
    fun mapp _ [] = []
haftmann@18514
   605
      | mapp i (x :: xs) = f (i, x) :: mapp (i+1) xs
haftmann@18514
   606
  in mapp 0 end;
haftmann@18514
   607
skalberg@15570
   608
val last_elem = List.last;
wenzelm@233
   609
wenzelm@3762
   610
(*rear decomposition*)
skalberg@15570
   611
fun split_last [] = raise Empty
wenzelm@3762
   612
  | split_last [x] = ([], x)
wenzelm@3762
   613
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   614
wenzelm@4212
   615
(*find the position of an element in a list*)
wenzelm@4212
   616
fun find_index pred =
wenzelm@4212
   617
  let fun find _ [] = ~1
wenzelm@4212
   618
        | find n (x :: xs) = if pred x then n else find (n + 1) xs;
wenzelm@4212
   619
  in find 0 end;
wenzelm@3762
   620
wenzelm@4224
   621
fun find_index_eq x = find_index (equal x);
wenzelm@4212
   622
wenzelm@4212
   623
(*find first element satisfying predicate*)
skalberg@15531
   624
fun find_first _ [] = NONE
wenzelm@4212
   625
  | find_first pred (x :: xs) =
skalberg@15531
   626
      if pred x then SOME x else find_first pred xs;
wenzelm@233
   627
wenzelm@4916
   628
(*get first element by lookup function*)
skalberg@15531
   629
fun get_first _ [] = NONE
wenzelm@4916
   630
  | get_first f (x :: xs) =
wenzelm@4916
   631
      (case f x of
skalberg@15531
   632
        NONE => get_first f xs
wenzelm@4916
   633
      | some => some);
wenzelm@4916
   634
wenzelm@233
   635
(*flatten a list of lists to a list*)
skalberg@15531
   636
val flat = List.concat;
wenzelm@233
   637
wenzelm@12136
   638
fun unflat (xs :: xss) ys =
nipkow@13629
   639
      let val (ps,qs) = splitAt(length xs,ys)
nipkow@13629
   640
      in ps :: unflat xss qs end
wenzelm@12136
   641
  | unflat [] [] = []
skalberg@15570
   642
  | unflat _ _ = raise UnequalLengths;
wenzelm@12136
   643
haftmann@18441
   644
fun burrow f xss =
haftmann@18359
   645
  unflat xss ((f o flat) xss);
haftmann@18359
   646
haftmann@18549
   647
fun fold_burrow f xss s =
haftmann@18549
   648
  apfst (unflat xss) (f (flat xss) s);
haftmann@18359
   649
wenzelm@233
   650
(*like Lisp's MAPC -- seq proc [x1, ..., xn] evaluates
wenzelm@233
   651
  (proc x1; ...; proc xn) for side effects*)
skalberg@15570
   652
val seq = List.app;
wenzelm@233
   653
wenzelm@233
   654
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   655
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   656
  | separate _ xs = xs;
wenzelm@233
   657
wenzelm@233
   658
(*make the list [x, x, ..., x] of length n*)
wenzelm@233
   659
fun replicate n (x: 'a) : 'a list =
wenzelm@233
   660
  let fun rep (0, xs) = xs
wenzelm@233
   661
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   662
  in
skalberg@15570
   663
    if n < 0 then raise Subscript
wenzelm@233
   664
    else rep (n, [])
wenzelm@233
   665
  end;
wenzelm@233
   666
wenzelm@14926
   667
fun translate_string f = String.translate (f o String.str);
wenzelm@14926
   668
wenzelm@4248
   669
(*multiply [a, b, c, ...] * [xs, ys, zs, ...]*)
wenzelm@18148
   670
fun multiply [] _ = []
wenzelm@18148
   671
  | multiply (x :: xs) yss = map (cons x) yss @ multiply xs yss;
wenzelm@4248
   672
wenzelm@14792
   673
(*direct product*)
wenzelm@14792
   674
fun product _ [] = []
wenzelm@14792
   675
  | product [] _ = []
wenzelm@14792
   676
  | product (x :: xs) ys = map (pair x) ys @ product xs ys;
wenzelm@14792
   677
wenzelm@233
   678
wenzelm@233
   679
(* filter *)
wenzelm@233
   680
wenzelm@233
   681
(*copy the list preserving elements that satisfy the predicate*)
skalberg@15531
   682
val filter = List.filter;
clasohm@0
   683
fun filter_out f = filter (not o f);
skalberg@15570
   684
val mapfilter = List.mapPartial;
wenzelm@233
   685
wenzelm@233
   686
wenzelm@233
   687
(* lists of pairs *)
wenzelm@233
   688
skalberg@15570
   689
exception UnequalLengths;
skalberg@15570
   690
haftmann@18330
   691
fun map2 _ [] [] = []
haftmann@18330
   692
  | map2 f (x :: xs) (y :: ys) = f x y :: map2 f xs ys
haftmann@18330
   693
  | map2 _ _ _ = raise UnequalLengths;
wenzelm@380
   694
haftmann@18330
   695
fun fold2 f =
haftmann@18330
   696
  let
haftmann@18330
   697
    fun fold_aux [] [] z = z
haftmann@18330
   698
      | fold_aux (x :: xs) (y :: ys) z = fold_aux xs ys (f x y z)
haftmann@18330
   699
      | fold_aux _ _ _ = raise UnequalLengths;
haftmann@18330
   700
  in fold_aux end;
wenzelm@380
   701
wenzelm@4956
   702
wenzelm@233
   703
(*combine two lists forming a list of pairs:
wenzelm@233
   704
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   705
fun [] ~~ [] = []
wenzelm@233
   706
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
skalberg@15570
   707
  | _ ~~ _ = raise UnequalLengths;
wenzelm@233
   708
wenzelm@233
   709
(*inverse of ~~; the old 'split':
wenzelm@233
   710
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
skalberg@15570
   711
val split_list = ListPair.unzip;
wenzelm@233
   712
haftmann@18330
   713
fun equal_lists eq (xs, ys) =
haftmann@18330
   714
  let
haftmann@18330
   715
    fun eq' [] [] = true
haftmann@18330
   716
      | eq' (x :: xs) (y :: ys) = eq (x, y) andalso eq' xs ys
haftmann@18330
   717
  in length xs = length ys andalso eq' xs ys end;
wenzelm@7468
   718
wenzelm@233
   719
wenzelm@233
   720
(* prefixes, suffixes *)
wenzelm@233
   721
haftmann@18441
   722
fun is_prefix _ [] _ = true
haftmann@18441
   723
  | is_prefix eq (x :: xs) (y :: ys) = eq (x, y) andalso is_prefix eq xs ys
haftmann@18441
   724
  | is_prefix eq _ _ = false;
wenzelm@233
   725
wenzelm@233
   726
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   727
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   728
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   729
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   730
        | take (rxs, x :: xs) =
wenzelm@255
   731
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   732
  in  take([], xs)  end;
wenzelm@233
   733
wenzelm@233
   734
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   735
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   736
fun take_suffix _ [] = ([], [])
wenzelm@233
   737
  | take_suffix pred (x :: xs) =
wenzelm@233
   738
      (case take_suffix pred xs of
wenzelm@233
   739
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   740
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   741
wenzelm@12249
   742
fun prefixes1 [] = []
wenzelm@12249
   743
  | prefixes1 (x :: xs) = map (cons x) ([] :: prefixes1 xs);
wenzelm@12249
   744
wenzelm@12249
   745
fun suffixes1 xs = map rev (prefixes1 (rev xs));
wenzelm@12249
   746
wenzelm@233
   747
wenzelm@233
   748
wenzelm@233
   749
(** integers **)
wenzelm@233
   750
wenzelm@16439
   751
fun gcd (x, y) =
paulson@15965
   752
  let fun gxd x y : IntInf.int =
nipkow@10692
   753
    if y = 0 then x else gxd y (x mod y)
nipkow@10692
   754
  in if x < y then gxd y x else gxd x y end;
nipkow@10692
   755
wenzelm@16439
   756
fun lcm (x, y) = (x * y) div gcd (x, y);
nipkow@10692
   757
wenzelm@2958
   758
fun inc i = (i := ! i + 1; ! i);
wenzelm@2958
   759
fun dec i = (i := ! i - 1; ! i);
wenzelm@233
   760
wenzelm@233
   761
wenzelm@233
   762
(* lists of integers *)
wenzelm@233
   763
wenzelm@233
   764
(*make the list [from, from + 1, ..., to]*)
paulson@2175
   765
fun (from upto to) =
wenzelm@233
   766
  if from > to then [] else from :: ((from + 1) upto to);
wenzelm@233
   767
wenzelm@233
   768
(*make the list [from, from - 1, ..., to]*)
paulson@2175
   769
fun (from downto to) =
wenzelm@233
   770
  if from < to then [] else from :: ((from - 1) downto to);
wenzelm@233
   771
wenzelm@233
   772
(*predicate: downto0 (is, n) <=> is = [n, n - 1, ..., 0]*)
wenzelm@233
   773
fun downto0 (i :: is, n) = i = n andalso downto0 (is, n - 1)
wenzelm@233
   774
  | downto0 ([], n) = n = ~1;
wenzelm@233
   775
wenzelm@233
   776
wenzelm@233
   777
(* convert integers to strings *)
wenzelm@233
   778
wenzelm@233
   779
(*expand the number in the given base;
wenzelm@233
   780
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   781
fun radixpand (base, num) : int list =
wenzelm@233
   782
  let
wenzelm@233
   783
    fun radix (n, tail) =
wenzelm@233
   784
      if n < base then n :: tail
wenzelm@233
   785
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   786
  in radix (num, []) end;
wenzelm@233
   787
wenzelm@233
   788
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   789
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   790
fun radixstring (base, zerochar, num) =
wenzelm@233
   791
  let val offset = ord zerochar;
wenzelm@233
   792
      fun chrof n = chr (offset + n)
wenzelm@233
   793
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   794
wenzelm@233
   795
paulson@3407
   796
val string_of_int = Int.toString;
wenzelm@233
   797
paulson@3407
   798
fun string_of_indexname (a,0) = a
paulson@3407
   799
  | string_of_indexname (a,i) = a ^ "_" ^ Int.toString i;
wenzelm@233
   800
wenzelm@233
   801
wenzelm@14826
   802
(* read integers *)
wenzelm@14826
   803
wenzelm@14826
   804
fun read_radixint (radix: int, cs) : int * string list =
wenzelm@14826
   805
  let val zero = ord"0"
wenzelm@14826
   806
      val limit = zero+radix
wenzelm@14826
   807
      fun scan (num,[]) = (num,[])
wenzelm@14826
   808
        | scan (num, c::cs) =
wenzelm@14826
   809
              if  zero <= ord c  andalso  ord c < limit
wenzelm@14826
   810
              then scan(radix*num + ord c - zero, cs)
wenzelm@14826
   811
              else (num, c::cs)
wenzelm@14826
   812
  in  scan(0,cs)  end;
wenzelm@14826
   813
wenzelm@14826
   814
fun read_int cs = read_radixint (10, cs);
wenzelm@14826
   815
wenzelm@14826
   816
fun oct_char s = chr (#1 (read_radixint (8, explode s)));
wenzelm@14826
   817
wenzelm@14826
   818
wenzelm@14826
   819
wenzelm@233
   820
(** strings **)
wenzelm@233
   821
wenzelm@16188
   822
(* functions tuned for strings, avoiding explode *)
wenzelm@6312
   823
haftmann@18011
   824
fun nth_string str i =
wenzelm@6959
   825
  (case try String.substring (str, i, 1) of
skalberg@15531
   826
    SOME s => s
skalberg@15570
   827
  | NONE => raise Subscript);
wenzelm@6312
   828
wenzelm@16188
   829
fun fold_string f str x0 =
wenzelm@6282
   830
  let
wenzelm@6282
   831
    val n = size str;
wenzelm@16188
   832
    fun iter (x, i) =
wenzelm@16188
   833
      if i < n then iter (f (String.substring (str, i, 1)) x, i + 1) else x;
wenzelm@16188
   834
  in iter (x0, 0) end;
wenzelm@6282
   835
wenzelm@14968
   836
fun exists_string pred str =
wenzelm@14968
   837
  let
wenzelm@14968
   838
    val n = size str;
wenzelm@14968
   839
    fun ex i = i < n andalso (pred (String.substring (str, i, 1)) orelse ex (i + 1));
wenzelm@14968
   840
  in ex 0 end;
wenzelm@6312
   841
wenzelm@16188
   842
fun forall_string pred = not o exists_string (not o pred);
wenzelm@16188
   843
lcp@512
   844
(*enclose in brackets*)
lcp@512
   845
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@6642
   846
fun unenclose str = String.substring (str, 1, size str - 2);
wenzelm@255
   847
wenzelm@233
   848
(*simple quoting (does not escape special chars)*)
lcp@512
   849
val quote = enclose "\"" "\"";
wenzelm@233
   850
wenzelm@4212
   851
(*space_implode "..." (explode "hello") = "h...e...l...l...o"*)
wenzelm@233
   852
fun space_implode a bs = implode (separate a bs);
wenzelm@233
   853
wenzelm@255
   854
val commas = space_implode ", ";
wenzelm@380
   855
val commas_quote = commas o map quote;
wenzelm@255
   856
wenzelm@233
   857
(*concatenate messages, one per line, into a string*)
wenzelm@255
   858
val cat_lines = space_implode "\n";
wenzelm@233
   859
wenzelm@4212
   860
(*space_explode "." "h.e..l.lo" = ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   861
fun space_explode _ "" = []
wenzelm@3832
   862
  | space_explode sep str =
wenzelm@3832
   863
      let
wenzelm@3832
   864
        fun expl chs =
wenzelm@3832
   865
          (case take_prefix (not_equal sep) chs of
wenzelm@3832
   866
            (cs, []) => [implode cs]
wenzelm@3832
   867
          | (cs, _ :: cs') => implode cs :: expl cs');
wenzelm@3832
   868
      in expl (explode str) end;
wenzelm@3832
   869
wenzelm@3832
   870
val split_lines = space_explode "\n";
wenzelm@3832
   871
wenzelm@14826
   872
fun prefix_lines "" txt = txt
wenzelm@14826
   873
  | prefix_lines prfx txt = txt |> split_lines |> map (fn s => prfx ^ s) |> cat_lines;
wenzelm@14826
   874
wenzelm@7712
   875
fun untabify chs =
wenzelm@7712
   876
  let
wenzelm@7712
   877
    val tab_width = 8;
wenzelm@7712
   878
wenzelm@7712
   879
    fun untab (_, "\n") = (0, ["\n"])
wenzelm@9118
   880
      | untab (pos, "\t") =
wenzelm@9118
   881
          let val d = tab_width - (pos mod tab_width) in (pos + d, replicate d " ") end
wenzelm@7712
   882
      | untab (pos, c) = (pos + 1, [c]);
wenzelm@7712
   883
  in
wenzelm@7712
   884
    if not (exists (equal "\t") chs) then chs
wenzelm@7712
   885
    else flat (#2 (foldl_map untab (0, chs)))
wenzelm@7712
   886
  end;
wenzelm@7712
   887
wenzelm@18681
   888
fun prefix prfx s = prfx ^ s;
wenzelm@16188
   889
fun suffix sffx s = s ^ sffx;
wenzelm@5285
   890
wenzelm@18681
   891
fun unprefix prfx s =
wenzelm@18681
   892
  if String.isPrefix prfx s then String.substring (s, size prfx, size s - size prfx)
wenzelm@18681
   893
  else raise Fail "unprefix";
wenzelm@18681
   894
wenzelm@16188
   895
fun unsuffix sffx s =
wenzelm@17061
   896
  if String.isSuffix sffx s then String.substring (s, 0, size s - size sffx)
wenzelm@17061
   897
  else raise Fail "unsuffix";
wenzelm@5285
   898
wenzelm@10951
   899
fun replicate_string 0 _ = ""
wenzelm@10951
   900
  | replicate_string 1 a = a
wenzelm@10951
   901
  | replicate_string k a =
wenzelm@10951
   902
      if k mod 2 = 0 then replicate_string (k div 2) (a ^ a)
wenzelm@10951
   903
      else replicate_string (k div 2) (a ^ a) ^ a;
wenzelm@10951
   904
wenzelm@3832
   905
wenzelm@233
   906
wenzelm@16492
   907
(** lists as sets -- see also Pure/General/ord_list.ML **)
wenzelm@233
   908
wenzelm@18923
   909
(*canonical member, insert, remove*)
wenzelm@18923
   910
fun member eq list x =
wenzelm@18923
   911
  let
wenzelm@18923
   912
    fun memb [] = false
wenzelm@18923
   913
      | memb (y :: ys) = eq (x, y) orelse memb ys;
wenzelm@18923
   914
  in memb list end;
berghofe@1576
   915
wenzelm@18923
   916
fun insert eq x xs = if member eq xs x then xs else x :: xs;
wenzelm@18923
   917
fun remove eq x xs = if member eq xs x then filter_out (fn y => eq (x, y)) xs else xs;
wenzelm@233
   918
wenzelm@18923
   919
fun merge _ ([], ys) = ys
wenzelm@18923
   920
  | merge eq (xs, ys) = fold_rev (insert eq) ys xs;
clasohm@0
   921
wenzelm@18923
   922
(*old-style infixes*)
wenzelm@18923
   923
fun x mem xs = member (op =) xs x;
wenzelm@18923
   924
fun (x: int) mem_int xs = member (op =) xs x;
wenzelm@18923
   925
fun (x: string) mem_string xs = member (op =) xs x;
berghofe@1576
   926
wenzelm@18923
   927
fun x ins xs = insert (op =) x xs;
wenzelm@18923
   928
fun (x:int) ins_int xs = insert (op =) x xs;
wenzelm@18923
   929
fun (x:string) ins_string xs = insert (op =) x xs;
wenzelm@233
   930
wenzelm@233
   931
(*union of sets represented as lists: no repetitions*)
wenzelm@233
   932
fun xs union [] = xs
wenzelm@233
   933
  | [] union ys = ys
wenzelm@233
   934
  | (x :: xs) union ys = xs union (x ins ys);
clasohm@0
   935
paulson@2175
   936
(*union of sets, optimized version for ints*)
berghofe@1576
   937
fun (xs:int list) union_int [] = xs
berghofe@1576
   938
  | [] union_int ys = ys
berghofe@1576
   939
  | (x :: xs) union_int ys = xs union_int (x ins_int ys);
berghofe@1576
   940
paulson@2175
   941
(*union of sets, optimized version for strings*)
berghofe@1576
   942
fun (xs:string list) union_string [] = xs
berghofe@1576
   943
  | [] union_string ys = ys
berghofe@1576
   944
  | (x :: xs) union_string ys = xs union_string (x ins_string ys);
berghofe@1576
   945
clasohm@0
   946
(*generalized union*)
wenzelm@233
   947
fun gen_union eq (xs, []) = xs
wenzelm@233
   948
  | gen_union eq ([], ys) = ys
wenzelm@18923
   949
  | gen_union eq (x :: xs, ys) = gen_union eq (xs, insert eq x ys);
wenzelm@233
   950
wenzelm@233
   951
wenzelm@233
   952
(*intersection*)
wenzelm@233
   953
fun [] inter ys = []
wenzelm@233
   954
  | (x :: xs) inter ys =
wenzelm@233
   955
      if x mem ys then x :: (xs inter ys) else xs inter ys;
wenzelm@233
   956
paulson@2175
   957
(*intersection, optimized version for ints*)
berghofe@1576
   958
fun ([]:int list) inter_int ys = []
berghofe@1576
   959
  | (x :: xs) inter_int ys =
berghofe@1576
   960
      if x mem_int ys then x :: (xs inter_int ys) else xs inter_int ys;
berghofe@1576
   961
paulson@2175
   962
(*intersection, optimized version for strings *)
berghofe@1576
   963
fun ([]:string list) inter_string ys = []
berghofe@1576
   964
  | (x :: xs) inter_string ys =
berghofe@1576
   965
      if x mem_string ys then x :: (xs inter_string ys) else xs inter_string ys;
berghofe@1576
   966
paulson@7090
   967
(*generalized intersection*)
paulson@7090
   968
fun gen_inter eq ([], ys) = []
wenzelm@12284
   969
  | gen_inter eq (x::xs, ys) =
wenzelm@18923
   970
      if member eq ys x then x :: gen_inter eq (xs, ys)
wenzelm@18923
   971
      else gen_inter eq (xs, ys);
paulson@7090
   972
wenzelm@233
   973
wenzelm@233
   974
(*subset*)
wenzelm@233
   975
fun [] subset ys = true
wenzelm@233
   976
  | (x :: xs) subset ys = x mem ys andalso xs subset ys;
wenzelm@233
   977
paulson@2175
   978
(*subset, optimized version for ints*)
wenzelm@16439
   979
fun ([]: int list) subset_int ys = true
berghofe@1576
   980
  | (x :: xs) subset_int ys = x mem_int ys andalso xs subset_int ys;
berghofe@1576
   981
paulson@2175
   982
(*subset, optimized version for strings*)
wenzelm@16439
   983
fun ([]: string list) subset_string ys = true
berghofe@1576
   984
  | (x :: xs) subset_string ys = x mem_string ys andalso xs subset_string ys;
berghofe@1576
   985
wenzelm@4363
   986
(*set equality*)
wenzelm@4363
   987
fun eq_set (xs, ys) =
wenzelm@4363
   988
  xs = ys orelse (xs subset ys andalso ys subset xs);
wenzelm@4363
   989
paulson@2182
   990
(*set equality for strings*)
wenzelm@16439
   991
fun eq_set_string ((xs: string list), ys) =
berghofe@1576
   992
  xs = ys orelse (xs subset_string ys andalso ys subset_string xs);
berghofe@1576
   993
wenzelm@18923
   994
fun gen_subset eq (xs, ys) = forall (member eq ys) xs;
paulson@2182
   995
wenzelm@265
   996
wenzelm@233
   997
(*removing an element from a list WITHOUT duplicates*)
wenzelm@233
   998
fun (y :: ys) \ x = if x = y then ys else y :: (ys \ x)
wenzelm@233
   999
  | [] \ x = [];
wenzelm@233
  1000
paulson@2243
  1001
fun ys \\ xs = foldl (op \) (ys,xs);
clasohm@0
  1002
wenzelm@233
  1003
(*removing an element from a list -- possibly WITH duplicates*)
wenzelm@233
  1004
fun gen_rem eq (xs, y) = filter_out (fn x => eq (x, y)) xs;
wenzelm@18923
  1005
fun gen_rems eq (xs, ys) = filter_out (member eq ys) xs;
wenzelm@233
  1006
wenzelm@233
  1007
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
  1008
  first of equal elements*)
wenzelm@233
  1009
fun gen_distinct eq lst =
wenzelm@233
  1010
  let
wenzelm@233
  1011
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
  1012
      | dist (rev_seen, x :: xs) =
wenzelm@18923
  1013
          if member eq rev_seen x then dist (rev_seen, xs)
wenzelm@233
  1014
          else dist (x :: rev_seen, xs);
wenzelm@233
  1015
  in
wenzelm@233
  1016
    dist ([], lst)
wenzelm@233
  1017
  end;
wenzelm@233
  1018
paulson@2243
  1019
fun distinct l = gen_distinct (op =) l;
wenzelm@233
  1020
wenzelm@233
  1021
(*returns the tail beginning with the first repeated element, or []*)
wenzelm@233
  1022
fun findrep [] = []
wenzelm@233
  1023
  | findrep (x :: xs) = if x mem xs then x :: xs else findrep xs;
wenzelm@233
  1024
wenzelm@233
  1025
wenzelm@255
  1026
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
  1027
  order, takes first of equal elements*)
wenzelm@18966
  1028
fun duplicates eq lst =
wenzelm@255
  1029
  let
wenzelm@255
  1030
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
  1031
      | dups (rev_dups, x :: xs) =
wenzelm@18923
  1032
          if member eq rev_dups x orelse not (member eq xs x) then
wenzelm@255
  1033
            dups (rev_dups, xs)
wenzelm@255
  1034
          else dups (x :: rev_dups, xs);
wenzelm@18966
  1035
  in dups ([], lst) end;
wenzelm@255
  1036
wenzelm@16878
  1037
fun has_duplicates eq =
wenzelm@16878
  1038
  let
wenzelm@16878
  1039
    fun dups [] = false
wenzelm@16878
  1040
      | dups (x :: xs) = member eq xs x orelse dups xs;
wenzelm@16878
  1041
  in dups end;
wenzelm@16878
  1042
wenzelm@255
  1043
wenzelm@233
  1044
wenzelm@233
  1045
(** association lists **)
clasohm@0
  1046
wenzelm@18923
  1047
(* lists as tables -- legacy operations *)
wenzelm@233
  1048
wenzelm@12284
  1049
fun gen_merge_lists _ xs [] = xs
wenzelm@12284
  1050
  | gen_merge_lists _ [] ys = ys
wenzelm@12284
  1051
  | gen_merge_lists eq xs ys = xs @ gen_rems eq (ys, xs);
clasohm@0
  1052
wenzelm@12284
  1053
fun gen_merge_lists' _ xs [] = xs
wenzelm@12284
  1054
  | gen_merge_lists' _ [] ys = ys
wenzelm@12295
  1055
  | gen_merge_lists' eq xs ys = gen_rems eq (ys, xs) @ xs;
clasohm@0
  1056
wenzelm@12284
  1057
fun merge_lists xs ys = gen_merge_lists (op =) xs ys;
wenzelm@12284
  1058
fun merge_lists' xs ys = gen_merge_lists' (op =) xs ys;
haftmann@17498
  1059
fun merge_alists al = gen_merge_lists (eq_fst (op =)) al;
haftmann@17498
  1060
fun merge_alists' al = gen_merge_lists' (eq_fst (op =)) al;
wenzelm@380
  1061
clasohm@0
  1062
clasohm@0
  1063
wenzelm@233
  1064
(** balanced trees **)
wenzelm@233
  1065
wenzelm@233
  1066
exception Balance;      (*indicates non-positive argument to balancing fun*)
wenzelm@233
  1067
wenzelm@233
  1068
(*balanced folding; avoids deep nesting*)
wenzelm@233
  1069
fun fold_bal f [x] = x
wenzelm@233
  1070
  | fold_bal f [] = raise Balance
wenzelm@233
  1071
  | fold_bal f xs =
nipkow@13629
  1072
      let val (ps,qs) = splitAt(length xs div 2, xs)
nipkow@13629
  1073
      in  f (fold_bal f ps, fold_bal f qs)  end;
wenzelm@233
  1074
wenzelm@233
  1075
(*construct something of the form f(...g(...(x)...)) for balanced access*)
wenzelm@233
  1076
fun access_bal (f, g, x) n i =
wenzelm@233
  1077
  let fun acc n i =     (*1<=i<=n*)
wenzelm@233
  1078
          if n=1 then x else
wenzelm@233
  1079
          let val n2 = n div 2
wenzelm@233
  1080
          in  if i<=n2 then f (acc n2 i)
wenzelm@233
  1081
                       else g (acc (n-n2) (i-n2))
wenzelm@233
  1082
          end
wenzelm@233
  1083
  in  if 1<=i andalso i<=n then acc n i else raise Balance  end;
wenzelm@233
  1084
wenzelm@233
  1085
(*construct ALL such accesses; could try harder to share recursive calls!*)
wenzelm@233
  1086
fun accesses_bal (f, g, x) n =
wenzelm@233
  1087
  let fun acc n =
wenzelm@233
  1088
          if n=1 then [x] else
wenzelm@233
  1089
          let val n2 = n div 2
wenzelm@233
  1090
              val acc2 = acc n2
wenzelm@233
  1091
          in  if n-n2=n2 then map f acc2 @ map g acc2
wenzelm@233
  1092
                         else map f acc2 @ map g (acc (n-n2)) end
wenzelm@233
  1093
  in  if 1<=n then acc n else raise Balance  end;
wenzelm@233
  1094
wenzelm@233
  1095
wenzelm@233
  1096
wenzelm@2506
  1097
(** orders **)
wenzelm@2506
  1098
wenzelm@18966
  1099
fun is_equal EQUAL = true
wenzelm@18966
  1100
  | is_equal _ = false;
wenzelm@18966
  1101
wenzelm@4445
  1102
fun rev_order LESS = GREATER
wenzelm@4445
  1103
  | rev_order EQUAL = EQUAL
wenzelm@4445
  1104
  | rev_order GREATER = LESS;
wenzelm@4445
  1105
wenzelm@4479
  1106
(*assume rel is a linear strict order*)
wenzelm@4445
  1107
fun make_ord rel (x, y) =
wenzelm@4445
  1108
  if rel (x, y) then LESS
wenzelm@4445
  1109
  else if rel (y, x) then GREATER
wenzelm@4445
  1110
  else EQUAL;
wenzelm@4445
  1111
haftmann@18452
  1112
fun eq_ord ord xy =
haftmann@18452
  1113
  case ord xy
haftmann@18452
  1114
   of EQUAL => true
haftmann@18452
  1115
    | _ => false;
haftmann@18452
  1116
wenzelm@15051
  1117
val int_ord = Int.compare;
wenzelm@15051
  1118
val string_ord = String.compare;
wenzelm@2506
  1119
wenzelm@16676
  1120
fun fast_string_ord (s1, s2) =
wenzelm@16676
  1121
  (case int_ord (size s1, size s2) of EQUAL => string_ord (s1, s2) | ord => ord);
wenzelm@16676
  1122
wenzelm@16492
  1123
fun option_ord ord (SOME x, SOME y) = ord (x, y)
wenzelm@16492
  1124
  | option_ord _ (NONE, NONE) = EQUAL
wenzelm@16492
  1125
  | option_ord _ (NONE, SOME _) = LESS
wenzelm@16492
  1126
  | option_ord _ (SOME _, NONE) = GREATER;
wenzelm@16492
  1127
wenzelm@4343
  1128
(*lexicographic product*)
wenzelm@4343
  1129
fun prod_ord a_ord b_ord ((x, y), (x', y')) =
wenzelm@4343
  1130
  (case a_ord (x, x') of EQUAL => b_ord (y, y') | ord => ord);
wenzelm@4343
  1131
wenzelm@4343
  1132
(*dictionary order -- in general NOT well-founded!*)
wenzelm@16984
  1133
fun dict_ord elem_ord (x :: xs, y :: ys) =
wenzelm@16984
  1134
      (case elem_ord (x, y) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord)
wenzelm@16984
  1135
  | dict_ord _ ([], []) = EQUAL
wenzelm@4343
  1136
  | dict_ord _ ([], _ :: _) = LESS
wenzelm@16984
  1137
  | dict_ord _ (_ :: _, []) = GREATER;
wenzelm@4343
  1138
wenzelm@4343
  1139
(*lexicographic product of lists*)
wenzelm@4343
  1140
fun list_ord elem_ord (xs, ys) =
wenzelm@16676
  1141
  (case int_ord (length xs, length ys) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord);
wenzelm@4343
  1142
wenzelm@2506
  1143
wenzelm@4621
  1144
(* sorting *)
wenzelm@4621
  1145
wenzelm@18427
  1146
(*quicksort -- stable, i.e. does not reorder equal elements*)
wenzelm@18427
  1147
fun quicksort unique ord =
wenzelm@4621
  1148
  let
wenzelm@16878
  1149
    fun qsort [] = []
wenzelm@16878
  1150
      | qsort (xs as [_]) = xs
wenzelm@18427
  1151
      | qsort (xs as [x, y]) =
wenzelm@18427
  1152
          (case ord (x, y) of
wenzelm@18427
  1153
            LESS => xs
wenzelm@18427
  1154
          | EQUAL => if unique then [x] else xs
wenzelm@18427
  1155
          | GREATER => [y, x])
wenzelm@16878
  1156
      | qsort xs =
haftmann@18011
  1157
          let val (lts, eqs, gts) = part (nth xs (length xs div 2)) xs
wenzelm@16878
  1158
          in qsort lts @ eqs @ qsort gts end
wenzelm@4621
  1159
    and part _ [] = ([], [], [])
wenzelm@4621
  1160
      | part pivot (x :: xs) = add (ord (x, pivot)) x (part pivot xs)
wenzelm@4621
  1161
    and add LESS x (lts, eqs, gts) = (x :: lts, eqs, gts)
wenzelm@18427
  1162
      | add EQUAL x (lts, [], gts) = (lts, [x], gts)
wenzelm@18427
  1163
      | add EQUAL x (res as (lts, eqs, gts)) = if unique then res else (lts, x :: eqs, gts)
wenzelm@4621
  1164
      | add GREATER x (lts, eqs, gts) = (lts, eqs, x :: gts);
wenzelm@4621
  1165
  in qsort end;
wenzelm@4621
  1166
wenzelm@18427
  1167
fun sort ord = quicksort false ord;
wenzelm@18427
  1168
fun sort_distinct ord = quicksort true ord;
wenzelm@18427
  1169
wenzelm@4621
  1170
val sort_strings = sort string_ord;
wenzelm@4621
  1171
fun sort_wrt sel xs = sort (string_ord o pairself sel) xs;
wenzelm@4621
  1172
wenzelm@4621
  1173
wenzelm@2506
  1174
berghofe@14106
  1175
(** random numbers **)
berghofe@14106
  1176
berghofe@14106
  1177
exception RANDOM;
berghofe@14106
  1178
berghofe@14618
  1179
fun rmod x y = x - y * Real.realFloor (x / y);
berghofe@14106
  1180
berghofe@14106
  1181
local
berghofe@14106
  1182
  val a = 16807.0;
berghofe@14106
  1183
  val m = 2147483647.0;
berghofe@14106
  1184
  val random_seed = ref 1.0;
berghofe@14106
  1185
in
berghofe@14106
  1186
berghofe@14106
  1187
fun random () =
berghofe@14106
  1188
  let val r = rmod (a * !random_seed) m
berghofe@14106
  1189
  in (random_seed := r; r) end;
berghofe@14106
  1190
berghofe@14106
  1191
end;
berghofe@14106
  1192
berghofe@14106
  1193
fun random_range l h =
berghofe@14106
  1194
  if h < l orelse l < 0 then raise RANDOM
berghofe@14106
  1195
  else l + Real.floor (rmod (random ()) (real (h - l + 1)));
berghofe@14106
  1196
haftmann@18011
  1197
fun one_of xs = nth xs (random_range 0 (length xs - 1));
berghofe@14106
  1198
berghofe@14106
  1199
fun frequency xs =
berghofe@14106
  1200
  let
berghofe@14106
  1201
    val sum = foldl op + (0, map fst xs);
wenzelm@17756
  1202
    fun pick n ((k: int, x) :: xs) =
berghofe@14106
  1203
      if n <= k then x else pick (n - k) xs
berghofe@14106
  1204
  in pick (random_range 1 sum) xs end;
berghofe@14106
  1205
berghofe@14106
  1206
wenzelm@14826
  1207
(** current directory **)
wenzelm@233
  1208
paulson@2243
  1209
val cd = OS.FileSys.chDir;
wenzelm@2317
  1210
val pwd = OS.FileSys.getDir;
paulson@2243
  1211
berghofe@3606
  1212
wenzelm@4621
  1213
(** misc **)
wenzelm@233
  1214
clasohm@0
  1215
(*Partition list into elements that satisfy predicate and those that don't.
wenzelm@233
  1216
  Preserves order of elements in both lists.*)
skalberg@15570
  1217
val partition = List.partition;
clasohm@0
  1218
clasohm@0
  1219
fun partition_eq (eq:'a * 'a -> bool) =
wenzelm@16842
  1220
  let
wenzelm@16842
  1221
    fun part [] = []
wenzelm@16842
  1222
      | part (x :: ys) =
wenzelm@16842
  1223
          let val (xs, xs') = partition (fn y => eq (x, y)) ys
wenzelm@16842
  1224
          in (x::xs)::(part xs') end
wenzelm@16842
  1225
  in part end;
clasohm@0
  1226
clasohm@0
  1227
wenzelm@233
  1228
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
  1229
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
  1230
fun partition_list p i j =
wenzelm@233
  1231
  let fun part k xs =
wenzelm@233
  1232
            if k>j then
clasohm@0
  1233
              (case xs of [] => []
skalberg@15570
  1234
                         | _ => raise Fail "partition_list")
clasohm@0
  1235
            else
wenzelm@233
  1236
            let val (ns, rest) = partition (p k) xs;
wenzelm@233
  1237
            in  ns :: part(k+1)rest  end
clasohm@0
  1238
  in  part i end;
clasohm@0
  1239
clasohm@0
  1240
wenzelm@233
  1241
(* generating identifiers *)
clasohm@0
  1242
paulson@4063
  1243
(** Freshly generated identifiers; supplied prefix MUST start with a letter **)
clasohm@0
  1244
local
paulson@4063
  1245
(*Maps 0-63 to A-Z, a-z, 0-9 or _ or ' for generating random identifiers*)
paulson@4063
  1246
fun char i =      if i<26 then chr (ord "A" + i)
wenzelm@5904
  1247
             else if i<52 then chr (ord "a" + i - 26)
wenzelm@5904
  1248
             else if i<62 then chr (ord"0" + i - 52)
wenzelm@5904
  1249
             else if i=62 then "_"
wenzelm@5904
  1250
             else  (*i=63*)    "'";
paulson@4063
  1251
paulson@4063
  1252
val charVec = Vector.tabulate (64, char);
paulson@4063
  1253
wenzelm@5904
  1254
fun newid n =
wenzelm@5904
  1255
  let
wenzelm@4284
  1256
  in  implode (map (fn i => Vector.sub(charVec,i)) (radixpand (64,n)))  end;
paulson@2003
  1257
wenzelm@4284
  1258
val seedr = ref 0;
clasohm@0
  1259
paulson@4063
  1260
in
wenzelm@4284
  1261
wenzelm@12346
  1262
fun gensym pre = pre ^ (#1(newid (!seedr), inc seedr));
paulson@2003
  1263
paulson@4063
  1264
end;
paulson@4063
  1265
paulson@4063
  1266
wenzelm@233
  1267
(* lexical scanning *)
clasohm@0
  1268
wenzelm@233
  1269
(*scan a list of characters into "words" composed of "letters" (recognized by
wenzelm@233
  1270
  is_let) and separated by any number of non-"letters"*)
wenzelm@233
  1271
fun scanwords is_let cs =
clasohm@0
  1272
  let fun scan1 [] = []
wenzelm@233
  1273
        | scan1 cs =
wenzelm@233
  1274
            let val (lets, rest) = take_prefix is_let cs
wenzelm@233
  1275
            in implode lets :: scanwords is_let rest end;
wenzelm@233
  1276
  in scan1 (#2 (take_prefix (not o is_let) cs)) end;
clasohm@24
  1277
wenzelm@4212
  1278
wenzelm@16439
  1279
(* stamps and serial numbers *)
wenzelm@16439
  1280
wenzelm@16439
  1281
type stamp = unit ref;
wenzelm@16439
  1282
val stamp: unit -> stamp = ref;
wenzelm@16439
  1283
wenzelm@16439
  1284
type serial = int;
wenzelm@16439
  1285
local val count = ref 0
wenzelm@16439
  1286
in fun serial () = inc count end;
wenzelm@16439
  1287
wenzelm@16535
  1288
wenzelm@16535
  1289
(* generic objects *)
wenzelm@16535
  1290
wenzelm@16535
  1291
(*note that the builtin exception datatype may be extended by new
wenzelm@16535
  1292
  constructors at any time*)
wenzelm@16535
  1293
structure Object = struct type T = exn end;
wenzelm@16535
  1294
clasohm@1364
  1295
end;
clasohm@1364
  1296
wenzelm@15745
  1297
structure BasicLibrary: BASIC_LIBRARY = Library;
wenzelm@15745
  1298
open BasicLibrary;