jon.recoil.org

Module Stdlib_upstream_compatible.Nativeint_uSource

Unboxed processor-native integers. This file primarily duplicates functionality from the Nativeint module, but for nativeint#.

This module provides operations on the type nativeint# of unboxed signed 32-bit integers (on 32-bit platforms) or unboxed signed 64-bit integers (on 64-bit platforms). This integer type has exactly the same width as that of a pointer type in the C compiler. All arithmetic operations over nativeint# are wrapping, not truncating.

Sourcetype t = nativeint#

An alias for the type of unboxed native integers.

Sourceval to_nativeint : t -> nativeint @@ portable

Box a nativeint#

Sourceval of_nativeint : nativeint -> t @@ portable

Unbox a boxed nativeint

Sourceval neg : t -> t @@ portable

Unary negation.

Sourceval add : t -> t -> t @@ portable

Addition.

Sourceval sub : t -> t -> t @@ portable

Subtraction.

Sourceval mul : t -> t -> t @@ portable

Multiplication.

Sourceval div : t -> t -> t @@ portable

Integer division. This division rounds the real quotient of its arguments towards zero, as specified for Stdlib.(/).

Sourceval unsigned_div : t -> t -> t @@ portable

Same as div, except that arguments and result are interpreted as unsigned unboxed native integers.

Sourceval rem : t -> t -> t @@ portable

Integer remainder. If y is not zero, the result of Nativeint_u.rem x y satisfies the following properties: Nativeint_u.zero <= Nativeint_u.rem x y < Nativeint_u.abs y and x = Nativeint_u.add (Nativeint_u.mul (Nativeint_u.div x y) y) (Nativeint_u.rem x y). If y = 0, Nativeint_u.rem x y raises Division_by_zero.

Sourceval unsigned_rem : t -> t -> t @@ portable

Same as rem, except that arguments and result are interpreted as unsigned unboxed native integers.

Sourceval succ : t -> t @@ portable

Successor. Nativeint_u.succ x is Nativeint_u.add x Nativeint_u.one.

Sourceval pred : t -> t @@ portable

Predecessor. Nativeint_u.pred x is Nativeint_u.sub x Nativeint_u.one.

Sourceval abs : t -> t @@ portable

Return the absolute value of its argument.

Sourceval size : int @@ portable

The size in bits of an unboxed native integer. This is equal to 32 on a 32-bit platform and to 64 on a 64-bit platform.

Sourceval logand : t -> t -> t @@ portable

Bitwise logical and.

Sourceval logor : t -> t -> t @@ portable

Bitwise logical or.

Sourceval logxor : t -> t -> t @@ portable

Bitwise logical exclusive or.

Sourceval lognot : t -> t @@ portable

Bitwise logical negation.

Sourceval shift_left : t -> int -> t @@ portable

Nativeint_u.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.

Sourceval shift_right : t -> int -> t @@ portable

Nativeint_u.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.

Sourceval shift_right_logical : t -> int -> t @@ portable

Nativeint_u.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.

Sourceval of_int : int -> t @@ portable

Convert the given integer (type int) to an unboxed native integer (type nativeint#).

Sourceval to_int : t -> int @@ portable

Convert the given unboxed native integer (type nativeint#) to an integer (type int). The high-order bit is lost during the conversion.

Sourceval unsigned_to_int : t -> int option @@ portable

Same as to_int, but interprets the argument as an unsigned integer. Returns None if the unsigned value of the argument cannot fit into an int.

Sourceval of_float : float -> t @@ portable

Convert the given floating-point number to an unboxed native integer, discarding the fractional part (truncate towards 0). If the truncated floating-point number is outside the range [Nativeint_u.min_int, Nativeint_u.max_int], no exception is raised, and an unspecified, platform-dependent integer is returned.

Sourceval to_float : t -> float @@ portable

Convert the given unboxed native integer to a floating-point number.

Sourceval of_int32 : int32 -> t @@ portable

Convert the given 32-bit integer (type int32) to an unboxed native integer.

Sourceval to_int32 : t -> int32 @@ portable

Convert the given unboxed native integer to a 32-bit integer (type int32). On 64-bit platforms, the 64-bit unboxed native integer is taken modulo 232, i.e. the top 32 bits are lost. On 32-bit platforms, the conversion is exact.

Sourceval of_int32_u : int32# -> t @@ portable

Convert the given unboxed 32-bit integer (type int32) to an unboxed native integer.

Sourceval to_int32_u : t -> int32# @@ portable

Convert the given unboxed native integer to an unboxed 32-bit integer (type int32). On 64-bit platforms, the 64-bit unboxed native integer is taken modulo 232, i.e. the top 32 bits are lost. On 32-bit platforms, the conversion is exact.

Sourceval of_string : string -> t @@ portable

Convert the given string to an unboxed native integer. The string is read in decimal (by default, or if the string begins with 0u) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively.

The 0u prefix reads the input as an unsigned integer in the range [0, 2*Nativeint_u.max_int+1]. If the input exceeds Nativeint_u.max_int it is converted to the signed integer Int64.min_int + input - Nativeint_u.max_int - 1.

  • raises 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.

Sourceval to_string : t -> string @@ portable

Return the string representation of its argument, in decimal.

Sourceval compare : t -> t -> int @@ portable

The comparison function for unboxed native integers, with the same specification as Stdlib.compare.

Sourceval unsigned_compare : t -> t -> int @@ portable

Same as compare, except that arguments are interpreted as unsigned unboxed native integers.

Sourceval equal : t -> t -> bool @@ portable

The equal function for unboxed native ints.

Sourceval min : t -> t -> t @@ portable

Return the smaller of the two arguments.

Sourceval max : t -> t -> t @@ portable

Return the greater of the two arguments.