package containers

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module CCNativeintSource

Nativeint

Helpers for processor-native integers

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

  • since 2.1
include module type of struct include Nativeint end
Sourceval zero : nativeint

The native integer 0.

Sourceval one : nativeint

The native integer 1.

Sourceval minus_one : nativeint

The native integer -1.

Sourceval neg : nativeint -> nativeint

Unary negation.

Sourceval add : nativeint -> nativeint -> nativeint

Addition.

Sourceval sub : nativeint -> nativeint -> nativeint

Subtraction.

Sourceval mul : nativeint -> nativeint -> nativeint

Multiplication.

Sourceval div : nativeint -> nativeint -> nativeint

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

Sourceval unsigned_div : nativeint -> nativeint -> nativeint

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

  • since 4.08.0
Sourceval rem : nativeint -> nativeint -> nativeint

Integer remainder. If y 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.

Sourceval unsigned_rem : nativeint -> nativeint -> nativeint

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

  • since 4.08.0
Sourceval succ : nativeint -> nativeint

Successor. Nativeint.succ x is Nativeint.add x Nativeint.one.

Sourceval pred : nativeint -> nativeint

Predecessor. Nativeint.pred x is Nativeint.sub x Nativeint.one.

Sourceval abs : nativeint -> nativeint

Return the absolute value of its argument.

Sourceval size : int

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

Sourceval max_int : nativeint

The greatest representable native integer, either 231 - 1 on a 32-bit platform, or 263 - 1 on a 64-bit platform.

Sourceval min_int : nativeint

The smallest representable native integer, either -231 on a 32-bit platform, or -263 on a 64-bit platform.

Sourceval logand : nativeint -> nativeint -> nativeint

Bitwise logical and.

Sourceval logor : nativeint -> nativeint -> nativeint

Bitwise logical or.

Sourceval logxor : nativeint -> nativeint -> nativeint

Bitwise logical exclusive or.

Sourceval lognot : nativeint -> nativeint

Bitwise logical negation.

Sourceval shift_left : nativeint -> int -> nativeint

Nativeint.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 : nativeint -> int -> nativeint

Nativeint.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 : nativeint -> int -> nativeint

Nativeint.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 unsigned_to_int : nativeint -> int option

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.

  • since 4.08.0
Sourceval of_int32 : int32 -> nativeint

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

Sourceval to_int32 : nativeint -> int32

Convert the given native integer to a 32-bit integer (type int32). 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.

Sourcetype t = nativeint

An alias for the type of native integers.

Sourceval compare : t -> t -> int

The comparison function for native integers, with the same specification as Stdlib.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.

Sourceval unsigned_compare : t -> t -> int

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

  • since 4.08.0
Sourceval min : t -> t -> t

Return the smaller of the two arguments.

  • since 4.13.0
Sourceval max : t -> t -> t

Return the greater of the two arguments.

  • since 4.13.0
Sourceval (+) : t -> t -> t

Addition.

Sourceval (-) : t -> t -> t

Subtraction.

Sourceval (~-) : t -> t

Unary negation.

Sourceval (*) : t -> t -> t

Multiplication.

Sourceval (/) : t -> t -> t

Integer division. Raise Division_by_zero if the second argument is zero. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/).

Sourceval (mod) : t -> t -> t

x mod y is the integer remainder. If y <> zero, the result of x mod y satisfies the following properties: zero <= x mod y < abs y and x = ((x / y) * y) + (x mod y). If y = 0, x mod y raises Division_by_zero.

Sourceval (land) : t -> t -> t

Bitwise logical and.

Sourceval (lor) : t -> t -> t

Bitwise logical or.

Sourceval (lxor) : t -> t -> t

Bitwise logical exclusive or.

Sourceval lnot : t -> t

Bitwise logical negation.

Sourceval (lsl) : t -> int -> t

x lsl 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 (lsr) : t -> int -> t

x lsr 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 (asr) : t -> int -> t

x asr 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.

Sourcemodule Infix : sig ... end
Sourceval equal : t -> t -> bool

The equal function for native integers. Like Pervasives.(=)xy).

Sourceval hash : t -> int

Like Pervasives.abs(to_intx).

Conversion

Sourceval to_int : t -> int

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

Sourceval of_int : int -> t

Alias to Nativeint.of_int. Convert the given integer (type int) to a native integer (type nativeint).

Sourceval to_float : t -> float

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

Sourceval of_float : float -> t

Alias to Nativeint.of_float. Convert the given floating-point number to a native integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [CCNativeint.min_int, CCNativeint.max_int].

Sourceval to_string : t -> string

Return the string representation of its argument, in decimal.

Sourceval of_string_exn : string -> t

Alias to Nativeint.of_string. Convert the given string to a 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*CCNativeint.max_int+1]. If the input exceeds CCNativeint.max_int it is converted to the signed integer CCInt64.min_int + input - CCNativeint.max_int - 1.

Raise Failure "Nativeint.of_string" 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 of_string : string -> t option

Safe version of of_string_exn. Like of_string_exn, but return None instead of raising.

Sourceval of_string_opt : string -> t option

Alias to of_string.

OCaml

Innovation. Community. Security.