package owl

  1. Overview
  2. Docs
package owl
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file owl_dense_ndarray_a.ml

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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
# 1 "src/owl/dense/owl_dense_ndarray_a.ml"
(*
 * OWL - OCaml Scientific and Engineering Computing
 * Copyright (c) 2016-2020 Liang Wang <liang.wang@cl.cam.ac.uk>
 *)

(* This is the module to support N-dimensional array of any types. In order to
  differentiate from others supporting numerical types, I made this module
  mostly self-contained. That means, I don't intend to make the code in this
  module reused by other modules, and some functions are copied from other
  files then locally adapted to provide the needed functionality.
 *)

open Owl_types

type 'a arr =
  { mutable shape : int array
  ; mutable stride : int array
  ; mutable data : 'a array
  }

let _calc_numel_from_shape s = Array.fold_left (fun a b -> a * b) 1 s

let make_arr shape stride data = { shape; stride; data }

let create d a =
  let n = _calc_numel_from_shape d in
  make_arr d (Owl_utils.calc_stride d) (Array.make n a)


let init d f =
  let n = _calc_numel_from_shape d in
  let data = Array.init n (fun i -> f i) in
  make_arr d (Owl_utils.calc_stride d) data


let init_nd d f =
  let n = _calc_numel_from_shape d in
  let j = Array.copy d in
  let s = Owl_utils.calc_stride d in
  let data =
    Array.init n (fun i ->
        Owl_utils.index_1d_nd i j s;
        f j)
  in
  make_arr d (Owl_utils.calc_stride d) data


let sequential ?(a = 0.) ?(step = 1.) d =
  let n = _calc_numel_from_shape d in
  let a = ref (a -. step) in
  let data =
    Array.init n (fun _ ->
        a := !a +. step;
        !a)
  in
  make_arr d (Owl_utils.calc_stride d) data


let zeros d = create d 0.

let ones d = create d 1.

let num_dims x = Array.length x.shape

let shape x = Array.copy x.shape

let nth_dim x i = x.shape.(i)

let numel x = _calc_numel_from_shape x.shape

let get x i = x.data.(Owl_utils.index_nd_1d i x.stride)

let set x i a = x.data.(Owl_utils.index_nd_1d i x.stride) <- a

let get_index x axis =
  let d = num_dims x in
  assert (Array.length axis = d);
  let n = Array.length axis.(0) in
  let indices = Array.make_matrix d n 0 in
  Array.iteri (fun i a -> Array.iteri (fun j b -> indices.(i).(j) <- b) a) axis;
  Array.map (fun i -> get x i) indices


let set_index x axis a =
  let d = num_dims x in
  assert (Array.length axis = d);
  let n = Array.length axis.(0) in
  let indices = Array.make_matrix d n 0 in
  Array.iteri (fun i a -> Array.iteri (fun j b -> indices.(i).(j) <- b) a) axis;
  Array.iteri (fun i j -> set x j a.(i)) indices


let slice_left = None [@@warning "-32"]

let copy_ ~out src =
  assert (src.shape = out.shape);
  Array.blit src.data 0 out.data 0 (numel src)


let fill x a = Array.fill x.data 0 (numel x) a

let reshape x d =
  let m = _calc_numel_from_shape x.shape in
  let n = _calc_numel_from_shape d in
  assert (m = n);
  make_arr d x.stride x.data


let flatten x = make_arr [| Array.length x.data |] [| 1 |] x.data

let copy x =
  { shape = Array.copy x.shape; stride = Array.copy x.stride; data = Array.copy x.data }


let same_shape x y = x.shape = y.shape

