Source file `float_u.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
# 2 "float_u.ml"
(**************************************************************************)
(*                                                                        *)
(*                                 OCaml                                  *)
(*                                                                        *)
(*                 Chris Casinghino, Jane Street, New York                *)
(*                                                                        *)
(*   Copyright 2023 Jane Street Group LLC                                 *)
(*                                                                        *)
(*   All rights reserved.  This file is distributed under the terms of    *)
(*   the GNU Lesser General Public License version 2.1, with the          *)
(*   special exception on linking described in the file LICENSE.          *)
(*                                                                        *)
(**************************************************************************)

open! Stdlib

[@@@ocaml.flambda_o3]

type t = float#

external to_float : t -> (float[@local_opt]) @@ portable =
  "%box_float" [@@warning "-187"]

external of_float : (float[@local_opt]) -> t @@ portable =
  "%unbox_float" [@@warning "-187"]

(* CR layouts: Investigate whether it's worth making these things externals.
   Are there situations where the middle-end won't inline them and remove the
   boxing/unboxing? *)

let[@inline always] neg x = of_float (Float.neg (to_float x))

let[@inline always] add x y = of_float (Float.add (to_float x) (to_float y))

let[@inline always] sub x y = of_float (Float.sub (to_float x) (to_float y))

let[@inline always] mul x y = of_float (Float.mul (to_float x) (to_float y))

let[@inline always] div x y = of_float (Float.div (to_float x) (to_float y))

let[@inline always] fma x y z = of_float (Float.fma (to_float x) (to_float y) (to_float z))

let[@inline always] rem x y = of_float (Float.rem (to_float x) (to_float y))

let[@inline always] succ x = of_float (Float.succ (to_float x))

let[@inline always] pred x = of_float (Float.pred (to_float x))

let[@inline always] abs x = of_float (Float.abs (to_float x))

let[@inline always] is_finite x = Float.is_finite (to_float x)

let[@inline always] is_infinite x = Float.is_infinite (to_float x)

let[@inline always] is_nan x = Float.is_nan (to_float x)

let[@inline always] is_integer x = Float.is_integer (to_float x)

let[@inline always] of_int x = of_float (Float.of_int x)

let[@inline always] to_int x = Float.to_int (to_float x)

let[@inline always] of_string x = of_float (Float.of_string x)

let[@inline always] to_string x = Float.to_string (to_float x)

type fpclass = Stdlib.fpclass =
    FP_normal
  | FP_subnormal
  | FP_zero
  | FP_infinite
  | FP_nan

let[@inline always] classify_float x = Float.classify_float (to_float x)

let[@inline always] pow x y = of_float (Float.pow (to_float x) (to_float y))

let[@inline always] sqrt x = of_float (Float.sqrt (to_float x))

let[@inline always] cbrt x = of_float (Float.cbrt (to_float x))

let[@inline always] exp x = of_float (Float.exp (to_float x))

let[@inline always] exp2 x = of_float (Float.exp2 (to_float x))

let[@inline always] log x = of_float (Float.log (to_float x))

let[@inline always] log10 x = of_float (Float.log10 (to_float x))

let[@inline always] log2 x = of_float (Float.log2 (to_float x))

let[@inline always] expm1 x = of_float (Float.expm1 (to_float x))

let[@inline always] log1p x = of_float (Float.log1p (to_float x))

let[@inline always] cos x = of_float (Float.cos (to_float x))

let[@inline always] sin x = of_float (Float.sin (to_float x))

let[@inline always] tan x = of_float (Float.tan (to_float x))

let[@inline always] acos x = of_float (Float.acos (to_float x))

let[@inline always] asin x = of_float (Float.asin (to_float x))

let[@inline always] atan x = of_float (Float.atan (to_float x))

let[@inline always] atan2 x y = of_float (Float.atan2 (to_float x) (to_float y))

let[@inline always] hypot x y = of_float (Float.hypot (to_float x) (to_float y))

let[@inline always] cosh x = of_float (Float.cosh (to_float x))

let[@inline always] sinh x = of_float (Float.sinh (to_float x))

let[@inline always] tanh x = of_float (Float.tanh (to_float x))

let[@inline always] acosh x = of_float (Float.acosh (to_float x))

let[@inline always] asinh x = of_float (Float.asinh (to_float x))

let[@inline always] atanh x = of_float (Float.atanh (to_float x))

let[@inline always] erf x = of_float (Float.erf (to_float x))

let[@inline always] erfc x = of_float (Float.erfc (to_float x))

let[@inline always] trunc x = of_float (Float.trunc (to_float x))

let[@inline always] round x = of_float (Float.round (to_float x))

let[@inline always] ceil x = of_float (Float.ceil (to_float x))

let[@inline always] floor x = of_float (Float.floor (to_float x))

let[@inline always] next_after x y = of_float (Float.next_after (to_float x) (to_float y))

let[@inline always] copy_sign x y = of_float (Float.copy_sign (to_float x) (to_float y))

let[@inline always] sign_bit x = Float.sign_bit (to_float x)

let[@inline always] ldexp x i = of_float (Float.ldexp (to_float x) i)

let[@inline always] compare x y = Float.compare (to_float x) (to_float y)

let[@inline always] equal x y = Float.equal (to_float x) (to_float y)

let[@inline always] min x y = of_float (Float.min (to_float x) (to_float y))

let[@inline always] max x y = of_float (Float.max (to_float x) (to_float y))

let[@inline always] min_num x y = of_float (Float.min_num (to_float x) (to_float y))

let[@inline always] max_num x y = of_float (Float.max_num (to_float x) (to_float y))