File: stdcompat__stack_s.mli.in

package info (click to toggle)
ocaml-stdcompat 20~git20240529-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,540 kB
  • sloc: ml: 34,099; sh: 861; makefile: 249
file content (151 lines) | stat: -rw-r--r-- 3,267 bytes parent folder | download
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
147
148
149
150
151
module type S = sig
@BEGIN_FROM_5_1_0@
@BEGIN_FROM_4_12_0@
type !'a t = 'a Stack.t
@END_FROM_4_12_0@
@BEGIN_BEFORE_4_12_0@
type 'a t = 'a Stack.t
@END_BEFORE_4_12_0@

@END_FROM_5_1_0@
@BEGIN_BEFORE_5_1_0@
@BEGIN_FROM_5_0_0@
type 'a t
@END_FROM_5_0_0@
@BEGIN_BEFORE_5_0_0@
@BEGIN_FROM_4_12_0@
type !'a t = 'a Stack.t
@END_FROM_4_12_0@
@BEGIN_BEFORE_4_12_0@
type 'a t = 'a Stack.t
@END_BEFORE_4_12_0@

@END_BEFORE_5_0_0@

@END_BEFORE_5_1_0@
(** @since 5.1.0: type !'a t
@since 3.07.0: type !'a t
 *)

exception Empty 
(** Alias for {!Stack.Empty} *)

val drop : 'a t -> unit
(** @since 5.1.0: val drop : 'a t -> unit *)

@BEGIN_FROM_5_1_0@
val to_seq : 'a t -> 'a Seq.t
@END_FROM_5_1_0@
@BEGIN_BEFORE_5_1_0@
@BEGIN_FROM_5_0_0@
val to_seq : 'a t -> 'a Stdcompat__seq.t
@END_FROM_5_0_0@
@BEGIN_BEFORE_5_0_0@
@BEGIN_FROM_4_07_0@
val to_seq : 'a t -> 'a Seq.t
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val to_seq : 'a t -> 'a Stdcompat__seq.t
@END_BEFORE_4_07_0@

@END_BEFORE_5_0_0@

@END_BEFORE_5_1_0@
(** @since 5.1.0: val to_seq : 'a t -> 'a Seq.t
@since 4.07.0: val to_seq : 'a t -> 'a Seq.t
 *)

@BEGIN_FROM_5_1_0@
val add_seq : 'a t -> 'a Seq.t -> unit
@END_FROM_5_1_0@
@BEGIN_BEFORE_5_1_0@
@BEGIN_FROM_5_0_0@
val add_seq : 'a t -> 'a Stdcompat__seq.t -> unit
@END_FROM_5_0_0@
@BEGIN_BEFORE_5_0_0@
@BEGIN_FROM_4_07_0@
val add_seq : 'a t -> 'a Seq.t -> unit
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val add_seq : 'a t -> 'a Stdcompat__seq.t -> unit
@END_BEFORE_4_07_0@

@END_BEFORE_5_0_0@

@END_BEFORE_5_1_0@
(** @since 5.1.0: val add_seq : 'a t -> 'a Seq.t -> unit
@since 4.07.0: val add_seq : 'a t -> 'a Seq.t -> unit
 *)

@BEGIN_FROM_5_1_0@
val of_seq : 'a Seq.t -> 'a t
@END_FROM_5_1_0@
@BEGIN_BEFORE_5_1_0@
@BEGIN_FROM_5_0_0@
val of_seq : 'a Stdcompat__seq.t -> 'a t
@END_FROM_5_0_0@
@BEGIN_BEFORE_5_0_0@
@BEGIN_FROM_4_07_0@
val of_seq : 'a Seq.t -> 'a t
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val of_seq : 'a Stdcompat__seq.t -> 'a t
@END_BEFORE_4_07_0@

@END_BEFORE_5_0_0@

@END_BEFORE_5_1_0@
(** @since 5.1.0: val of_seq : 'a Seq.t -> 'a t
@since 4.07.0: val of_seq : 'a Seq.t -> 'a t
 *)

val pop_opt : 'a t -> 'a option
(** @since 4.08.0: val pop_opt : 'a t -> 'a option *)

val top_opt : 'a t -> 'a option
(** @since 4.08.0: val top_opt : 'a t -> 'a option *)

@BEGIN_FROM_5_0_0@
val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc
@END_FROM_5_0_0@
@BEGIN_BEFORE_5_0_0@
@BEGIN_FROM_4_03_0@
val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b
@END_FROM_4_03_0@
@BEGIN_BEFORE_4_03_0@
val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc
@END_BEFORE_4_03_0@

@END_BEFORE_5_0_0@
(** @since 5.1.0: val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc
@since 4.03.0: val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b
 *)

val create : unit -> 'a t
(** Alias for {!Stack.create} *)

val push : 'a -> 'a t -> unit
(** Alias for {!Stack.push} *)

val pop : 'a t -> 'a
(** Alias for {!Stack.pop} *)

val top : 'a t -> 'a
(** Alias for {!Stack.top} *)

val clear : 'a t -> unit
(** Alias for {!Stack.clear} *)

val copy : 'a t -> 'a t
(** Alias for {!Stack.copy} *)

val is_empty : 'a t -> bool
(** Alias for {!Stack.is_empty} *)

val length : 'a t -> int
(** Alias for {!Stack.length} *)

val iter : ('a -> unit) -> 'a t -> unit
(** Alias for {!Stack.iter} *)

end