helm/software/components/cic/cicUniv.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26
  27 (*
  28   The strings contains an unreadable message
  29 *)
  30 exception UniverseInconsistency of string Lazy.t
  31
  32 (*
  33   Cic.Type of universe
  34 *)
  35 type universe
  36
  37 (*
  38   Opaque data structure you will use to store constraints
  39 *)
  40 type universe_graph
  41
  42 (*
  43   returns a fresh universe
  44 *)
  45 val fresh:
  46   ?uri:UriManager.uri ->
  47   ?id:int ->
  48   unit ->
  49     universe
  50
  51     (* names a universe if unnamed *)
  52 val name_universe: universe -> UriManager.uri -> universe
  53
  54 (*
  55   really useful at the begin and in all the functions that don't care
  56   of universes
  57 *)
  58 val empty_ugraph: universe_graph
  59
  60 (* an universe that does nothing: i.e. no constraints are kept, no merges.. *)
  61 val oblivion_ugraph: universe_graph
  62
  63 (* one of the previous two, no set to empty_ugraph *)
  64 val default_ugraph: universe_graph
  65
  66
  67 (*
  68   These are the real functions to add eq/ge/gt constraints
  69   to the passed graph, returning an updated graph or raising
  70   UniverseInconsistency
  71 *)
  72 val add_eq:
  73   universe -> universe -> universe_graph -> universe_graph
  74 val add_ge:
  75   universe -> universe -> universe_graph -> universe_graph
  76 val add_gt:
  77   universe -> universe -> universe_graph -> universe_graph
  78
  79 val do_rank: universe_graph -> int list * universe list
  80 val get_rank: universe -> int
  81
  82 (*
  83   debug function to print the graph to standard error
  84 *)
  85 val print_ugraph:
  86   universe_graph -> unit
  87
  88 (*
  89   does what expected, but I don't remember why this was exported
  90 *)
  91 val string_of_universe:
  92   universe -> string
  93
  94 (*
  95   given the list of visible universes (see universes_of_obj) returns a
  96   cleaned graph (cleaned from the not visible nodes)
  97 *)
  98 val clean_ugraph:
  99   universe_graph -> universe list -> universe_graph
 100
 101 (*
 102   Since fresh() can't add the right uri to each node, you
 103   must fill empty nodes with the uri before you serialize the graph to xml
 104
 105   these empty nodes are also filled in the universe list
 106 *)
 107 val fill_empty_nodes_with_uri:
 108   universe_graph -> universe list -> UriManager.uri ->
 109     universe_graph * universe list
 110
 111 (*
 112   makes a union.
 113   TODO:
 114   - remember already merged uri so that we completely skip already merged
 115     graphs, this may include a dependecy graph (not merge a subpart of an
 116     already merged graph)
 117 *)
 118 val merge_ugraphs:
 119   base_ugraph:universe_graph ->
 120   increment:(universe_graph * UriManager.uri) -> universe_graph
 121
 122 (*
 123   ugraph to xml file and viceversa
 124 *)
 125 val write_xml_of_ugraph:
 126   string -> universe_graph -> universe list -> unit
 127
 128 (*
 129   given a filename parses the xml and returns the data structure
 130 *)
 131 val ugraph_and_univlist_of_xml:
 132   string -> universe_graph * universe list
 133 val restart_numbering:
 134   unit -> unit
 135
 136 (*
 137   returns the universe number (used to save it do xml)
 138 *)
 139 val univno: universe -> int
 140 val univuri: universe -> UriManager.uri
 141
 142   (** re-hash-cons URIs contained in the given universe so that phisicaly
 143    * equality could be enforced. Mainly used by
 144    * CicEnvironment.restore_from_channel *)
 145 val recons_graph: universe_graph -> universe_graph
 146
 147   (** re-hash-cons a single universe *)
 148 val recons_univ: universe -> universe
 149
 150   (** consistency check that should be done before committin the graph to the
 151    * cache *)
 152 val assert_univs_have_uri: universe_graph -> universe list-> unit
 153
 154   (** asserts the universe is named *)
 155 val assert_univ: universe -> unit
 156
 157 val compare: universe -> universe -> int
 158 val eq: universe -> universe -> bool
 159
 160 val is_anon: universe -> bool