Source file `fixed_point_repr.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
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2020 Nomadic Labs <contact@nomadic-labs.com>                *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type fp_tag (* Tag for fixed point computations *)

type integral_tag (* Tag for integral computations *)

module type Safe = sig
  type 'a t

  type fp = fp_tag t

  type integral = integral_tag t

  val integral_exn : Z.t -> integral

  val integral_of_int_exn : int -> integral

  val integral_to_z : integral -> Z.t

  val zero : 'a t

  val add : 'a t -> 'a t -> 'a t

  val sub : 'a t -> 'a t -> 'a t

  val ceil : fp -> integral

  val floor : fp -> integral

  val fp : 'a t -> fp

  val ( = ) : 'a t -> 'b t -> bool

  val ( <> ) : 'a t -> 'b t -> bool

  val ( < ) : 'a t -> 'b t -> bool

  val ( <= ) : 'a t -> 'b t -> bool

  val ( >= ) : 'a t -> 'b t -> bool

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

  val compare : 'a t -> 'b t -> int

  val equal : 'a t -> 'b t -> bool

  val max : 'a t -> 'a t -> 'a t

  val min : 'a t -> 'a t -> 'a t

  val pp : Format.formatter -> 'a t -> unit

  val pp_integral : Format.formatter -> integral -> unit

  val n_fp_encoding : fp Data_encoding.t

  val n_integral_encoding : integral Data_encoding.t

  val z_fp_encoding : fp Data_encoding.t

  val z_integral_encoding : integral Data_encoding.t
end

module type Full = sig
  type 'a t

  include Safe with type 'a t := 'a t

  val unsafe_fp : Z.t -> fp
end