let sub_left x i =
  let i_len = Array.length i in
  let s_len = x.stride.(i_len - 1) in
  let pad_len = num_dims x - i_len in
  assert (pad_len > 0);
  let i = Owl_utils.Array.pad `Right 0 pad_len i in
  let start_pos = Owl_utils.index_nd_1d i x.stride in
  let data_y = Array.sub x.data start_pos s_len in
  let shape_y = Array.sub x.shape i_len pad_len in
  let stride_y = Array.sub x.stride i_len pad_len in
  make_arr shape_y stride_y data_y


let squeeze ?(axis = [||]) x =
  let a =
    match Array.length axis with
    | 0 -> Array.init (num_dims x) (fun i -> i)
    | _ -> axis
  in
  let s = Owl_utils.Array.filteri (fun i v -> not (v == 1 && Array.mem i a)) (shape x) in
  reshape x s


let expand ?(hi = false) x d =
  let d0 = d - num_dims x in
  match d0 > 0 with
  | true  ->
    if hi = true
    then Owl_utils.Array.pad `Right 1 d0 (shape x) |> reshape x
    else Owl_utils.Array.pad `Left 1 d0 (shape x) |> reshape x
  | false -> x


let reverse x =
  let y = copy x in
  Owl_utils.array_reverse y.data;
  y


(* iteration functions *)

let iter f x =
  for i = 0 to numel x - 1 do
    f x.data.(i) |> ignore
  done


let iteri f x =
  for i = 0 to numel x - 1 do
    f i x.data.(i) |> ignore
  done


let map f x = make_arr x.shape x.stride (Array.init (numel x) (fun i -> f x.data.(i)))

let mapi f x = make_arr x.shape x.stride (Array.init (numel x) (fun i -> f i x.data.(i)))

let iter2 f x y =
  assert (x.shape = y.shape);
  for i = 0 to numel x - 1 do
    f x.data.(i) y.data.(i) |> ignore
  done


let iter2i f x y =
  assert (x.shape = y.shape);
  for i = 0 to numel x - 1 do
    f i x.data.(i) y.data.(i) |> ignore
  done


let map2 f x y =
  assert (x.shape = y.shape);
  make_arr x.shape x.stride (Array.init (numel x) (fun i -> f x.data.(i) y.data.(i)))


let map2i f x y =
  assert (x.shape = y.shape);
  make_arr x.shape x.stride (Array.init (numel x) (fun i -> f i x.data.(i) y.data.(i)))


let filteri f x =
  let s = Owl_utils.Stack.make () in
  iteri
    (fun i y ->
      match f i y with
      | true  -> Owl_utils.Stack.push s i
      | false -> ())
    x;
  Owl_utils.Stack.to_array s


let filter f x = filteri (fun _ y -> f y) x

let fold f a x = Array.fold_left f a x.data

let foldi f a x =
  let a = ref a in
  for i = 0 to numel x - 1 do
    a := f i !a x.data.(i)
  done;
  !a


let exists f x = Array.exists f x.data

let not_exists f x = not (exists f x)

let for_all f x = Array.for_all f x.data

(* some comparison functions *)

let is_equal ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b <> 0
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let not_equal ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b = 0
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let greater ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b <> 1
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let less ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b <> -1
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let greater_equal ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b = -1
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let less_equal ?(cmp = Stdlib.compare) x y =
  assert (x.shape = y.shape);
  let r = ref true in
  try
    iter2
      (fun a b ->
        if cmp a b = 1
        then (
          r := false;
          failwith "found"))
      x
      y;
    !r
  with
  | Failure _ -> !r


let elt_equal ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b = 0) x y

let elt_not_equal ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b <> 0) x y

let elt_greater ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b = 1) x y

let elt_less ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b = -1) x y

let elt_greater_equal ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b <> -1) x y

let elt_less_equal ?(cmp = Stdlib.compare) x y = map2 (fun a b -> cmp a b <> 1) x y

let elt_equal_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b = 0) x

let elt_not_equal_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b <> 0) x

let elt_greater_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b = 1) x

let elt_less_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b = -1) x

let elt_greater_equal_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b <> -1) x

let elt_less_equal_scalar ?(cmp = Stdlib.compare) x b = map (fun a -> cmp a b <> 1) x

let sort ?(cmp = Stdlib.compare) x = Array.sort cmp x.data

let max ?(cmp = Stdlib.compare) x =
  let r = ref x.data.(0) in
  iter
    (fun a ->
      match cmp a !r with
      | 1 -> r := a
      | _ -> ())
    x;
  !r


let min ?(cmp = Stdlib.compare) x =
  let r = ref x.data.(0) in
  iter
    (fun a ->
      match cmp !r a with
      | 1 -> r := a
      | _ -> ())
    x;
  !r


let max_i ?(cmp = Stdlib.compare) x =
  let r = ref x.data.(0) in
  let j = ref 0 in
  iteri
    (fun i a ->
      match cmp a !r with
      | 1 ->
        r := a;
        j := i
      | _ -> ())
    x;
  !r, !j


let min_i ?(cmp = Stdlib.compare) x =
  let r = ref x.data.(0) in
  let j = ref 0 in
  iteri
    (fun i a ->
      match cmp !r a with
      | 1 ->
        r := a;
        j := i
      | _ -> ())
    x;
  !r, !j


(* operational functions *)

let _check_transpose_axis axis d =
  assert (Array.length axis = d);
  let h = Hashtbl.create 16 in
  Array.iter
    (fun x ->
      assert (0 <= x && x < d);
      assert (Hashtbl.mem h x = false);
      Hashtbl.add h x 0)
    axis


let transpose ?axis x =
  let d = num_dims x in
  let a =
    match axis with
    | Some a -> a
    | None   -> Array.init d (fun i -> d - i - 1)
  in
  (* check if axis is a correct permutation *)
  _check_transpose_axis a d;
  let s0 = shape x in
  let s1 = Array.map (fun j -> s0.(j)) a in
  let i' = Array.make d 0 in
  let i = Array.make d 0 in
  let y = make_arr s1 (Owl_utils.calc_stride s1) (Array.copy x.data) in
  iteri
    (fun i_1d z ->
      Owl_utils.index_1d_nd i_1d i x.stride;
      Array.iteri (fun k j -> i'.(k) <- i.(j)) a;
      set y i' z)
    x;
  y


let tile x reps =
  (* check the validity of reps *)
  if Array.exists (( > ) 1) reps then failwith "tile: repetition must be >= 1";
  (* align and promote the shape *)
  let a = num_dims x in
  let b = Array.length reps in
  let x, reps =
    match a < b with
    | true  ->
      let d = Owl_utils.Array.pad `Left 1 (b - a) (shape x) in
      reshape x d, reps
    | false ->
      let r = Owl_utils.Array.pad `Left 1 (a - b) reps in
      x, r
  in
  (* calculate the smallest continuous slice dx *)
  let i = ref (Array.length reps - 1) in
  let sx = shape x in
  let dx = ref sx.(!i) in
  while reps.(!i) = 1 && !i - 1 >= 0 do
    i := !i - 1;
    dx := !dx * sx.(!i)
  done;
  (* make the array to store the result *)
  let sy = Owl_utils.Array.map2i (fun _ a b -> a * b) sx reps in
  let y_data = Array.make (_calc_numel_from_shape sy) x.data.(0) in
  let y = make_arr sy (Owl_utils.calc_stride sy) y_data in
  (* project x and y to 1-dimensional arrays *)
  let x1 = x.data in
  let y1 = y.data in
  let stride_x = Owl_utils.calc_stride (shape x) in
  let stride_y = Owl_utils.calc_stride (shape y) in
  (* recursively tile the data within y *)
  let rec _tile ofsx ofsy lvl =
    if lvl = !i
    then
      for k = 0 to reps.(lvl) - 1 do
        let ofsy' = ofsy + (k * !dx) in
        Array.blit x1 ofsx y1 ofsy' !dx
      done
    else (
      for j = 0 to sx.(lvl) - 1 do
        let ofsx' = ofsx + (j * stride_x.(lvl)) in
        let ofsy' = ofsy + (j * stride_y.(lvl)) in
        _tile ofsx' ofsy' (lvl + 1)
      done;
      let _len = stride_y.(lvl) * sx.(lvl) in
      for k = 1 to reps.(lvl) - 1 do
        let ofsy' = ofsy + (k * _len) in
        Array.blit y1 ofsy y1 ofsy' _len
      done)
  in
  _tile 0 0 0;
  y


let repeat x reps =
  (* check the validity of reps *)
  if Array.exists (( > ) 1) reps then failwith "repeat: repetition must be >= 1";
  let x_dims = num_dims x in
  assert (Array.length reps = x_dims);
  if Array.for_all (fun x -> x = 1) reps = true
  then copy x
  else (
    let x_shape = shape x in
    let y_shape = Array.map2 ( * ) x_shape reps in
    let y_data = Array.make (_calc_numel_from_shape y_shape) x.data.(0) in
    let y = make_arr y_shape (Owl_utils.calc_stride y_shape) y_data in
    (* transform into a flat array first *)
    let x' = x.data in
    let y' = y.data in
    if x_dims = 1
    then (
      (* TODO: omg, cannot use blit, so have to copy one by one, I need to
         fiugre out a more efficient way to copy at the highest dimension. *)
      let ofsy = ref 0 in
      for i = 0 to numel x - 1 do
        for _j = 0 to reps.(0) - 1 do
          y'.(!ofsy) <- x'.(i);
          ofsy := !ofsy + 1
        done
      done)
    else (
      let highest_dim = x_dims - 1 in
      let slice_x = Owl_utils.calc_slice x_shape in
      let stride_y = Owl_utils.calc_stride y_shape in
      let hd = ref (highest_dim + 1) in
      while !hd > 1 && reps.(!hd - 1) = 1 do
        hd := !hd - 1
      done;
      let hd = if !hd = highest_dim + 1 then highest_dim else !hd in
      (* Copy the HD dimension from x to y *)
      let block_num = Array.make hd 0 in
      for i = 0 to hd - 1 do
        block_num.(i) <- slice_x.(i) / slice_x.(hd)
      done;
      let counter = Array.make hd 0 in
      let ofsx = ref 0 in
      let ofsy = ref 0 in
      let block_sz = reps.(hd) in
      for _i = 0 to block_num.(0) - 1 do
        let ofsy_sub = ref !ofsy in
        if block_sz = 1
        then Array.blit x' !ofsx y' !ofsy_sub slice_x.(hd)
        else
          for j = 0 to slice_x.(hd) - 1 do
            let elemx = x'.(!ofsx + j) in
            for k = 0 to block_sz - 1 do
              y'.(!ofsy_sub + k) <- elemx
            done;
            ofsy_sub := !ofsy_sub + block_sz
          done;
        ofsx := !ofsx + slice_x.(hd);
        ofsy := !ofsy + (stride_y.(hd - 1) * reps.(hd - 1));
        for j = hd - 1 downto 1 do
          let c = counter.(j) in
          if c + 1 = block_num.(j)
          then ofsy := !ofsy + (stride_y.(j - 1) * (reps.(j - 1) - 1));
          counter.(j) <- (if c + 1 = block_num.(j) then 0 else c + 1)
        done
      done;
      (* Copy the lower dimensions within y *)
      for d = hd - 1 downto 0 do
        let block_num = Array.make (d + 1) 0 in
        for i = 0 to d do
          block_num.(i) <- slice_x.(i) / slice_x.(d + 1)
        done;
        let ofsy = ref 0 in
        let block_sz = stride_y.(d) in
        let counter = Array.make hd 0 in
        for _i = 0 to block_num.(0) - 1 do
          let ofsy_sub = ref (!ofsy + block_sz) in
          for _j = 1 to reps.(d) - 1 do
            Array.blit y' !ofsy y' !ofsy_sub block_sz;
            ofsy_sub := !ofsy_sub + block_sz
          done;
          ofsy := !ofsy + (stride_y.(d) * reps.(d));
          for j = d - 1 downto 0 do
            let c = counter.(j) in
            if c + 1 = block_num.(j + 1)
            then ofsy := !ofsy + (stride_y.(j) * (reps.(j) - 1));
            counter.(j) <- (if c + 1 = block_num.(j + 1) then 0 else c + 1)
          done
        done
      done);
    y)


let concatenate ?(axis = 0) xs =
  (* get the shapes of all inputs and etc. *)
  let shapes = Array.map shape xs in
  let shape0 = Array.copy shapes.(0) in
  shape0.(axis) <- 0;
  let acc_dim = ref 0 in
  (* validate all the input shapes; update step_sz *)
  let step_sz = Array.(make (length xs) 0) in
  Array.iteri
    (fun i shape1 ->
      step_sz.(i) <- (Owl_utils.calc_slice shape1).(axis);
      acc_dim := !acc_dim + shape1.(axis);
      shape1.(axis) <- 0;
      assert (shape0 = shape1))
    shapes;
  (* allocalte space for new array *)
  shape0.(axis) <- !acc_dim;
  let y_data = Array.make (_calc_numel_from_shape shape0) xs.(0).data.(0) in
  let y = make_arr shape0 (Owl_utils.calc_stride shape0) y_data in
  (* flatten y then calculate the number of copies *)
  let z = y.data in
  let slice_sz = (Owl_utils.calc_slice shape0).(axis) in
  let m = numel y / slice_sz in
  let n = Array.length xs in
  (* flatten all the inputs and init the copy location *)
  let x_flt = Array.map (fun x -> x.data) xs in
  let x_ofs = Array.make n 0 in
  (* copy data in the flattened space *)
  let z_ofs = ref 0 in
  for _i = 0 to m - 1 do
    for j = 0 to n - 1 do
      Array.blit x_flt.(j) x_ofs.(j) z !z_ofs step_sz.(j);
      x_ofs.(j) <- x_ofs.(j) + step_sz.(j);
      z_ofs := !z_ofs + step_sz.(j)
    done
  done;
  (* all done, return the combined result *)
  y


(* the following four padding related functions, they are simply the replica
  from Owl_dense_ndarray_generic module, so please refer to that module. *)

let _expand_padding_index d s =
  let ls = Array.length s in
  let ld = Array.length d in
  let d = Owl_utils.Array.pad `Right [| 0; 0 |] (ls - ld) d in
  Array.map
    (function
      | [||]    -> [| 0; 0 |]
      | [| x |] -> [| x; x |]
      | x       -> x)
    d


