src/Pure/General/heap.ML
author wenzelm
Mon, 25 Mar 2019 16:45:08 +0100
changeset 69980 f2e3adfd916f
parent 32939 1b5a401c78cb
child 70586 57df8a85317a
permissions -rw-r--r--
tuned signature;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
     1
(*  Title:      Pure/General/heap.ML
29606
fedb8be05f24 removed Ids;
wenzelm
parents: 28581
diff changeset
     2
    Author:     Lawrence C Paulson and Markus Wenzel
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
     3
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
     4
Heaps over linearly ordered types.  See also Chris Okasaki: "Purely
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
     5
Functional Data Structures" (Chapter 3), Cambridge University Press,
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
     6
1998.
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
     7
*)
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
     8
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
     9
signature HEAP =
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    10
sig
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    11
  type elem
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    12
  type T
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    13
  val empty: T
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    14
  val is_empty: T -> bool
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    15
  val merge: T * T -> T
23179
8db2b22257bd insert: canonical argument order;
wenzelm
parents: 18134
diff changeset
    16
  val insert: elem -> T -> T
28581
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    17
  val min: T -> elem            (*exception Empty*)
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    18
  val delete_min: T -> T        (*exception Empty*)
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    19
  val min_elem: T -> elem * T   (*exception Empty*)
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    20
  val upto: elem -> T -> elem list * T
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    21
end;
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    22
32939
1b5a401c78cb renamed functor HeapFun to Heap;
wenzelm
parents: 32784
diff changeset
    23
functor Heap(type elem val ord: elem * elem -> order): HEAP =
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    24
struct
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    25
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    26
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    27
(* datatype heap *)
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    28
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    29
type elem = elem;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    30
datatype T = Empty | Heap of int * elem * T * T;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    31
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    32
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    33
(* empty heaps *)
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    34
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    35
val empty = Empty;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    36
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    37
fun is_empty Empty = true
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    38
  | is_empty (Heap _) = false;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    39
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    40
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    41
(* build heaps *)
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    42
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    43
local
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    44
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    45
fun rank Empty = 0
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    46
  | rank (Heap (r, _, _, _)) = r;
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    47
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    48
fun heap x a b =
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    49
  if rank a >= rank b then Heap (rank b + 1, x, a, b)
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    50
  else Heap (rank a + 1, x, b, a);
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    51
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    52
in
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    53
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    54
fun merge (h, Empty) = h
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    55
  | merge (Empty, h) = h
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    56
  | merge (h1 as Heap (_, x1, a1, b1), h2 as Heap (_, x2, a2, b2)) =
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    57
      (case ord (x1, x2) of
14472
cba7c0a3ffb3 Removing the datatype declaration of "order" allows the standard General.order
paulson
parents: 9413
diff changeset
    58
        GREATER => heap x2 a2 (merge (h1, b2))
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    59
      | _ => heap x1 a1 (merge (b1, h2)));
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    60
23179
8db2b22257bd insert: canonical argument order;
wenzelm
parents: 18134
diff changeset
    61
fun insert x h = merge (Heap (1, x, Empty, Empty), h);
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    62
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    63
end;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    64
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    65
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    66
(* minimum element *)
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    67
18134
6450591da9f0 use existing exeption Empty;
wenzelm
parents: 14981
diff changeset
    68
fun min Empty = raise List.Empty
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    69
  | min (Heap (_, x, _, _)) = x;
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    70
18134
6450591da9f0 use existing exeption Empty;
wenzelm
parents: 14981
diff changeset
    71
fun delete_min Empty = raise List.Empty
9413
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    72
  | delete_min (Heap (_, _, a, b)) = merge (a, b);
ba209591a8d4 assimilated;
wenzelm
parents: 9095
diff changeset
    73
28581
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    74
fun min_elem h = (min h, delete_min h);
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    75
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    76
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    77
(* initial interval *)
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    78
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    79
nonfix upto;
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    80
32784
1a5dde5079ac eliminated redundant bindings;
wenzelm
parents: 29606
diff changeset
    81
fun upto _ Empty = ([], Empty)
1a5dde5079ac eliminated redundant bindings;
wenzelm
parents: 29606
diff changeset
    82
  | upto limit (h as Heap (_, x, _, _)) =
28581
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    83
      (case ord (x, limit) of
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    84
        GREATER => ([], h)
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    85
      | _ => upto limit (delete_min h) |>> cons x);
6cd2e5d5c6d0 added min_elem, upto;
wenzelm
parents: 23179
diff changeset
    86
9095
3b26cc949016 new module for heaps
paulson
parents:
diff changeset
    87
end;