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