let rec _copy_to_padding p1 ls l0 l1 i0 i1 d0 d1 s0 s1 x0 x1 =
  if d0 < d1
  then
    for i = 0 to s0.(d0) - 1 do
      i0.(d0) <- i;
      i1.(d0) <- i + p1.(d0).(0);
      _copy_to_padding p1 ls l0 l1 i0 i1 (d0 + 1) d1 s0 s1 x0 x1;
      i0.(d0) <- 0;
      i1.(d0) <- p1.(d0).(0)
    done
  else (
    let j0 = Owl_utils.index_nd_1d i0 l0 in
    let j1 = Owl_utils.index_nd_1d i1 l1 in
    Array.blit x0 j0 x1 j1 ls.(d0))


let _highest_padding_dimension p =
  let l = Array.length p - 1 in
  let d = ref l in
  (try
     for i = l downto 0 do
       d := i;
       if p.(i) <> [| 0; 0 |] then failwith "stop"
     done
   with
  | _exn -> ());
  !d


let pad v d x =
  let s0 = shape x in
  let p1 = _expand_padding_index (Owl_utils.llss2aarr d) s0 in
  let s1 = Array.map2 (fun m n -> m + n.(0) + n.(1)) s0 p1 in
  (* create ndarray y for storing the result *)
  let y_data = Array.make (_calc_numel_from_shape s1) v in
  let y = make_arr s1 (Owl_utils.calc_stride s1) y_data in
  (* prepare variables for block copying *)
  let ls = Owl_utils.calc_slice s0 in
  let l0 = Owl_utils.calc_stride s0 in
  let l1 = Owl_utils.calc_stride s1 in
  let i0 = Array.make (num_dims x) 0 in
  let i1 = Array.map (fun a -> a.(0)) p1 in
  let d0 = 0 in
  let d1 = _highest_padding_dimension p1 in
  let x0 = x.data in
  let x1 = y.data in
  _copy_to_padding p1 ls l0 l1 i0 i1 d0 d1 s0 s1 x0 x1;
  y


