File: automaton.mli

package info (click to toggle)
hlins 0.40-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 484 kB
  • sloc: ml: 1,215; makefile: 148; sh: 4
file content (150 lines) | stat: -rw-r--r-- 6,218 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
(***************************************************************************)
(*  HLins: insert http-links into HTML documents.                          *)
(*  See http://www.lri.fr/~treinen/hlins                                   *)
(*                                                                         *)
(*  Copyright (C) 1999-2024 Ralf Treinen <treinen@irif.fr>                 *)
(*                                                                         *)
(*  This program is free software; you can redistribute it and/or modify   *)
(*  it under the terms of the GNU General Public License as published by   *)
(*  the Free Software Foundation; either version 2 of the License, or (at  *)
(*  your option) any later version.                                        *)
(*                                                                         *)
(*  This program is distributed in the hope that it will be useful, but    *)
(*  WITHOUT ANY WARRANTY; without even the implied warranty of             *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU      *)
(*  General Public License for more details.                               *)
(*                                                                         *)
(*  You should have received a copy of the GNU General Public License      *)
(*  along with this program; if not, write to the Free Software            *)
(*  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307    *)
(*  USA                                                                    *)
(*                                                                         *)
(***************************************************************************)

(*
    HLins: insert http-links into HTML documents.
    See http://www.lri.fr/~treinen/hlins

    Copyright (C) 1999 Ralf Treinen <treinen@lri.fr>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*)


(***************************************************************************)
(*  Module defining the type "automaton" for multi-string search           *)
(***************************************************************************)


(*
   Data type "automaton" used for multi-string matching  la Morris - Pratt.

   See Chapter 7.1 in Crochemore & Rytter, Text Algorithms, Oxford
   University Press, 1994.
*)

(* Type of the transition tables of a single state. An element of type
   transitions is a partial mapping from characters to integers.
*)
type transitions;;

(* create an empty transition table *)
val empty_transitions : transitions;;

(* (get_transition t c) returns the result of the transition t under
   character c. Raises Not_found if the transition is not defined.
*)
val get_transition : transitions -> char -> int;;

(* (add_transition t c p) yields the transition t plus c -> p *)
val add_transition : transitions ->  char -> int -> transitions;;

(* fold function on transitions: let the transition function t be
   [c1 -> q1; ... ; cn -> qn] (where this could have been in any order). 
   Then (transitions_fold f i t) yields
   f ( ... (f (f i c1 q1) c2 q2) ... ) cn qn
*)
val transitions_fold :
  ('a -> char -> int -> 'a) -> 'a -> transitions -> 'a;;

type automaton = {
  max_path_length:   int;
  number_of_states:  int;
  tree:              transitions array;
  level:             int array;               
  board:             int array;
  suf:               int array;
  found:             (int list) array;
  expand:            (int list) array
};;                     

(*

   First some terminology:
   - a word x is a prefix of a word y if exists z with y = x^z
   -               suffix             if exists z with y = z^x
   -               factor             if exists z1,z2 with y = z1^x^z2
   A prefix (resp. suffix) is proper if z is not empty.

   When building the automaton we are given an array W of length L of
   non-empty words. Furthermore, there is some notion of an
   abbreviation of a word. Let V be the set consisting of the elements
   of W plus all their abbreviations.  Let N be the cardinality of the
   prefix-closure of V. We call "nodes" the numbers n with
   0<=n<N. max_path_length is  the maximal length of a word in W.

   The size of the arrays f is at least N = number_of_states.

   The array tree defines a graph where a directed edge labeled with
   character c goes from node n to node m iff (c,m) in n. We require
   that 
   - the graph is a tree.
   - for any node n and character c there is at most one node m with
     (c,m) in tree.(n).
   Hence, the graph is in fact a feature tree.
   For any node n, let path(n) be the word of characters on the edges
   from the root to the node n. We require that
   - path(0) = the empty word
   - the set of all pathes in the tree = V

   We require that for any node n that
   - level.(n) is the length of path(n).
   - board.(0) = -1
   - if n >= 1: board(n) is the node m such that path(m) is the
     longest proper suffix of path(n) that is a prefix of a word in V.
   - suf.(n) is the node m such that path(m) is the longest (not
     necessarily proper) suffix of path(n) that is a word in V.
     suf.(n) = 0 if such a m does not exist.
   
   Furthermore, we require for all nodes n that
   - found.(n) = list of indices in W of path(n)
   - expand.(n) = list of all indices of words w in W such that
     path(n) is an abbreviation of w.

  Hence, we have the following equivalence:
           suf(n) = n
       iff path(n) is a word in V
       iff found.(n) @ expand.(n) <> nil.

*)