blob: 4fb1c114a543a667899d781443dbe6adecfbfd09 (
plain)
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
|
(************************************************************************)
(* * The Coq Proof Assistant / The Coq Development Team *)
(* v * Copyright INRIA, CNRS and contributors *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(* \VV/ **************************************************************)
(* // * This file is distributed under the terms of the *)
(* * GNU Lesser General Public License Version 2.1 *)
(* * (see LICENSE file for the text of the license) *)
(************************************************************************)
(** [t] is currently implemented by OCaml's [float] type.
Beware: NaNs have a sign and a payload, while they should be
indistinguishable from Coq's perspective. *)
type t = float
(** Test functions for special values to avoid calling [classify] *)
val is_nan : t -> bool
val is_infinity : t -> bool
val is_neg_infinity : t -> bool
val of_string : string -> t
(** Print a float exactly as an hexadecimal value (exact decimal
* printing would be possible but sometimes requires more than 700
* digits). *)
val to_hex_string : t -> string
(** Print a float as a decimal value. The printing is not exact (the
* real value printed is not always the given floating-point value),
* however printing is precise enough that forall float [f],
* [of_string (to_decimal_string f) = f]. *)
val to_string : t -> string
val compile : t -> string
val of_float : float -> t
(** Return [true] for "-", [false] for "+". *)
val sign : t -> bool
val opp : t -> t
val abs : t -> t
type float_comparison = FEq | FLt | FGt | FNotComparable
val eq : t -> t -> bool
val lt : t -> t -> bool
val le : t -> t -> bool
(** The IEEE 754 float comparison.
* NotComparable is returned if there is a NaN in the arguments *)
val compare : t -> t -> float_comparison
[@@ocaml.inline always]
type float_class =
| PNormal | NNormal | PSubn | NSubn | PZero | NZero | PInf | NInf | NaN
val classify : t -> float_class
[@@ocaml.inline always]
(** Link with integers *)
val of_int63 : Uint63.t -> t
[@@ocaml.inline always]
val normfr_mantissa : t -> Uint63.t
[@@ocaml.inline always]
(** Shifted exponent extraction *)
val eshift : int
val frshiftexp : t -> t * Uint63.t (* float remainder, shifted exponent *)
[@@ocaml.inline always]
val ldshiftexp : t -> Uint63.t -> t
[@@ocaml.inline always]
val next_up : t -> t
val next_down : t -> t
(** Return true if two floats are equal.
* All NaN values are considered equal. *)
val equal : t -> t -> bool
[@@ocaml.inline always]
val hash : t -> int
(** Total order relation over float values. Behaves like [Pervasives.compare].*)
val total_compare : t -> t -> int
val is_float64 : Obj.t -> bool
[@@ocaml.inline always]
|
