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
|
(******************************************************************************
* Core *
* *
* Copyright (C) 2008- Jane Street Holding, LLC *
* Contact: opensource@janestreet.com *
* WWW: http://www.janestreet.com/ocaml *
* *
* *
* 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 of the License, or (at your option) any later version. *
* *
* 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 *
* *
******************************************************************************)
(** Core_stack is a replacement for OCaml's standard Stack module that follows
Core idioms and adds some functions.
Differences from the standard module:
[pop] and [top] return an [option] rather than raise [Empty].
[iter] takes a labeled argument.
[push] takes the stack argument first.
[length] is O(1)
*)
open Sexplib
exception Empty
type 'a t
include Binable.S1 with type 'a binable = 'a t
include Sexpable.S1 with type 'a sexpable = 'a t
include Container.S1 with type 'a container = 'a t
(** [to_list] and [to_array] returns the elements in order from the top of
the stack to the bottom. *)
(** [of_list l] returns a stack whose top is the first element of [l] and
* bottom is the last element of [l].
*)
val of_list : 'a list -> 'a t
val invariant : 'a t -> unit
(** [create ()] returns an empty stack. *)
val create : unit -> 'a t
(** [push t x] adds [x] to the top of stack [t]. *)
val push : 'a t -> 'a -> unit
(** [pop t] returns [None] if [t] is empty, otherwise it returns [Some x] where
[x] is the top of [t] and removes [x] from the top of [t]. *)
val pop : 'a t -> 'a option
(** [pop_exn t] removes and returns the top element of [t], raising [Empty] if
[t] is empty. *)
val pop_exn : 'a t -> 'a
(** [top t] returns [None] if [t] is empty, otherwise it returns [Some x] where
[x] is the top of [t]. *)
val top : 'a t -> 'a option
(** [top_exn t] returns the top element of [t], raising [Empty] if [t] is empty.
*)
val top_exn : 'a t -> 'a
(** [clear t] discards all elements from [t]. *)
val clear : 'a t -> unit
(** [copy t] returns a copy of [t]. *)
val copy : 'a t -> 'a t
(** [until_empty t f] repeatedly pops an element [v] off of [t] and runs [f v]
until [t] becomes empty. It is fine if [f] adds more elements to [t], in
which case the most-recently-added element will be processed first.
*)
val until_empty : 'a t -> ('a -> unit) -> unit
|
