src/Pure/net.ML
author bulwahn
Tue Aug 31 08:00:53 2010 +0200 (2010-08-31)
changeset 38950 62578950e748
parent 37523 40c352510065
child 45404 69ec395ef6ca
permissions -rw-r--r--
storing options for prolog code generation in the theory
wenzelm@12319
     1
(*  Title:      Pure/net.ML
wenzelm@12319
     2
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
clasohm@0
     3
    Copyright   1993  University of Cambridge
clasohm@0
     4
clasohm@0
     5
Discrimination nets: a data structure for indexing items
clasohm@0
     6
wenzelm@12319
     7
From the book
wenzelm@12319
     8
    E. Charniak, C. K. Riesbeck, D. V. McDermott.
clasohm@0
     9
    Artificial Intelligence Programming.
clasohm@0
    10
    (Lawrence Erlbaum Associates, 1980).  [Chapter 14]
nipkow@225
    11
wenzelm@12319
    12
match_term no longer treats abstractions as wildcards; instead they match
nipkow@228
    13
only wildcards in patterns.  Requires operands to be beta-eta-normal.
clasohm@0
    14
*)
clasohm@0
    15
wenzelm@12319
    16
signature NET =
wenzelm@16808
    17
sig
clasohm@0
    18
  type key
wenzelm@16808
    19
  val key_of_term: term -> key list
wenzelm@37523
    20
  val encode_type: typ -> term
clasohm@0
    21
  type 'a net
clasohm@0
    22
  val empty: 'a net
wenzelm@16808
    23
  exception INSERT
wenzelm@16808
    24
  val insert: ('a * 'a -> bool) -> key list * 'a -> 'a net -> 'a net
wenzelm@16808
    25
  val insert_term: ('a * 'a -> bool) -> term * 'a -> 'a net -> 'a net
wenzelm@33371
    26
  val insert_safe: ('a * 'a -> bool) -> key list * 'a -> 'a net -> 'a net
wenzelm@33371
    27
  val insert_term_safe: ('a * 'a -> bool) -> term * 'a -> 'a net -> 'a net
wenzelm@16808
    28
  exception DELETE
wenzelm@16808
    29
  val delete: ('b * 'a -> bool) -> key list * 'b -> 'a net -> 'a net
wenzelm@16808
    30
  val delete_term: ('b * 'a -> bool) -> term * 'b -> 'a net -> 'a net
wenzelm@33371
    31
  val delete_safe: ('b * 'a -> bool) -> key list * 'b -> 'a net -> 'a net
wenzelm@33371
    32
  val delete_term_safe: ('b * 'a -> bool) -> term * 'b -> 'a net -> 'a net
wenzelm@16808
    33
  val lookup: 'a net -> key list -> 'a list
clasohm@0
    34
  val match_term: 'a net -> term -> 'a list
clasohm@0
    35
  val unify_term: 'a net -> term -> 'a list
wenzelm@16808
    36
  val entries: 'a net -> 'a list
wenzelm@16808
    37
  val subtract: ('b * 'a -> bool) -> 'a net -> 'b net -> 'b list
wenzelm@16808
    38
  val merge: ('a * 'a -> bool) -> 'a net * 'a net -> 'a net
wenzelm@20011
    39
  val content: 'a net -> 'a list
wenzelm@16808
    40
end;
clasohm@0
    41
wenzelm@16808
    42
structure Net: NET =
clasohm@0
    43
struct
clasohm@0
    44
clasohm@0
    45
datatype key = CombK | VarK | AtomK of string;
clasohm@0
    46
nipkow@228
    47
(*Keys are preorder lists of symbols -- Combinations, Vars, Atoms.
nipkow@225
    48
  Any term whose head is a Var is regarded entirely as a Var.
nipkow@228
    49
  Abstractions are also regarded as Vars;  this covers eta-conversion
nipkow@228
    50
    and "near" eta-conversions such as %x.?P(?f(x)).
clasohm@0
    51
*)
wenzelm@12319
    52
fun add_key_of_terms (t, cs) =
clasohm@0
    53
  let fun rands (f$t, cs) = CombK :: rands (f, add_key_of_terms(t, cs))
wenzelm@12319
    54
        | rands (Const(c,_), cs) = AtomK c :: cs
wenzelm@12319
    55
        | rands (Free(c,_),  cs) = AtomK c :: cs
wenzelm@20080
    56
        | rands (Bound i,  cs)   = AtomK (Name.bound i) :: cs
clasohm@0
    57
  in case (head_of t) of
nipkow@225
    58
      Var _ => VarK :: cs
