/usr/lib/ocaml/batteries/batQueue.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 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 | (*
* 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
*)
(** First-in first-out queues.
This module implements queues (FIFOs), with in-place modification.
@author Xavier Leroy (Base module)
@author David Teller
*)
type 'a t = 'a Queue.t
(** The type of queues containing elements of type ['a]. *)
exception Empty
(** Raised when {!Queue.take} or {!Queue.peek} is applied to an empty queue. *)
val create : unit -> 'a t
(** Return a new queue, initially empty. *)
val add : 'a -> 'a t -> unit
(** [add x q] adds the element [x] at the end of the queue [q]. *)
val push : 'a -> 'a t -> unit
(** [push] is a synonym for [add]. *)
val take : 'a t -> 'a
(** [take q] removes and returns the first element in queue [q],
or raises [Empty] if the queue is empty. *)
val pop : 'a t -> 'a
(** [pop] is a synonym for [take]. *)
val peek : 'a t -> 'a
(** [peek q] returns the first element in queue [q], without removing
it from the queue, or raises [Empty] if the queue is empty. *)
val top : 'a t -> 'a
(** [top] is a synonym for [peek]. *)
val clear : 'a t -> unit
(** Discard all elements from a queue. *)
val copy : 'a t -> 'a t
(** Return a copy of the given queue. *)
val is_empty : 'a t -> bool
(** Return [true] if the given queue is empty, [false] otherwise. *)
val length : 'a t -> int
(** Return the number of elements in a queue. *)
val iter : ('a -> unit) -> 'a t -> unit
(** [iter f q] applies [f] in turn to all elements of [q],
from the least recently entered to the most recently entered.
The queue itself is unchanged. *)
val map : ('a -> 'b) -> 'a t -> 'b t
(** [map f q] applies function [f] to each element of the queue
and returns a new queue [q'] with the results returned by [f].
Order is preserved and [q] is not consumed. So that if
[take q] returns [x] [take q'] will return [f x].
@since 2.3.0
*)
val filter : ('a -> bool) -> 'a t -> 'a t
(** [filter p q] returns a new queue that contain the elements of [q]
that satisfy the predicate [p], in the same order.
@since 2.4
*)
val filter_map : ('a -> 'b option) -> 'a t -> 'b t
(** [filter_map f q] applies [f] to the elements [a0,a1..an] of [q] in order,
and returns the queue of the elements [bi] such that [f ai = Some bi],
in the corresponding order.
@since 2.4
*)
val filter_inplace : ('a -> bool) -> 'a t -> unit
(** [filter_inplace p q] removes all the elements of the queue [q] that
don't satisfy the predicate [p]. The order of the elements
in the queue is preserved.
@since 2.4
*)
val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b
(** [fold f accu q] is equivalent to [List.fold_left f accu l],
where [l] is the list of [q]'s elements. The queue remains
unchanged. *)
val transfer : 'a t -> 'a t -> unit
(** [transfer q1 q2] adds all of [q1]'s elements at the end of
the queue [q2], then clears [q1]. It is equivalent to the
sequence [iter (fun x -> add x q2) q1; clear q1], but runs
in constant time. *)
type 'a enumerable = 'a t
val enum : 'a t -> 'a BatEnum.t
(** [enum q] returns a destructive enumeration of the elements of queue
[q], from the least recently entered to the most recently entered.
Reading the enumeration will progressively empty [q].*)
val of_enum : 'a BatEnum.t -> 'a t
(** [of_enum e] returns a new queue containing all the elements of [e].
This is equivalent to calling [push] with the first element of the
enumeration, then with the second, etc.*)
(** {6 Boilerplate code}*)
(** {7 Printing}*)
val print : ?first:string -> ?last:string -> ?sep:string -> ('a BatInnerIO.output -> 'b -> unit) -> 'a BatInnerIO.output -> 'b t -> unit
val compare : 'a BatOrd.comp -> 'a t BatOrd.comp
val equal : 'a BatOrd.eq -> 'a t BatOrd.eq
module Exceptionless : sig
val take : 'a t -> 'a option
val peek : 'a t -> 'a option
end
|