package owl-base

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

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

(**
Operator definitions such as add, sub, mul, and div.
This signature defines the functions need to be implemented.
*)

module type BasicSig = sig
  type ('a, 'b) t

  val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val sub : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val mul : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val div : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val add_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val sub_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val mul_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val div_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val scalar_add : 'a -> ('a, 'b) t -> ('a, 'b) t

  val scalar_sub : 'a -> ('a, 'b) t -> ('a, 'b) t

  val scalar_mul : 'a -> ('a, 'b) t -> ('a, 'b) t

  val scalar_div : 'a -> ('a, 'b) t -> ('a, 'b) t

  val equal : ('a, 'b) t -> ('a, 'b) t -> bool

  val not_equal : ('a, 'b) t -> ('a, 'b) t -> bool

  val greater : ('a, 'b) t -> ('a, 'b) t -> bool

  val less : ('a, 'b) t -> ('a, 'b) t -> bool

  val greater_equal : ('a, 'b) t -> ('a, 'b) t -> bool

  val less_equal : ('a, 'b) t -> ('a, 'b) t -> bool
end

module type ExtendSig = sig
  type ('a, 'b) t

  val equal_scalar : ('a, 'b) t -> 'a -> bool

  val not_equal_scalar : ('a, 'b) t -> 'a -> bool

  val less_scalar : ('a, 'b) t -> 'a -> bool

  val greater_scalar : ('a, 'b) t -> 'a -> bool

  val less_equal_scalar : ('a, 'b) t -> 'a -> bool

  val greater_equal_scalar : ('a, 'b) t -> 'a -> bool

  val elt_equal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_not_equal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_less : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_greater : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_less_equal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_greater_equal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val elt_equal_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val elt_not_equal_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val elt_less_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val elt_greater_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val elt_less_equal_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val elt_greater_equal_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

  val fmod : (float, 'a) t -> (float, 'a) t -> (float, 'a) t

  val fmod_scalar : (float, 'a) t -> float -> (float, 'a) t

  val pow : (float, 'a) t -> (float, 'a) t -> (float, 'a) t

  val scalar_pow : float -> (float, 'a) t -> (float, 'a) t

  val pow_scalar : (float, 'a) t -> float -> (float, 'a) t

  val approx_equal : ?eps:float -> ('a, 'b) t -> ('a, 'b) t -> bool

  val approx_equal_scalar : ?eps:float -> ('a, 'b) t -> 'a -> bool

  val approx_elt_equal : ?eps:float -> ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val approx_elt_equal_scalar : ?eps:float -> ('a, 'b) t -> 'a -> ('a, 'b) t

  val add_ : ?out:('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> unit

  val sub_ : ?out:('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> unit

  val mul_ : ?out:('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> unit

  val div_ : ?out:('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> unit

  val add_scalar_ : ?out:('a, 'b) t -> ('a, 'b) t -> 'a -> unit

  val sub_scalar_ : ?out:('a, 'b) t -> ('a, 'b) t -> 'a -> unit

  val mul_scalar_ : ?out:('a, 'b) t -> ('a, 'b) t -> 'a -> unit

  val div_scalar_ : ?out:('a, 'b) t -> ('a, 'b) t -> 'a -> unit

  val concat_vertical : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val concat_horizontal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

  val get_fancy_ext : Owl_types.index array -> ('a, 'b) t -> ('a, 'b) t

  val set_fancy_ext : Owl_types.index array -> ('a, 'b) t -> ('a, 'b) t -> unit

  val get_slice_ext : int list array -> ('a, 'b) t -> ('a, 'b) t

  val set_slice_ext : int list array -> ('a, 'b) t -> ('a, 'b) t -> unit
end

module type MatrixSig = sig
  type ('a, 'b) t

  val get : ('a, 'b) t -> int -> int -> 'a

  val set : ('a, 'b) t -> int -> int -> 'a -> unit

  val dot : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t
end

module type NdarraySig = sig
  type ('a, 'b) t

  val get : ('a, 'b) t -> int array -> 'a

  val set : ('a, 'b) t -> int array -> 'a -> unit
end

module type LinalgSig = sig
  type ('a, 'b) t

  val mpow : ('a, 'b) t -> float -> ('a, 'b) t

  val linsolve
    :  ?trans:bool
    -> ?typ:[ `n | `u | `l ]
    -> ('a, 'b) t
    -> ('a, 'b) t
    -> ('a, 'b) t
end

(* ends here *)