(* get_fancy function is adapted from its original implementation in owl_slicing
   module, refer to Owl_slicing module for more information
 *)
let get_fancy axis x =
  let axis = Owl_slicing.sdlist_to_sdarray axis in
  (* check axis is within boundary then re-format *)
  let s0 = shape x in
  let axis = Owl_slicing.check_slice_definition axis s0 in
  (* calculate the new shape for slice *)
  let s1 = Owl_slicing.calc_slice_shape axis in
  let y_data = Array.make (_calc_numel_from_shape s1) x.data.(0) in
  let y = make_arr s1 (Owl_utils.calc_stride s1) y_data in
  (* transform into 1d array *)
  let x' = x.data in
  let y' = y.data in
  (* prepare function of copying blocks *)
  let d0 = Array.length s1 in
  let d1, cb = Owl_slicing.calc_continuous_blksz axis s0 in
  let sd = Owl_utils.calc_stride s0 in
  let ofsy_i = ref 0 in
  (* two copying strategies based on the size of the minimum continuous block *)
  let high_dim_list =
    (function
      | L_ _ -> true
      | _    -> false)
      axis.(d0 - 1)
  in
  if cb > 1 || s0.(d0 - 1) = 1 || high_dim_list = true
  then (
    (* yay, there are at least some continuous blocks *)
    let b = cb in
    let f i =
      let ofsx = Owl_utils.index_nd_1d i sd in
      let ofsy = !ofsy_i * b in
      Array.blit x' ofsx y' ofsy b;
      ofsy_i := !ofsy_i + 1
    in
    (* start copying blocks *)
    Owl_slicing._foreach_continuous_blk axis d1 f;
    (* all done, return the result *)
    y)
  else (
    (* copy happens at the highest dimension, no continuous block *)
    let b = s1.(d0 - 1) in
    let c, dd =
      match axis.(d0 - 1) with
      | R_ i -> if i.(2) > 0 then i.(2), i.(0) else i.(2), i.(0) + ((b - 1) * i.(2))
      | _    -> failwith "owl_dense_ndarray_a:slice_array_typ"
    in
    let cx = if c > 0 then c else -c in
    let cy = if c > 0 then 1 else -1 in
    (* TODO: blit cannot be used, have to copy one by one *)
    let f i =
      let ofsx = ref (Owl_utils.index_nd_1d i sd + dd) in
      let ofsy = if c > 0 then ref (!ofsy_i * b) else ref (((!ofsy_i + 1) * b) - 1) in
      for _i = 0 to b - 1 do
        y'.(!ofsy) <- x'.(!ofsx);
        ofsx := !ofsx + cx;
        ofsy := !ofsy + cy
      done;
      ofsy_i := !ofsy_i + 1
    in
    (* start copying blocks *)
    Owl_slicing._foreach_continuous_blk axis (d1 - 1) f;
    (* all done, return the result *)
    y)


