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