-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathint.mli
173 lines (128 loc) · 6.45 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
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# 2 "int.mli"
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* The OCaml programmers *)
(* *)
(* Copyright 2018 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* 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. *)
(* *)
(**************************************************************************)
@@ portable
open! Stdlib
(** Integer values.
Integers are {!Sys.int_size} bits wide and use two's complement
representation. All operations are taken modulo
2{^[Sys.int_size]}. They do not fail on overflow.
@since 4.08 *)
(** {1:ints Integers} *)
type t = int
(** The type for integer values. *)
val zero : int
(** [zero] is the integer [0]. *)
val one : int
(** [one] is the integer [1]. *)
val minus_one : int
(** [minus_one] is the integer [-1]. *)
external neg : (int[@local_opt]) -> int = "%negint"
(** [neg x] is [~-x]. *)
external add : (int[@local_opt]) -> (int[@local_opt]) -> int = "%addint"
(** [add x y] is the addition [x + y]. *)
external sub : (int[@local_opt]) -> (int[@local_opt]) -> int = "%subint"
(** [sub x y] is the subtraction [x - y]. *)
external mul : (int[@local_opt]) -> (int[@local_opt]) -> int = "%mulint"
(** [mul x y] is the multiplication [x * y]. *)
external div : (int[@local_opt]) -> (int[@local_opt]) -> int = "%divint"
(** [div x y] is the division [x / y]. See {!Stdlib.( / )} for details. *)
external rem : (int[@local_opt]) -> (int[@local_opt]) -> int = "%modint"
(** [rem x y] is the remainder [x mod y]. See {!Stdlib.( mod )} for details. *)
external succ : (int[@local_opt]) -> int = "%succint"
(** [succ x] is [add x 1]. *)
external pred : (int[@local_opt]) -> int = "%predint"
(** [pred x] is [sub x 1]. *)
val abs : int -> int
(** [abs x] is the absolute value of [x]. That is [x] if [x] is positive
and [neg x] if [x] is negative. {b Warning.} This may be negative if
the argument is {!min_int}. *)
val max_int : int
(** [max_int] is the greatest representable integer,
[2]{^[Sys.int_size - 1]}[-1]. *)
val min_int : int
(** [min_int] is the smallest representable integer,
[-2]{^[Sys.int_size - 1]}. *)
external logand : (int[@local_opt]) -> (int[@local_opt]) -> int = "%andint"
(** [logand x y] is the bitwise logical and of [x] and [y]. *)
external logor : (int[@local_opt]) -> (int[@local_opt]) -> int = "%orint"
(** [logor x y] is the bitwise logical or of [x] and [y]. *)
external logxor : (int[@local_opt]) -> (int[@local_opt]) -> int = "%xorint"
(** [logxor x y] is the bitwise logical exclusive or of [x] and [y]. *)
val lognot : int -> int
(** [lognot x] is the bitwise logical negation of [x]. *)
external shift_left : (int[@local_opt]) -> (int[@local_opt]) -> int = "%lslint"
(** [shift_left x n] shifts [x] to the left by [n] bits. The result
is unspecified if [n < 0] or [n > ]{!Sys.int_size}. *)
external shift_right : (int[@local_opt]) -> (int[@local_opt]) -> int = "%asrint"
(** [shift_right x n] shifts [x] to the right by [n] bits. This is an
arithmetic shift: the sign bit of [x] is replicated and inserted
in the vacated bits. The result is unspecified if [n < 0] or
[n > ]{!Sys.int_size}. *)
external shift_right_logical : (int[@local_opt]) -> (int[@local_opt]) -> int = "%lsrint"
(** [shift_right x n] shifts [x] to the right by [n] bits. This is a
logical shift: zeroes are inserted in the vacated bits regardless
of the sign of [x]. The result is unspecified if [n < 0] or
[n > ]{!Sys.int_size}. *)
(** {1:preds Predicates and comparisons} *)
val equal : int -> int -> bool
(** [equal x y] is [true] if and only if [x = y]. *)
val compare : int -> int -> int
(** [compare x y] is {!Stdlib.compare}[ x y] but more efficient. *)
val min : int -> int -> int
(** Return the smaller of the two arguments.
@since 4.13
*)
val max : int -> int -> int
(** Return the greater of the two arguments.
@since 4.13
*)
(** {1:convert Converting} *)
external to_float : (int[@local_opt]) -> (float[@local_opt]) = "%floatofint"
(** [to_float x] is [x] as a floating point number. *)
external of_float : (float[@local_opt]) -> int = "%intoffloat"
(** [of_float x] truncates [x] to an integer. The result is
unspecified if the argument is [nan] or falls outside the range of
representable integers. *)
(*
val of_string : string -> int option
(** [of_string s] is [Some s] if [s] can be parsed to an integer
in the range representable by the type [int] (note that this
depends on {!Sys.int_size}) and [None] otherwise.
The string may start with an optional ['-'] or ['+'] sign, and may
be followed by an optional prefix that specifies the base in which
the number is expressed. If there is not prefix or if the prefix
is [0u] or [0U] it is expressed in decimal. If the prefix is [0x]
or [0X] it is expressed in hexadecimal. If the prefix is [0o] or
[0O] it is expressed in octal. If the prefix is [0b] or [0B] it is
expressed in binary.
When the [0u] or [0U] prefix is used, the represented number may
exceed {!max_int} or {!min_int} in which case it wraps around
modulo 2{^[Sys.int_size]} like arithmetic operations do.
The ['_'] (underscore) character can appear anywhere between two
digits of the number. *)
*)
val to_string : int -> string
(** [to_string x] is the written representation of [x] in decimal. *)
val seeded_hash : int -> int -> int
(** A seeded hash function for ints, with the same output value as
{!Hashtbl.seeded_hash}. This function allows this module to be passed as
argument to the functor {!Hashtbl.MakeSeeded}.
@since 5.1 *)
val hash : int -> int
(** An unseeded hash function for ints, with the same output value as
{!Hashtbl.hash}. This function allows this module to be passed as argument
to the functor {!Hashtbl.Make}.
@since 5.1 *)