libmojave/util/lm_dlist.mli

   1 (*
   2  * Doubly-linked lists.
   3  *
   4  * ----------------------------------------------------------------
   5  *
   6  * @begin[license]
   7  * Copyright (C) 2001-2005 Mojave Group, Caltech
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation,
  12  * version 2.1 of the License.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  22  *
  23  * Additional permission is given to link this library with the
  24  * OpenSSL project's "OpenSSL" library, and with the OCaml runtime,
  25  * and you may distribute the linked executables.  See the file
  26  * LICENSE.libmojave for more details.
  27  *
  28  * Author: Jason Hickey
  29  * @email{jyh@cs.caltech.edu}
  30  * @end[license]
  31  *)
  32
  33 (*
  34  * Lists contain handles.
  35  *)
  36 type 'a t
  37 type 'a handle
  38
  39 (*
  40  * Creation.
  41  *)
  42 val create : unit -> 'a t
  43 val create_handle : 'a -> 'a handle
  44 val data : 'a handle -> 'a
  45
  46 (*
  47  * List operations.
  48  *)
  49 val is_empty : 'a t -> bool
  50 val hd : 'a t -> 'a handle
  51 val tl : 'a handle -> 'a handle
  52 val no_tl : 'a handle -> bool
  53 val to_list : 'a t -> 'a handle list
  54
  55 (*
  56  * Standard ops.
  57  *)
  58 val length : 'a t -> int
  59
  60 (*
  61  * Iteration.
  62  *)
  63 val iter : ('a handle -> unit) -> 'a t -> unit
  64 val fold : ('a -> 'b handle -> 'a) -> 'a -> 'b t -> 'a
  65
  66 (*
  67  * Insertion/deletion.
  68  *)
  69 val insert : 'a handle -> 'a t -> unit
  70 val delete : 'a handle -> unit
  71
  72 (*!
  73  * @docoff
  74  *
  75  * -*-
  76  * Local Variables:
  77  * Caml-master: "compile"
  78  * End:
  79  * -*-
  80  *)