/usr/lib/ocaml/batteries/batStack.mli is in libbatteries-ocaml-dev 2.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | (*
* BatQueue - Extended operations on queues
* Copyright (C) 1996 Xavier Leroy
* 2008 David Teller, LIFO, Universite d'Orleans
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version,
* with the special exception on linking described in file LICENSE.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Last-in first-out stacks.
This module implements stacks (LIFOs), with in-place modification.
@author Xavier Leroy (Base module)
@author David Teller
*)
type 'a t = 'a Stack.t
(** The type of stacks containing elements of type ['a]. *)
exception Empty
(** Raised when {!Stack.pop} or {!Stack.top} is applied to an empty stack. *)
val create : unit -> 'a t
(** Return a new stack, initially empty. *)
val push : 'a -> 'a t -> unit
(** [push x s] adds the element [x] at the top of stack [s]. *)
val pop : 'a t -> 'a
(** [pop s] removes and returns the topmost element in stack [s],
or @raise Empty if the stack is empty. *)
val top : 'a t -> 'a
(** [top s] returns the topmost element in stack [s],
or @raise Empty if the stack is empty. *)
val clear : 'a t -> unit
(** Discard all elements from a stack. *)
val copy : 'a t -> 'a t
(** Return a copy of the given stack. *)
val is_empty : 'a t -> bool
(** Return [true] if the given stack is empty, [false] otherwise. *)
val length : 'a t -> int
(** Return the number of elements in a stack. *)
val iter : ('a -> unit) -> 'a t -> unit
(** [iter f s] applies [f] in turn to all elements of [s],
from the element at the top of the stack to the element at the
bottom of the stack. The stack itself is unchanged. *)
include BatEnum.Enumerable with type 'a enumerable = 'a t
val enum : 'a t -> 'a BatEnum.t
(** [enum s] returns an enumeration of the elements of stack [s], from
the most recently entered to the least recently entered. This
enumeration is made on a copy of the input stack, and reading from
it will not affect [s]. *)
val enum_destruct : 'a t -> 'a BatEnum.t
(** [enum s] returns a destructive enumeration of the elements of
stack [s], from the most recently entered to the least recently
entered. Reading the enumeration will progressively empty [s].*)
val of_enum : 'a BatEnum.t -> 'a t
(** [of_enum e] returns a new stack containing all the elements of
[e]. This is equivalent to calling [push] with the first element
of the enumeration, then with the second, etc.
Note: if [s] is a stack, [s <> of_enum (enum s)], as [of_enum]
reverses the input order. *)
(** {6 Boilerplate code}*)
(** {7 Printing}*)
(* Prints the contents of the given stack *)
val print : ?first:string -> ?last:string -> ?sep:string -> ('a BatInnerIO.output -> 'b -> unit) -> 'a BatInnerIO.output -> 'b t -> unit
(* Comparison and equality tests can be constructed based on a
comparison or equality function for elements. *)
val compare : 'a BatOrd.comp -> 'a t BatOrd.comp
val equal : 'a BatOrd.eq -> 'a t BatOrd.eq
module Exceptionless : sig
val top : 'a t -> 'a option
val pop : 'a t -> 'a option
end
|