File: uint.mli

package info (click to toggle)
herdtools7 7.58-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,732 kB
  • sloc: ml: 128,583; ansic: 3,827; makefile: 670; python: 407; sh: 212; awk: 14
file content (112 lines) | stat: -rw-r--r-- 3,449 bytes parent folder | download
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
(****************************************************************************)
(*                           the diy toolsuite                              *)
(*                                                                          *)
(* Jade Alglave, University College London, UK.                             *)
(* Luc Maranget, INRIA Paris-Rocquencourt, France.                          *)
(*                                                                          *)
(* Copyright 2015-present Institut National de Recherche en Informatique et *)
(* en Automatique, ARM Ltd and the authors. All rights reserved.            *)
(*                                                                          *)
(* This software is governed by the CeCILL-B license under French law and   *)
(* abiding by the rules of distribution of free software. You can use,      *)
(* modify and/ or redistribute the software under the terms of the CeCILL-B *)
(* license as circulated by CEA, CNRS and INRIA at the following URL        *)
(* "http://www.cecill.info". We also give a copy in LICENSE.txt.            *)
(****************************************************************************)

module type S = sig
  type t

  val num_bits : int

  val zero : t
  val one : t
  val max_int : t

  val add : t -> t -> t
  val sub : t -> t -> t
  val mul : t -> t -> t
  val div : t -> t -> t
  val rem : t -> t -> t

  val pred : t -> t
  val succ : t -> t

  val logand : t -> t -> t
  val logor : t -> t -> t
  val logxor : t -> t -> t
  val lognot : t -> t

  (** [shift_left u by] does a logical shift of [u] by [by] bits.
   *  Behavior is undefined, including potentially raising [Failure],
   *  if [by < 0] or [by >= num_bits]. *)
  val shift_left : t -> int -> t

  (** [shift_right u by] does an arithmetic shift of [u] by [by] bits,
   *  extending the sign bit into the vacated bits.
   *  Behavior is undefined, including potentially raising [Failure],
   *  if [by < 0] or [by >= num_bits]. *)
  val shift_right : t -> int -> t

  (** [shift_right u] does a logical shift of [u] by [by] bits, which does not
   *  consider the sign bit special.
   *  Behavior is undefined, including potentially raising [Failure],
   *  if [by < 0] or [by >= num_bits]. *)
  val shift_right_logical : t -> int -> t

  val leading_zeros : t -> int

  val compare : t -> t -> int
  val equal : t -> t -> bool

  val to_int : t -> int
  val of_int : int -> t

  (** [to_string u] converts [u] to a decimal representation. *)
  val to_string : t -> string

  (** [to_string_hex u] converts [u] to a hexadecimal representation, prefixed
   *  by 0x. For example, [to_string_hex 12345] returns ["0x3039"]. *)
  val to_string_hex : t -> string

  (** [of_string s] converts [s] to an integer, and respects 0x, 0o, and 0b
   *  prefixes for hexadecimal, octal, and binary numbers. It raises [Failure]
   *  if the input is invalid. *)
  val of_string : string -> t
end

module Uint8 : sig
  type t
  val max_int : t
end

module Uint16 : sig
  type t
  val max_int : t
end

module Uint32 : sig
  type t
  val max_int : t
end

module Uint64 : sig
  type t

  include S with type t := t

  val of_int64 : int64 -> t
end

module Uint128 : sig
  type t

  include S with type t := t

  val to_int64 : t -> Int64.t
  val of_int64 : Int64.t -> t
  val of_uint64 : Uint64.t -> t
  val of_uint32 : Uint32.t -> t
  val of_uint16 : Uint16.t -> t
  val of_uint8 : Uint8.t -> t
end