(* set_fancy function is adapted from its original implementation in owl_slicing
   module, refer to Owl_slicing module for more information
 *)
let set_fancy axis x y =
  let axis = Owl_slicing.sdlist_to_sdarray axis in
  (* check axis is within boundary then re-format *)
  let s0 = shape x in
  let axis = Owl_slicing.check_slice_definition axis s0 in
  (* calculate the new shape for slice *)
  let s1 = Owl_slicing.calc_slice_shape axis in
  assert (shape y = s1);
  (* transform into 1d array *)
  let x' = x.data in
  let y' = y.data in
  (* prepare function of copying blocks *)
  let d0 = Array.length s1 in
  let d1, cb = Owl_slicing.calc_continuous_blksz axis s0 in
  let sd = Owl_utils.calc_stride s0 in
  let ofsy_i = ref 0 in
  (* two copying strategies based on the size of the minimum continuous block *)
  let high_dim_list =
    (function
      | L_ _ -> true
      | _    -> false)
      axis.(d0 - 1)
  in
  if cb > 1 || s0.(d0 - 1) = 1 || high_dim_list = true
  then (
    (* yay, there are at least some continuous blocks *)
    let b = cb in
    let f i =
      let ofsx = Owl_utils.index_nd_1d i sd in
      let ofsy = !ofsy_i * b in
      Array.blit y' ofsy x' ofsx b;
      ofsy_i := !ofsy_i + 1
    in
    (* start copying blocks *)
    Owl_slicing._foreach_continuous_blk axis d1 f)
  else (
    (* copy happens at the highest dimension, no continuous block *)
    let b = s1.(d0 - 1) in
    let c, dd =
      match axis.(d0 - 1) with
      | R_ i -> if i.(2) > 0 then i.(2), i.(0) else i.(2), i.(0) + ((b - 1) * i.(2))
      | _    -> failwith "owl_dense_ndarray_a:slice_array_typ"
    in
    let cx = if c > 0 then c else -c in
    let cy = if c > 0 then 1 else -1 in
    (* TODO: blit cannot be used, have to copy one by one *)
    let f i =
      let ofsx = ref (Owl_utils.index_nd_1d i sd + dd) in
      let ofsy = if c > 0 then ref (!ofsy_i * b) else ref (((!ofsy_i + 1) * b) - 1) in
      for _i = 0 to b - 1 do
        x'.(!ofsx) <- y'.(!ofsy);
        ofsx := !ofsx + cx;
        ofsy := !ofsy + cy
      done;
      ofsy_i := !ofsy_i + 1
    in
    (* start copying blocks *)
    Owl_slicing._foreach_continuous_blk axis (d1 - 1) f)


(* simplified get_fancy function which accept list of list as slice definition.
  adapted from owl_slicing module, refer to Owl_slicing for more information.
 *)
let get_slice axis x =
  let axis = List.map (fun i -> R i) axis in
  get_fancy axis x


(* simplified set_slice function which accept list of list as slice definition
  adapted from owl_slicing module, refer to Owl_slicing for more information.
*)
let set_slice axis x y =
  let axis = List.map (fun i -> R i) axis in
  set_fancy axis x y


let swap a0 a1 x =
  let d = num_dims x in
  let a = Array.init d (fun i -> i) in
  let t = a.(a0) in
  a.(a0) <- a.(a1);
  a.(a1) <- t;
  transpose ~axis:a x


let strides x = x |> shape |> Owl_utils.calc_stride

let slice_size x = x |> shape |> Owl_utils.calc_slice

let index_nd_1d i_nd _stride = Owl_utils.index_nd_1d i_nd _stride

let index_1d_nd i_1d _stride =
  let i_nd = Array.copy _stride in
  Owl_utils.index_1d_nd i_1d i_nd _stride;
  i_nd


(* input/output functions *)

let of_array x d = make_arr d (Owl_utils.calc_stride d) x

let to_array x = x.data

(* ends here *)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct