Skip to content

Commit 3f6f686

Browse files
chenglouchenglou
authored
[Belt] Change ofArray to fromArray, and ofFoo to fromFoo in general (#2590)
* [Belt] Change ofArray to fromArray, and ofFoo to fromFoo in general Discussed offline. Easier API to guess. Only changed the externally visible APIs. Didn't check in the JS files; too much noise for now. * Change internal ofFoo to fromFoo too * One last ofArray* * Update tests * Check in js artifacts to make tests pass
1 parent c656c7b commit 3f6f686

File tree

100 files changed

+701
-455
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+701
-455
lines changed

‎jscomp/others/belt_HashMap.ml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ let make (type key) (type identity) ~hintSize ~(id : (key,identity) id) =
201201
C.make ~hash:M.hash ~eq:M.eq ~hintSize
202202

203203

204-
let ofArray (type a) (type identity) arr ~id:(id:(a,identity) id) =
204+
let fromArray (type a) (type identity) arr ~id:(id:(a,identity) id) =
205205
let module M = (val id) in
206206
let hash, eq = M.hash, M.eq in
207207
let len = A.length arr in
@@ -212,6 +212,8 @@ let ofArray (type a) (type identity) arr ~id:(id:(a,identity) id) =
212212
set0 ~eq ~hash v key value
213213
done ;
214214
v
215+
216+
let ofArray = fromArray
215217

216218
let mergeMany h arr =
217219
let hash, eq = Belt_Id.getHashInternal ( C.hash h) , Belt_Id.getEqInternal (C.eq h) in

‎jscomp/others/belt_HashMap.mli

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,11 @@ val size: _ t -> int
149149
val toArray: ('key, 'value, 'id ) t -> ('key * 'value) array
150150
val keysToArray: ('key, _, _) t -> 'key array
151151
val valuesToArray: (_,'value,_) t -> 'value array
152-
val ofArray: ('key * 'value) array -> id:('key,'id) id -> ('key, 'value, 'id ) t
152+
val fromArray: ('key * 'value) array -> id:('key,'id) id -> ('key, 'value, 'id ) t
153153
val mergeMany: ('key, 'value, 'id ) t -> ('key * 'value) array -> unit
154154
val getBucketHistogram: _ t -> int array
155155
val logStats: _ t -> unit
156156

157+
val ofArray: ('key * 'value) array -> id:('key,'id) id -> ('key, 'value, 'id ) t
158+
[@@ocaml.deprecated "Use fromArray instead"]
157159

‎jscomp/others/belt_HashMapInt.ml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ let valuesToArray = N.valuesToArray
187187
let getBucketHistogram = N.getBucketHistogram
188188
let isEmpty = C.isEmpty
189189

190-
let ofArray arr =
190+
let fromArray arr =
191191
let len = A.length arr in
192192
let v = make len in
193193
for i = 0 to len - 1 do
@@ -196,6 +196,8 @@ let ofArray arr =
196196
done ;
197197
v
198198

199+
let ofArray = fromArray
200+
199201
(* TOOD: optimize heuristics for resizing *)
200202
let mergeMany h arr =
201203
let len = A.length arr in

‎jscomp/others/belt_HashMapInt.mli

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ val size: _ t -> int
4242
val toArray: 'a t -> (key * 'a) array
4343
val keysToArray: 'a t -> key array
4444
val valuesToArray: 'a t -> 'a array
45-
val ofArray: (key * 'a) array -> 'a t
45+
val fromArray: (key * 'a) array -> 'a t
4646
val mergeMany: 'a t -> (key * 'a) array -> unit
4747
val getBucketHistogram: _ t -> int array
4848
val logStats: _ t -> unit
49+
50+
val ofArray: (key * 'a) array -> 'a t
51+
[@@ocaml.deprecated "Use fromArray instead"]

‎jscomp/others/belt_HashMapString.ml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ let valuesToArray = N.valuesToArray
187187
let getBucketHistogram = N.getBucketHistogram
188188
let isEmpty = C.isEmpty
189189

190-
let ofArray arr =
190+
let fromArray arr =
191191
let len = A.length arr in
192192
let v = make len in
193193
for i = 0 to len - 1 do
@@ -196,6 +196,8 @@ let ofArray arr =
196196
done ;
197197
v
198198

199+
let ofArray = fromArray
200+
199201
(* TOOD: optimize heuristics for resizing *)
200202
let mergeMany h arr =
201203
let len = A.length arr in

‎jscomp/others/belt_HashMapString.mli

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ val size: _ t -> int
4242
val toArray: 'a t -> (key * 'a) array
4343
val keysToArray: 'a t -> key array
4444
val valuesToArray: 'a t -> 'a array
45-
val ofArray: (key * 'a) array -> 'a t
45+
val fromArray: (key * 'a) array -> 'a t
4646
val mergeMany: 'a t -> (key * 'a) array -> unit
4747
val getBucketHistogram: _ t -> int array
4848
val logStats: _ t -> unit
49+
50+
val ofArray: (key * 'a) array -> 'a t
51+
[@@ocaml.deprecated "Use fromArray instead"]

‎jscomp/others/belt_HashSet.ml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ let copy = N.copy
176176
let getBucketHistogram = N.getBucketHistogram
177177
let isEmpty = C.isEmpty
178178

179-
let ofArray (type a) (type identity) arr ~(id:(a,identity) id) =
179+
let fromArray (type a) (type identity) arr ~(id:(a,identity) id) =
180180
let module M = (val id) in
181181
let eq, hash = M.eq , M.hash in
182182
let len = A.length arr in
@@ -186,6 +186,7 @@ let ofArray (type a) (type identity) arr ~(id:(a,identity) id) =
186186
done ;
187187
v
188188

189+
let ofArray = fromArray
189190

190191
let mergeMany h arr =
191192
let eq, hash = C.eq h, C.hash h in

‎jscomp/others/belt_HashSet.mli

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ val logStats: _ t -> unit
117117
val toArray: ('a,'id) t -> 'a array
118118

119119
val ofArray: 'a array -> id:('a,'id) id -> ('a,'id) t
120+
[@@ocaml.deprecated "Use fromArray instead"]
121+
122+
val fromArray: 'a array -> id:('a,'id) id -> ('a,'id) t
120123

121124
val mergeMany: ('a,'id) t -> 'a array -> unit
122125

‎jscomp/others/belt_HashSetInt.ml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,16 @@ let copy = N.copy
138138
let getBucketHistogram = N.getBucketHistogram
139139
let isEmpty = C.isEmpty
140140

141-
let ofArray arr =
141+
let fromArray arr =
142142
let len = A.length arr in
143143
let v = C.make ~hintSize:len ~hash:() ~eq:() in
144144
for i = 0 to len - 1 do
145145
add v (A.getUnsafe arr i)
146146
done ;
147147
v
148148

149+
let ofArray = fromArray
150+
149151
(* TOOD: optimize heuristics for resizing *)
150152
let mergeMany h arr =
151153
let len = A.length arr in

‎jscomp/others/belt_HashSetInt.mli

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ val logStats: t -> unit
6767
val toArray: t -> key array
6868

6969
val ofArray: key array -> t
70+
[@@ocaml.deprecated "Use fromArray instead"]
71+
72+
val fromArray: key array -> t
7073

7174
val mergeMany: t -> key array -> unit
7275

‎jscomp/others/belt_HashSetString.ml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,16 @@ let copy = N.copy
139139
let getBucketHistogram = N.getBucketHistogram
140140
let isEmpty = C.isEmpty
141141

142-
let ofArray arr =
142+
let fromArray arr =
143143
let len = A.length arr in
144144
let v = C.make ~hintSize:len ~hash:() ~eq:() in
145145
for i = 0 to len - 1 do
146146
add v (A.getUnsafe arr i)
147147
done ;
148148
v
149149

150+
let ofArray = fromArray
151+
150152
(* TOOD: optimize heuristics for resizing *)
151153
let mergeMany h arr =
152154
let len = A.length arr in

‎jscomp/others/belt_HashSetString.mli

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ val logStats: t -> unit
6767
val toArray: t -> key array
6868

6969
val ofArray: key array -> t
70+
[@@ocaml.deprecated "Use fromArray instead"]
71+
72+
val fromArray: key array -> t
7073

7174
val mergeMany: t -> key array -> unit
7275

‎jscomp/others/belt_List.ml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,12 +394,14 @@ let rec fillAux arr i x =
394394
A.setUnsafe arr i h ;
395395
fillAux arr (i + 1) t
396396

397-
let rec ofArrayAux a i res =
397+
let rec fromArrayAux a i res =
398398
if i < 0 then res
399-
else ofArrayAux a (i - 1) (A.getUnsafe a i :: res)
399+
else fromArrayAux a (i - 1) (A.getUnsafe a i :: res)
400400

401-
let ofArray a =
402-
ofArrayAux a (A.length a - 1) []
401+
let fromArray a =
402+
fromArrayAux a (A.length a - 1) []
403+
404+
let ofArray = fromArray
403405

404406
let toArray ( x : _ t) =
405407
let len = length x in
@@ -410,7 +412,7 @@ let toArray ( x : _ t) =
410412
let shuffle xs =
411413
let v = toArray xs in
412414
A.shuffleInPlace v ;
413-
ofArray v
415+
fromArray v
414416

415417
let rec fillAuxMap arr i x f =
416418
match x with

‎jscomp/others/belt_List.mli

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,11 @@ val mapWithIndex: 'a t -> (int -> 'a -> 'b) -> 'b t
249249
*)
250250

251251
val ofArray: 'a array -> 'a t
252+
[@@ocaml.deprecated "Use fromArray instead"]
253+
254+
val fromArray: 'a array -> 'a t
252255
(** @example {[
253-
ofArray [|1;2;3|] = [1;2;3]
256+
fromArray [|1;2;3|] = [1;2;3]
254257
]}
255258
*)
256259

‎jscomp/others/belt_Map.ml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,12 @@ end
4040

4141
type ('k, 'v, 'id ) t = ('k, 'v, 'id) S.t
4242

43-
let ofArray (type k) (type idx) data ~(id : (k,idx) id) =
43+
let fromArray (type k) (type idx) data ~(id : (k,idx) id) =
4444
let module M = (val id) in
4545
let cmp = M.cmp in
46-
S.t ~cmp ~data:(Dict.ofArray ~cmp data)
46+
S.t ~cmp ~data:(Dict.fromArray ~cmp data)
4747

48+
let ofArray = fromArray
4849

4950
let remove m x =
5051
let cmp, odata = S.cmp m, S.data m in

‎jscomp/others/belt_Map.mli

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ val isEmpty: _ t -> bool
135135
(** [isEmpty s0]
136136
@example {[
137137
module IntCmp = (val Belt.Id.comparable (fun (x:int) y -> Pervasives.compare x y));;
138-
isEmpty (ofArray [|1,"1"|] ~id:(module IntCmp)) = false;;
138+
isEmpty (fromArray [|1,"1"|] ~id:(module IntCmp)) = false;;
139139
]}
140140
*)
141141

@@ -144,7 +144,7 @@ val has: ('k, 'v, 'id) t -> 'k -> bool
144144
145145
@example {[
146146
module IntCmp = (val Belt.Id.comparable (fun (x:int) y -> Pervasives.compare x y));;
147-
has (ofArray [|1,"1"|] ~id:(module IntCmp)) 1 = true;;
147+
has (fromArray [|1,"1"|] ~id:(module IntCmp)) 1 = true;;
148148
]}
149149
*)
150150

@@ -191,7 +191,7 @@ val forEach: ('k, 'v, 'id) t -> ('k -> 'v -> unit) -> unit
191191
module IntCmp =
192192
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
193193
194-
let s0 = ofArray ~id:(module IntCmp) [|4,"4";1,"1";2,"2,"3""|];;
194+
let s0 = fromArray ~id:(module IntCmp) [|4,"4";1,"1";2,"2,"3""|];;
195195
let acc = ref [] ;;
196196
forEach s0 (fun k v -> acc := (k,v) :: !acc);;
197197
@@ -209,7 +209,7 @@ val reduce: ('k, 'v, 'id) t -> 'acc -> ('acc -> 'k -> 'v -> 'acc) -> 'acc
209209
module IntCmp =
210210
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
211211
212-
let s0 = ofArray ~id:(module IntCmp) [|4,"4";1,"1";2,"2,"3""|];;
212+
let s0 = fromArray ~id:(module IntCmp) [|4,"4";1,"1";2,"2,"3""|];;
213213
reduce s0 [] (fun acc k v -> (k,v) acc ) = [4,"4";3,"3";2,"2";1,"1"];;
214214
]}
215215
*)
@@ -230,7 +230,7 @@ val size: ('k, 'v, 'id) t -> int
230230
@example {[
231231
module IntCmp =
232232
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
233-
size (ofArray [2,"2"; 2,"1"; 3,"3"] ~id:(module IntCmp)) = 2 ;;
233+
size (fromArray [2,"2"; 2,"1"; 3,"3"] ~id:(module IntCmp)) = 2 ;;
234234
]}
235235
*)
236236
val toArray: ('k, 'v, 'id) t -> ('k * 'v) array
@@ -239,7 +239,7 @@ val toArray: ('k, 'v, 'id) t -> ('k * 'v) array
239239
@example {[
240240
module IntCmp =
241241
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
242-
toArray (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) = [1,"1";2,"2";3,"3"]
242+
toArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) = [1,"1";2,"2";3,"3"]
243243
]}
244244
245245
*)
@@ -250,11 +250,14 @@ val toList: ('k, 'v, 'id) t -> ('k * 'v) list
250250
*)
251251

252252
val ofArray: ('k * 'v) array -> id:('k,'id) id -> ('k,'v,'id) t
253-
(** [ofArray kvs ~id]
253+
[@@ocaml.deprecated "Use fromArray instead"]
254+
255+
val fromArray: ('k * 'v) array -> id:('k,'id) id -> ('k,'v,'id) t
256+
(** [fromArray kvs ~id]
254257
@example {[
255258
module IntCmp =
256259
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
257-
toArray (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) = [1,"1";2,"2";3,"3"]
260+
toArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) = [1,"1";2,"2";3,"3"]
258261
]}
259262
*)
260263
val keysToArray: ('k, 'v, 'id) t -> 'k array
@@ -263,7 +266,7 @@ val keysToArray: ('k, 'v, 'id) t -> 'k array
263266
@example {[
264267
module IntCmp =
265268
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
266-
keysToArray (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) =
269+
keysToArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) =
267270
[|1;2;3|];;
268271
]}
269272
*)
@@ -273,7 +276,7 @@ val valuesToArray: ('k, 'v, 'id) t -> 'v array
273276
@example {[
274277
module IntCmp =
275278
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
276-
valuesToArray (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) =
279+
valuesToArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) =
277280
[|"1";"2";"3"|];;
278281
]}
279282
@@ -318,9 +321,9 @@ val get: ('k, 'v, 'id) t -> 'k -> 'v option
318321
@example {[
319322
module IntCmp =
320323
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
321-
get (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) 2 =
324+
get (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) 2 =
322325
Some "2";;
323-
get (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) 2 =
326+
get (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) 2 =
324327
None;;
325328
]}
326329
*)
@@ -356,7 +359,7 @@ val remove: ('k, 'v, 'id) t -> 'k -> ('k, 'v, 'id) t
356359
module IntCmp =
357360
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
358361
359-
let s0 = (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp));;
362+
let s0 = (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp));;
360363
361364
let s1 = remove s0 1;;
362365
let s2 = remove s1 1;;
@@ -384,7 +387,7 @@ val set:
384387
module IntCmp =
385388
(val Belt.Id.comparableU (fun[\@bs] (x:int) y -> Pervasives.compare x y));;
386389
387-
let s0 = (ofArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp));;
390+
let s0 = (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp));;
388391
389392
let s1 = set s0 2 "3";;
390393

‎jscomp/others/belt_MapDict.ml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ type ('key, 'a, 'id) t = ('key, 'a) N.t
3030
type ('key, 'id) cmp = ('key, 'id) Belt_Id.cmp
3131

3232
let empty = N.empty
33-
let ofArray = N.ofArray
33+
let fromArray = N.fromArray
34+
let ofArray = N.fromArray
3435
let isEmpty = N.isEmpty
3536
let cmp = N.cmp
3637
let cmpU = N.cmpU

‎jscomp/others/belt_MapDict.mli

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@ val size: ('k, 'a, 'id) t -> int
9292
val toList: ('k, 'a, 'id) t -> ('k * 'a) list
9393
(** In increasing order*)
9494
val toArray: ('k, 'a, 'id) t -> ('k * 'a) array
95-
val ofArray:
96-
('k * 'a) array -> cmp:('k,'id) cmp -> ('k,'a,'id) t
95+
val ofArray: ('k * 'a) array -> cmp:('k,'id) cmp -> ('k,'a,'id) t
96+
[@@ocaml.deprecated "Use fromArray instead"]
97+
val fromArray: ('k * 'a) array -> cmp:('k,'id) cmp -> ('k,'a,'id) t
9798
val keysToArray: ('k, 'a, 'id) t -> 'k array
9899
val valuesToArray: ('k, 'a, 'id) t -> 'a array
99100
val minKey: ('k, _, _) t -> 'k option

‎jscomp/others/belt_MapInt.ml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,5 @@ let getExn = I.getExn
161161
let split = I.split
162162
let mergeU = I.mergeU
163163
let merge = I.merge
164-
let ofArray = I.ofArray
164+
let fromArray = I.fromArray
165+
let ofArray = I.fromArray

‎jscomp/others/belt_MapInt.mli

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ val toList: 'v t -> (key * 'v) list
4747
(** In increasing order with respect *)
4848
val toArray: 'v t -> (key * 'v) array
4949
val ofArray: (key * 'v) array -> 'v t
50+
[@@ocaml.deprecated "Use fromArray instead"]
51+
val fromArray: (key * 'v) array -> 'v t
5052
val keysToArray: 'v t -> key array
5153
val valuesToArray: 'v t -> 'v array
5254
val minKey: _ t -> key option

‎jscomp/others/belt_MapString.ml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,5 @@ let getExn = I.getExn
161161
let split = I.split
162162
let mergeU = I.mergeU
163163
let merge = I.merge
164-
let ofArray = I.ofArray
164+
let fromArray = I.fromArray
165+
let ofArray = I.fromArray

0 commit comments

Comments
 (0)