module BatNativeint:sig..end
This module provides operations on the type nativeint of
signed 32-bit integers (on 32-bit platforms) or
signed 64-bit integers (on 64-bit platforms).
This integer type has exactly the same width as that of a long
integer type in the C compiler. All arithmetic operations over
nativeint are taken modulo 232 or 264 depending
on the word size of the architecture.
Performance notice: values of type nativeint occupy more memory
space than values of type int, and arithmetic operations on
nativeint are generally slower than those on int. Use nativeint
only when the application requires the extra bit of precision
over the int type.
Any integer literal followed by n is taken to be a nativeint.
For instance, 1n is Native_int.one.
This module extends Stdlib's
Nativeint
module, go there for documentation on the rest of the functions
and types.
Author(s): Xavier Leroy (base module), Gabriel Scherer, David Teller
typet =nativeint
val zero : nativeintval one : nativeintval minus_one : nativeintval neg : nativeint -> nativeintval add : nativeint -> nativeint -> nativeintval sub : nativeint -> nativeint -> nativeintval mul : nativeint -> nativeint -> nativeintval div : nativeint -> nativeint -> nativeintDivision_by_zero if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for Pervasives.(/).val rem : nativeint -> nativeint -> nativeinty is not zero, the result
of Nativeint.rem x y satisfies the following properties:
Nativeint.zero <= Nativeint.rem x y < Nativeint.abs y and
x = Nativeint.add (Nativeint.mul (Nativeint.div x y) y) (Nativeint.rem x y).
If y = 0, Nativeint.rem x y raises Division_by_zero.val succ : nativeint -> nativeintNativeint.succ x is Nativeint.add x Nativeint.one.val pred : nativeint -> nativeintNativeint.pred x is Nativeint.sub x Nativeint.one.val abs : nativeint -> nativeintval size : int32
on a 32-bit platform and to 64 on a 64-bit platform.val max_int : nativeintval min_int : nativeintval logand : nativeint -> nativeint -> nativeintval logor : nativeint -> nativeint -> nativeintval logxor : nativeint -> nativeint -> nativeintval lognot : nativeint -> nativeintval shift_left : nativeint -> int -> nativeintNativeint.shift_left x y shifts x to the left by y bits.
The result is unspecified if y < 0 or y >= bitsize,
where bitsize is 32 on a 32-bit platform and
64 on a 64-bit platform.val shift_right : nativeint -> int -> nativeintNativeint.shift_right x y shifts x to the right by y bits.
This is an arithmetic shift: the sign bit of x is replicated
and inserted in the vacated bits.
The result is unspecified if y < 0 or y >= bitsize.val shift_right_logical : nativeint -> int -> nativeintNativeint.shift_right_logical x y shifts x to the right
by y bits.
This is a logical shift: zeroes are inserted in the vacated bits
regardless of the sign of x.
The result is unspecified if y < 0 or y >= bitsize.val (--) : t -> t -> t BatEnum.t
5n -- 10n is the enumeration 5n,6n,7n,8n,9n,10n.
10n -- 5n is the empty enumeration
val (---) : t -> t -> t BatEnum.t
5n -- 10n is the enumeration 5n,6n,7n,8n,9n,10n.
10n -- 5n is the enumeration 10n,9n,8n,7n,6n,5n.
val of_int : int -> nativeintint) to a native integer
(type nativeint).val to_int : nativeint -> intnativeint) to an
integer (type int). The high-order bit is lost during
the conversion.val of_float : float -> nativeintNativeint.min_int, Nativeint.max_int].val to_float : nativeint -> floatval of_int32 : int32 -> nativeintint32)
to a native integer.val to_int32 : nativeint -> int32int32). On 64-bit platforms,
the 64-bit native integer is taken modulo 232,
i.e. the top 32 bits are lost. On 32-bit platforms,
the conversion is exact.val of_int64 : int64 -> nativeintint64)
to a native integer. On 32-bit platforms, the top
32 bits are lost.val to_int64 : nativeint -> int64int64).val of_string : string -> nativeint0x, 0o or 0b
respectively.Failure if the given string is not
a valid representation of an integer, or if the integer represented
exceeds the range of integers representable in type nativeint.val to_string : nativeint -> stringval compare : t -> t -> intPervasives.compare. Along with the type t, this function compare
allows the module Nativeint to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolHashedType.val ord : t -> t -> BatOrd.order
val modulo : nativeint -> nativeint -> nativeint
val pow : nativeint -> nativeint -> nativeint
val min_num : nativeint
val max_num : nativeint
val (+) : t -> t -> t
val (-) : t -> t -> t
val ( * ) : t -> t -> t
val (/) : t -> t -> t
val ( ** ) : t -> t -> t
val operations : t BatNumber.numericmodule Infix:BatNumber.Infixwith type bat__infix_t = t
module Compare:BatNumber.Comparewith type bat__compare_t = t
val print : (t, 'a) BatIO.printer