forked from ocamllibs/stdcompat
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathstdcompat__array_s.mli.in
272 lines (220 loc) · 8.42 KB
/
stdcompat__array_s.mli.in
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
module type S = sig
@BEGIN_FROM_4_08_0@
type 'a t = 'a array
@END_FROM_4_08_0@
@BEGIN_BEFORE_4_08_0@
type 'a t = 'a array
@END_BEFORE_4_08_0@
(** @since 4.08.0: type 'a t = 'a array
*)
@BEGIN_FROM_4_06_0@
module Floatarray = Array.Floatarray
@END_FROM_4_06_0@
@BEGIN_BEFORE_4_06_0@
module Floatarray :
sig val create : int -> Stdcompat__init.floatarray
val length : Stdcompat__init.floatarray -> int
val get : Stdcompat__init.floatarray -> int -> float
val set : Stdcompat__init.floatarray -> int -> float -> unit
val unsafe_get : Stdcompat__init.floatarray -> int -> float
val unsafe_set : Stdcompat__init.floatarray -> int -> float -> unit end
@END_BEFORE_4_06_0@
(** @since 4.06.0: module Floatarray = Array.Floatarray
*)
val fold_left_map :
('a -> 'b -> ('a * 'c)) -> 'a -> 'b array -> ('a * 'c array)
(** @since 4.13.0:
val fold_left_map :
('a -> 'b -> ('a * 'c)) -> 'a -> 'b array -> ('a * 'c array) *)
val find_opt : ('a -> bool) -> 'a array -> 'a option
(** @since 4.13.0: val find_opt : ('a -> bool) -> 'a array -> 'a option *)
val find_map : ('a -> 'b option) -> 'a array -> 'b option
(** @since 4.13.0: val find_map : ('a -> 'b option) -> 'a array -> 'b option *)
val split : ('a * 'b) array -> ('a array * 'b array)
(** @since 4.13.0: val split : ('a * 'b) array -> ('a array * 'b array) *)
val combine : 'a array -> 'b array -> ('a * 'b) array
(** @since 4.13.0: val combine : 'a array -> 'b array -> ('a * 'b) array *)
val for_all2 : ('a -> 'b -> bool) -> 'a array -> 'b array -> bool
(** @since 4.11.0:
val for_all2 : ('a -> 'b -> bool) -> 'a array -> 'b array -> bool *)
val exists2 : ('a -> 'b -> bool) -> 'a array -> 'b array -> bool
(** @since 4.11.0:
val exists2 : ('a -> 'b -> bool) -> 'a array -> 'b array -> bool *)
@BEGIN_FROM_4_07_0@
val to_seq : 'a array -> 'a Seq.t
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val to_seq : 'a array -> 'a Stdcompat__seq.t
@END_BEFORE_4_07_0@
(** @since 4.07.0: val to_seq : 'a array -> 'a Seq.t
*)
@BEGIN_FROM_4_07_0@
val to_seqi : 'a array -> (int * 'a) Seq.t
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val to_seqi : 'a array -> (int * 'a) Stdcompat__seq.t
@END_BEFORE_4_07_0@
(** @since 4.07.0: val to_seqi : 'a array -> (int * 'a) Seq.t
*)
@BEGIN_FROM_4_07_0@
val of_seq : 'a Seq.t -> 'a array
@END_FROM_4_07_0@
@BEGIN_BEFORE_4_07_0@
val of_seq : 'a Stdcompat__seq.t -> 'a array
@END_BEFORE_4_07_0@
(** @since 4.07.0: val of_seq : 'a Seq.t -> 'a array
*)
@BEGIN_FROM_4_03_0@
external create_float : int -> float array = "caml_make_float_vect"
@END_FROM_4_03_0@
@BEGIN_BEFORE_4_03_0@
val create_float : int -> float array
@END_BEFORE_4_03_0@
(** @since 4.03.0:
external create_float : int -> float array = "caml_make_float_vect"
*)
val iter2 : ('a -> 'b -> unit) -> 'a array -> 'b array -> unit
(** @since 4.03.0:
val iter2 : ('a -> 'b -> unit) -> 'a array -> 'b array -> unit *)
val map2 : ('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array
(** @since 4.03.0:
val map2 : ('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array *)
val for_all : ('a -> bool) -> 'a array -> bool
(** @since 4.03.0: val for_all : ('a -> bool) -> 'a array -> bool *)
val exists : ('a -> bool) -> 'a array -> bool
(** @since 4.03.0: val exists : ('a -> bool) -> 'a array -> bool *)
val mem : 'a -> 'a array -> bool
(** @since 4.03.0: val mem : 'a -> 'a array -> bool *)
val memq : 'a -> 'a array -> bool
(** @since 4.03.0: val memq : 'a -> 'a array -> bool *)
@BEGIN_FROM_4_08_0@
val make_float : int -> float array
@END_FROM_4_08_0@
@BEGIN_BEFORE_4_08_0@
@BEGIN_FROM_4_03_0@
val make_float : int -> float array[@@ocaml.deprecated
"Use Array.create_float instead."]
@END_FROM_4_03_0@
@BEGIN_BEFORE_4_03_0@
@BEGIN_FROM_4_02_0@
external make_float : int -> float array = "caml_make_float_vect"
@END_FROM_4_02_0@
@BEGIN_BEFORE_4_02_0@
val make_float : int -> float array
@END_BEFORE_4_02_0@
@END_BEFORE_4_03_0@
@END_BEFORE_4_08_0@
(** @since 4.08.0: val make_float : int -> float array
@since 4.03.0:
val make_float : int -> float array[@@ocaml.deprecated
"Use Array.create_float instead."]
@since 4.02.0:
external make_float : int -> float array = "caml_make_float_vect"
*)
external length : 'a array -> int = "%array_length"
(** Alias for {!Array.length} *)
external get : 'a array -> int -> 'a = "%array_safe_get"
(** Alias for {!Array.get} *)
external set : 'a array -> int -> 'a -> unit = "%array_safe_set"
(** Alias for {!Array.set} *)
@BEGIN_FROM_3_08_0@
external make : int -> 'a -> 'a array = "caml_make_vect"
@END_FROM_3_08_0@
@BEGIN_BEFORE_3_08_0@
external make : int -> 'a -> 'a array = "make_vect"
@END_BEFORE_3_08_0@
(** @since 3.08.0: external make : int -> 'a -> 'a array = "caml_make_vect"
@since 3.07.0: external make : int -> 'a -> 'a array = "make_vect"
*)
@BEGIN_FROM_4_08_0@
external create : int -> 'a -> 'a array = "caml_make_vect"
@END_FROM_4_08_0@
@BEGIN_BEFORE_4_08_0@
@BEGIN_FROM_4_02_0@
external create : int -> 'a -> 'a array = "caml_make_vect"[@@ocaml.deprecated
"Use Array.make instead."]
@END_FROM_4_02_0@
@BEGIN_BEFORE_4_02_0@
@BEGIN_FROM_3_08_0@
external create : int -> 'a -> 'a array = "caml_make_vect"
@END_FROM_3_08_0@
@BEGIN_BEFORE_3_08_0@
external create : int -> 'a -> 'a array = "make_vect"
@END_BEFORE_3_08_0@
@END_BEFORE_4_02_0@
@END_BEFORE_4_08_0@
(** @since 4.08.0: external create : int -> 'a -> 'a array = "caml_make_vect"
@since 4.02.0:
external create : int -> 'a -> 'a array = "caml_make_vect"[@@ocaml.deprecated
"Use Array.make instead."]
@since 3.08.0: external create : int -> 'a -> 'a array = "caml_make_vect"
@since 3.07.0: external create : int -> 'a -> 'a array = "make_vect"
*)
val init : int -> (int -> 'a) -> 'a array
(** Alias for {!Array.init} *)
val make_matrix : int -> int -> 'a -> 'a array array
(** Alias for {!Array.make_matrix} *)
@BEGIN_FROM_4_08_0@
val create_matrix : int -> int -> 'a -> 'a array array
@END_FROM_4_08_0@
@BEGIN_BEFORE_4_08_0@
@BEGIN_FROM_4_02_0@
val create_matrix : int -> int -> 'a -> 'a array array[@@ocaml.deprecated
"Use Array.make_matrix instead."]
@END_FROM_4_02_0@
@BEGIN_BEFORE_4_02_0@
val create_matrix : int -> int -> 'a -> 'a array array
@END_BEFORE_4_02_0@
@END_BEFORE_4_08_0@
(** @since 4.08.0: val create_matrix : int -> int -> 'a -> 'a array array
@since 4.02.0:
val create_matrix : int -> int -> 'a -> 'a array array[@@ocaml.deprecated
"Use Array.make_matrix instead."]
@since 3.07.0: val create_matrix : int -> int -> 'a -> 'a array array
*)
val append : 'a array -> 'a array -> 'a array
(** Alias for {!Array.append} *)
val concat : 'a array list -> 'a array
(** Alias for {!Array.concat} *)
val sub : 'a array -> int -> int -> 'a array
(** Alias for {!Array.sub} *)
val copy : 'a array -> 'a array
(** Alias for {!Array.copy} *)
val fill : 'a array -> int -> int -> 'a -> unit
(** Alias for {!Array.fill} *)
val blit : 'a array -> int -> 'a array -> int -> int -> unit
(** Alias for {!Array.blit} *)
val to_list : 'a array -> 'a list
(** Alias for {!Array.to_list} *)
val of_list : 'a list -> 'a array
(** Alias for {!Array.of_list} *)
val iter : ('a -> unit) -> 'a array -> unit
(** Alias for {!Array.iter} *)
val iteri : (int -> 'a -> unit) -> 'a array -> unit
(** Alias for {!Array.iteri} *)
val map : ('a -> 'b) -> 'a array -> 'b array
(** Alias for {!Array.map} *)
val mapi : (int -> 'a -> 'b) -> 'a array -> 'b array
(** Alias for {!Array.mapi} *)
val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b array -> 'a
(** Alias for {!Array.fold_left} *)
@BEGIN_FROM_4_00_0@
val fold_right : ('b -> 'a -> 'a) -> 'b array -> 'a -> 'a
@END_FROM_4_00_0@
@BEGIN_BEFORE_4_00_0@
val fold_right : ('a -> 'b -> 'b) -> 'a array -> 'b -> 'b
@END_BEFORE_4_00_0@
(** @since 4.00.0: val fold_right : ('b -> 'a -> 'a) -> 'b array -> 'a -> 'a
@since 3.07.0: val fold_right : ('a -> 'b -> 'b) -> 'a array -> 'b -> 'b
*)
val sort : ('a -> 'a -> int) -> 'a array -> unit
(** Alias for {!Array.sort} *)
val stable_sort : ('a -> 'a -> int) -> 'a array -> unit
(** Alias for {!Array.stable_sort} *)
val fast_sort : ('a -> 'a -> int) -> 'a array -> unit
(** Alias for {!Array.fast_sort} *)
external unsafe_get : 'a array -> int -> 'a = "%array_unsafe_get"
(** Alias for {!Array.unsafe_get} *)
external unsafe_set : 'a array -> int -> 'a -> unit = "%array_unsafe_set"
(** Alias for {!Array.unsafe_set} *)
end