nipkow@228
    59
    | Abs _ => VarK :: cs
nipkow@225
    60
    | _     => rands(t,cs)
clasohm@0
    61
  end;
clasohm@0
    62
nipkow@225
    63
(*convert a term to a list of keys*)
clasohm@0
    64
fun key_of_term t = add_key_of_terms (t, []);
clasohm@0
    65
wenzelm@37523
    66
(*encode_type -- for indexing purposes*)
wenzelm@37523
    67
fun encode_type (Type (c, Ts)) = Term.list_comb (Const (c, dummyT), map encode_type Ts)
wenzelm@37523
    68
  | encode_type (TFree (a, _)) = Free (a, dummyT)
wenzelm@37523
    69
  | encode_type (TVar (a, _)) = Var (a, dummyT);
wenzelm@37523
    70
clasohm@0
    71
clasohm@0
    72
(*Trees indexed by key lists: each arc is labelled by a key.
clasohm@0
    73
  Each node contains a list of items, and arcs to children.
clasohm@0
    74
  The empty key addresses the entire net.
clasohm@0
    75
  Lookup functions preserve order in items stored at same level.
clasohm@0
    76
*)
clasohm@0
    77
datatype 'a net = Leaf of 'a list
wenzelm@12319
    78
                | Net of {comb: 'a net,
wenzelm@12319
    79
                          var: 'a net,
wenzelm@16708
    80
                          atoms: 'a net Symtab.table};
clasohm@0
    81
clasohm@0
    82
val empty = Leaf[];
wenzelm@16708
    83
fun is_empty (Leaf []) = true | is_empty _ = false;
wenzelm@16708
    84
val emptynet = Net{comb=empty, var=empty, atoms=Symtab.empty};
clasohm@0
    85
clasohm@0
    86
clasohm@0
    87
(*** Insertion into a discrimination net ***)
clasohm@0
    88
wenzelm@12319
    89
exception INSERT;       (*duplicate item in the net*)
clasohm@0
    90
clasohm@0
    91
clasohm@0
    92
(*Adds item x to the list at the node addressed by the keys.
clasohm@0
    93
  Creates node if not already present.
wenzelm@12319
    94
  eq is the equality test for items.
clasohm@0
    95
  The empty list of keys generates a Leaf node, others a Net node.
clasohm@0
    96
*)
wenzelm@16808
    97
fun insert eq (keys,x) net =
wenzelm@12319
    98
  let fun ins1 ([], Leaf xs) =
wenzelm@16686
    99
            if member eq xs x then  raise INSERT  else Leaf(x::xs)
clasohm@0
   100
        | ins1 (keys, Leaf[]) = ins1 (keys, emptynet)   (*expand empty...*)
wenzelm@16708
   101
        | ins1 (CombK :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   102
            Net{comb=ins1(keys,comb), var=var, atoms=atoms}
wenzelm@16708
   103
        | ins1 (VarK :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   104
            Net{comb=comb, var=ins1(keys,var), atoms=atoms}
wenzelm@16708
   105
        | ins1 (AtomK a :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   106
            let
wenzelm@18939
   107
              val net' = the_default empty (Symtab.lookup atoms a);
wenzelm@17412
   108
              val atoms' = Symtab.update (a, ins1 (keys, net')) atoms;
wenzelm@16708
   109
            in  Net{comb=comb, var=var, atoms=atoms'}  end
clasohm@0
   110
  in  ins1 (keys,net)  end;
clasohm@0
   111
wenzelm@33371
   112
fun insert_term eq (t, x) = insert eq (key_of_term t, x);
wenzelm@33371
   113
wenzelm@16808
   114
fun insert_safe eq entry net = insert eq entry net handle INSERT => net;
wenzelm@33371
   115
fun insert_term_safe eq entry net = insert_term eq entry net handle INSERT => net;
wenzelm@16808
   116
clasohm@0
   117
clasohm@0
   118
(*** Deletion from a discrimination net ***)
clasohm@0
   119
wenzelm@12319
   120
exception DELETE;       (*missing item in the net*)
clasohm@0
   121
clasohm@0
   122
(*Create a new Net node if it would be nonempty*)
wenzelm@16708
   123
fun newnet (args as {comb,var,atoms}) =
wenzelm@16708
   124
  if is_empty comb andalso is_empty var andalso Symtab.is_empty atoms
wenzelm@16708
   125
  then empty else Net args;
clasohm@0
   126
clasohm@0
   127
(*Deletes item x from the list at the node addressed by the keys.
clasohm@0
   128
  Raises DELETE if absent.  Collapses the net if possible.
clasohm@0
   129
  eq is the equality test for items. *)
wenzelm@16808
   130
fun delete eq (keys, x) net =
clasohm@0
   131
  let fun del1 ([], Leaf xs) =
wenzelm@16686
   132
            if member eq xs x then Leaf (remove eq x xs)
clasohm@0
   133
            else raise DELETE
wenzelm@12319
   134
        | del1 (keys, Leaf[]) = raise DELETE
wenzelm@16708
   135
        | del1 (CombK :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   136
            newnet{comb=del1(keys,comb), var=var, atoms=atoms}
wenzelm@16708
   137
        | del1 (VarK :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   138
            newnet{comb=comb, var=del1(keys,var), atoms=atoms}
wenzelm@16708
   139
        | del1 (AtomK a :: keys, Net{comb,var,atoms}) =
wenzelm@16708
   140
            let val atoms' =
wenzelm@17412
   141
              (case Symtab.lookup atoms a of
wenzelm@16708
   142
                NONE => raise DELETE
wenzelm@16708
   143
              | SOME net' =>
wenzelm@16708
   144
                  (case del1 (keys, net') of
wenzelm@16708
   145
                    Leaf [] => Symtab.delete a atoms
wenzelm@17412
   146
                  | net'' => Symtab.update (a, net'') atoms))
wenzelm@16708
   147
            in  newnet{comb=comb, var=var, atoms=atoms'}  end
clasohm@0
   148
  in  del1 (keys,net)  end;
clasohm@0
   149
wenzelm@16808
   150
fun delete_term eq (t, x) = delete eq (key_of_term t, x);
clasohm@0
   151
wenzelm@33371
   152
fun delete_safe eq entry net = delete eq entry net handle DELETE => net;
wenzelm@33371
   153
fun delete_term_safe eq entry net = delete_term eq entry net handle DELETE => net;
wenzelm@33371
   154
wenzelm@16677
   155
clasohm@0
   156
(*** Retrieval functions for discrimination nets ***)
clasohm@0
   157
wenzelm@16708
   158
exception ABSENT;
clasohm@0
   159
wenzelm@16708
   160
fun the_atom atoms a =
wenzelm@17412
   161
  (case Symtab.lookup atoms a of
wenzelm@16708
   162
    NONE => raise ABSENT
wenzelm@16708
   163
  | SOME net => net);
clasohm@0
   164
clasohm@0
   165
(*Return the list of items at the given node, [] if no such node*)
wenzelm@16808
   166
fun lookup (Leaf xs) [] = xs
wenzelm@16808
   167
  | lookup (Leaf _) (_ :: _) = []  (*non-empty keys and empty net*)
wenzelm@16808
   168
  | lookup (Net {comb, var, atoms}) (CombK :: keys) = lookup comb keys
wenzelm@16808
   169
  | lookup (Net {comb, var, atoms}) (VarK :: keys) = lookup var keys
wenzelm@16808
   170
  | lookup (Net {comb, var, atoms}) (AtomK a :: keys) =
wenzelm@16808
   171
      lookup (the_atom atoms a) keys handle ABSENT => [];
clasohm@0
   172
clasohm@0
   173
clasohm@0
   174
(*Skipping a term in a net.  Recursively skip 2 levels if a combination*)
wenzelm@23178
   175
fun net_skip (Leaf _) nets = nets
wenzelm@23178
   176
  | net_skip (Net{comb,var,atoms}) nets =
wenzelm@23178
   177
      fold_rev net_skip (net_skip comb []) (Symtab.fold (cons o #2) atoms (var::nets));
clasohm@0
   178
wenzelm@16808
   179
wenzelm@16808
   180
(** Matching and Unification **)
clasohm@0
   181
clasohm@0
   182
(*conses the linked net, if present, to nets*)
wenzelm@16708
   183
fun look1 (atoms, a) nets =
wenzelm@16708
   184
  the_atom atoms a :: nets handle ABSENT => nets;
clasohm@0
   185
wenzelm@12319
   186
(*Return the nodes accessible from the term (cons them before nets)
clasohm@0
   187
  "unif" signifies retrieval for unification rather than matching.
clasohm@0
   188
  Var in net matches any term.
wenzelm@12319
   189
  Abs or Var in object: if "unif", regarded as wildcard,
nipkow@225
   190
                                   else matches only a variable in net.
nipkow@225
   191
*)
wenzelm@23178
   192
fun matching unif t net nets =
clasohm@0
   193
  let fun rands _ (Leaf _, nets) = nets
wenzelm@16708
   194
        | rands t (Net{comb,atoms,...}, nets) =
wenzelm@12319
   195
            case t of
wenzelm@23178
   196
                f$t => fold_rev (matching unif t) (rands f (comb,[])) nets
wenzelm@16708
   197
              | Const(c,_) => look1 (atoms, c) nets
wenzelm@16708
   198
              | Free(c,_)  => look1 (atoms, c) nets
wenzelm@20080
   199
              | Bound i    => look1 (atoms, Name.bound i) nets
wenzelm@12319
   200
              | _          => nets
wenzelm@12319
   201
  in
clasohm@0
   202
     case net of
wenzelm@12319
   203
         Leaf _ => nets
clasohm@0
   204
       | Net{var,...} =>
wenzelm@12319
   205
             case head_of t of
wenzelm@23178
   206
                 Var _ => if unif then net_skip net nets
wenzelm@12319
   207
                          else var::nets           (*only matches Var in net*)
paulson@2836
   208
  (*If "unif" then a var instantiation in the abstraction could allow
paulson@2836
   209
    an eta-reduction, so regard the abstraction as a wildcard.*)
wenzelm@23178
   210
               | Abs _ => if unif then net_skip net nets
wenzelm@12319
   211
                          else var::nets           (*only a Var can match*)
wenzelm@12319
   212
               | _ => rands t (net, var::nets)  (*var could match also*)
clasohm@0
   213
  end;
clasohm@0
   214
wenzelm@19482
   215
fun extract_leaves l = maps (fn Leaf xs => xs) l;
clasohm@0
   216
nipkow@225
   217
(*return items whose key could match t, WHICH MUST BE BETA-ETA NORMAL*)
wenzelm@12319
   218
fun match_term net t =
wenzelm@23178
   219
    extract_leaves (matching false t net []);
clasohm@0
   220
clasohm@0
   221
(*return items whose key could unify with t*)
wenzelm@12319
   222
fun unify_term net t =
wenzelm@23178
   223
    extract_leaves (matching true t net []);
clasohm@0
   224
wenzelm@3548
   225
wenzelm@16808
   226
(** operations on nets **)
wenzelm@16808
   227
wenzelm@16808
   228
(*subtraction: collect entries of second net that are NOT present in first net*)
wenzelm@16808
   229
fun subtract eq net1 net2 =
wenzelm@16808
   230
  let
wenzelm@16808
   231
    fun subtr (Net _) (Leaf ys) = append ys
wenzelm@16808
   232
      | subtr (Leaf xs) (Leaf ys) =
wenzelm@16808
   233
          fold_rev (fn y => if member eq xs y then I else cons y) ys
wenzelm@16808
   234
      | subtr (Leaf _) (net as Net _) = subtr emptynet net
wenzelm@16808
   235
      | subtr (Net {comb = comb1, var = var1, atoms = atoms1})
wenzelm@16808
   236
            (Net {comb = comb2, var = var2, atoms = atoms2}) =
wenzelm@16842
   237
          subtr comb1 comb2
wenzelm@16842
   238
          #> subtr var1 var2
wenzelm@16842
   239
          #> Symtab.fold (fn (a, net) =>
wenzelm@18939
   240
            subtr (the_default emptynet (Symtab.lookup atoms1 a)) net) atoms2
wenzelm@16808
   241
  in subtr net1 net2 [] end;
wenzelm@16808
   242
wenzelm@16808
   243
fun entries net = subtract (K false) empty net;
wenzelm@16808
   244
wenzelm@16808
   245
wenzelm@16808
   246
(* merge *)
wenzelm@3548
   247
wenzelm@3548
   248
fun cons_fst x (xs, y) = (x :: xs, y);
wenzelm@3548
   249
wenzelm@3548
   250
fun dest (Leaf xs) = map (pair []) xs
wenzelm@16708
   251
  | dest (Net {comb, var, atoms}) =
wenzelm@3560
   252
      map (cons_fst CombK) (dest comb) @
wenzelm@3560
   253
      map (cons_fst VarK) (dest var) @
wenzelm@19482
   254
      maps (fn (a, net) => map (cons_fst (AtomK a)) (dest net)) (Symtab.dest atoms);
wenzelm@3548
   255
wenzelm@16808
   256
fun merge eq (net1, net2) = fold (insert_safe eq) (dest net2) net1;
wenzelm@3548
   257
wenzelm@20011
   258
fun content net = map #2 (dest net);
wenzelm@20011
   259
clasohm@0
   260
end;