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