/
int.mli
50 lines (38 loc) · 1.54 KB
/
int.mli
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
(*
Copyright © 2011 MLstate
This file is part of OPA.
OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*)
(**
* This module provides 64-bit signed integers. It should be used in place
* of [int] when this extra bit is required (int's are 63-bit) *and* to make
* sure everything works on 32-bit platforms (where this type will still provide
* 64-bits).
* In short this should be used in place of int's when dealing with values
* that may exceed 31 bits.
* Performance notice: value of type Int.t will occupy more space and
* operations on them will generally be slower than over the int type.
*)
(** A 64-bit integer (also on 32-bit platforms). *)
type t
(** Addition *)
val ( + ): t -> t -> t
(** Subtraction *)
val ( - ): t -> t -> t
(** Multiplication *)
val ( * ): t -> t -> t
(** Integer division *)
val ( / ): t -> t -> t
(** Conversion from native integer *)
val of_int: int -> t
exception Overflow
(** Conversion to native integer; throws Overflow if the value does not fit *)
val to_int: t -> int