package owl-base

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

Source file owl_operator.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
# 1 "src/base/core/owl_operator.ml"
(*
 * OWL - OCaml Scientific Computing
 * Copyright (c) 2016-2022 Liang Wang <liang@ocaml.xyz>
 *)

(** Operator definition such as add, sub, mul, and div. *)

open Owl_types_operator

(* define basic operators *)

module Make_Basic (M : BasicSig) = struct
  type ('a, 'b) op_t0 = ('a, 'b) M.t

  let ( + ) = M.add

  let ( - ) = M.sub

  let ( * ) = M.mul

  let ( / ) = M.div

  let ( +$ ) = M.add_scalar

  let ( -$ ) = M.sub_scalar

  let ( *$ ) = M.mul_scalar

  let ( /$ ) = M.div_scalar

  let ( $+ ) = M.scalar_add

  let ( $- ) = M.scalar_sub

  let ( $* ) = M.scalar_mul

  let ( $/ ) = M.scalar_div

  let ( = ) = M.equal

  let ( != ) = M.not_equal

  let ( <> ) = M.not_equal

  let ( > ) = M.greater

  let ( < ) = M.less

  let ( >= ) = M.greater_equal

  let ( <= ) = M.less_equal
end [@warning "-34"]

module Make_Extend (M : ExtendSig) = struct
  type ('a, 'b) op_t1 = ('a, 'b) M.t

  let ( =$ ) = M.equal_scalar

  let ( !=$ ) = M.not_equal_scalar

  let ( <>$ ) = M.not_equal_scalar

  let ( <$ ) = M.less_scalar

  let ( >$ ) = M.greater_scalar

  let ( <=$ ) = M.less_equal_scalar

  let ( >=$ ) = M.greater_equal_scalar

  let ( =. ) = M.elt_equal

  let ( !=. ) = M.elt_not_equal

  let ( <>. ) = M.elt_not_equal

  let ( <. ) = M.elt_less

  let ( >. ) = M.elt_greater

  let ( <=. ) = M.elt_less_equal

  let ( >=. ) = M.elt_greater_equal

  let ( =.$ ) = M.elt_equal_scalar

  let ( !=.$ ) = M.elt_not_equal_scalar

  let ( <>.$ ) = M.elt_not_equal_scalar

  let ( <.$ ) = M.elt_less_scalar

  let ( >.$ ) = M.elt_greater_scalar

  let ( <=.$ ) = M.elt_less_equal_scalar

  let ( >=.$ ) = M.elt_greater_equal_scalar

  let ( =~ ) = M.approx_equal

  let ( =~$ ) = M.approx_equal_scalar

  let ( =~. ) = M.approx_elt_equal

  let ( =~.$ ) = M.approx_elt_equal_scalar

  let ( % ) = M.fmod

  let ( %$ ) = M.fmod_scalar

  let ( ** ) = M.pow

  let ( $** ) = M.scalar_pow

  let ( **$ ) = M.pow_scalar

  let ( += ) x y = M.add_ ~out:x x y

  let ( -= ) x y = M.sub_ ~out:x x y

  let ( *= ) x y = M.mul_ ~out:x x y

  let ( /= ) x y = M.div_ ~out:x x y

  let ( +$= ) x a = M.add_scalar_ ~out:x x a

  let ( -$= ) x a = M.sub_scalar_ ~out:x x a

  let ( *$= ) x a = M.mul_scalar_ ~out:x x a

  let ( /$= ) x a = M.div_scalar_ ~out:x x a

  let ( @= ) = M.concat_vertical

  let ( @|| ) = M.concat_horizontal

  let ( .!{;..} ) x s = M.get_fancy_ext s x

  let ( .!{;..}<- ) x s = M.set_fancy_ext s x

  let ( .${} ) x s = M.get_slice_ext [| s |] x

  let ( .${;..} ) x s = M.get_slice_ext s x

  let ( .${}<- ) x s = M.set_slice_ext [| s |] x

  let ( .${;..}<- ) x s = M.set_slice_ext s x
end [@warning "-34"]

module Make_Matrix (M : MatrixSig) = struct
  type ('a, 'b) op_t2 = ('a, 'b) M.t

  let ( .%{} ) x (i1, i2) = M.get x i1 i2

  let ( .%{;..} ) x i =
    if Array.length i = 2
    then M.get x i.(0) i.(1)
    else
      failwith
        (".%{} on matrices requires exactly two indices but I got "
        ^ string_of_int
        @@ Array.length i)


  let ( .%{}<- ) x (i1, i2) = M.set x i1 i2

  let ( .%{;..}<- ) x i =
    if Array.length i = 2
    then M.set x i.(0) i.(1)
    else
      failwith
        (".%{}<- on matrices requires exactly two indices but I got "
        ^ string_of_int
        @@ Array.length i)


  let ( *@ ) a b = M.dot a b
end [@warning "-34"]

module Make_Ndarray (M : NdarraySig) = struct
  type ('a, 'b) op_t3 = ('a, 'b) M.t

  let ( .%{} ) x i = M.get x [| i |]

  let ( .%{;..} ) x i = M.get x i

  let ( .%{}<- ) x i = M.set x [| i |]

  let ( .%{;..}<- ) x i = M.set x i
end [@warning "-34"]

module Make_Linalg (M : LinalgSig) = struct
  type ('a, 'b) op_t4 = ('a, 'b) M.t

  let ( **@ ) x a = M.mpow x a

  let ( /@ ) a b = M.linsolve a b
end [@warning "-34"]

(* ends here *)